18F/State-TalentMAP-API

View on GitHub
talentmap_api/common/xml_helpers.py

Summary

Maintainability
C
1 day
Test Coverage

Function create_models_from_csv has a Cognitive Complexity of 26 (exceeds 7 allowed). Consider refactoring.
Open

    def create_models_from_csv(self, csv_filepath):
        '''
        Loads data from an CSV file into a model, using a defined mapping of fields
        to CSV column titles.

Severity: Minor
Found in talentmap_api/common/xml_helpers.py - About 3 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function default_xml_action has a Cognitive Complexity of 23 (exceeds 7 allowed). Consider refactoring.
Open

    def default_xml_action(self, tag, new_instances, updated_instances):
        '''
        Returns the instance and a boolean indicating if the instance was "updated" or not
        '''
        instance = self.model()
Severity: Minor
Found in talentmap_api/common/xml_helpers.py - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

File xml_helpers.py has 252 lines of code (exceeds 250 allowed). Consider refactoring.
Open

'''
This file contains helpers for loading data into the database from XML files
'''

import defusedxml.lxml as ET
Severity: Minor
Found in talentmap_api/common/xml_helpers.py - About 2 hrs to fix

    Function create_models_from_xml has a Cognitive Complexity of 14 (exceeds 7 allowed). Consider refactoring.
    Open

        def create_models_from_xml(self, xml, raw_string=False):
            '''
            Loads data from an XML file into a model, using a defined mapping of fields
            to XML tags.
    
    
    Severity: Minor
    Found in talentmap_api/common/xml_helpers.py - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid deeply nested control flow statements.
    Open

                            if data and len(data.strip()) > 0:
                                setattr(instance, self.tag_map[key], data)
                        else:
    Severity: Major
    Found in talentmap_api/common/xml_helpers.py - About 45 mins to fix

      Function __init__ has 7 arguments (exceeds 5 allowed). Consider refactoring.
      Open

          def __init__(self, model, instance_tag, tag_map, collision_behavior=None, collision_field=None, override_loading_method=None, logger=None):
      Severity: Major
      Found in talentmap_api/common/xml_helpers.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if self.collision_behavior == 'delete':
                                    collisions.delete()
                                    new_instances.append(instance)
                                elif self.collision_behavior == 'update':
                                    # Update our collided instance
        Severity: Major
        Found in talentmap_api/common/xml_helpers.py - About 45 mins to fix

          There are no issues that match your filters.

          Category
          Status