fedspendingtransparency/usaspending-api

View on GitHub
usaspending_api/broker/helpers/get_business_categories.py

Summary

Maintainability
D
1 day
Test Coverage
F
30%

Function get_business_categories has a Cognitive Complexity of 181 (exceeds 15 allowed). Consider refactoring.
Wontfix

def get_business_categories(row, data_type):
    business_category_set = set()

    if data_type == "fabs":
        # BUSINESS (FOR-PROFIT)
Severity: Minor
Found in usaspending_api/broker/helpers/get_business_categories.py - About 3 days 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

Cyclomatic complexity is too high in function get_business_categories. (122)
Wontfix

def get_business_categories(row, data_type):
    business_category_set = set()

    if data_type == "fabs":
        # BUSINESS (FOR-PROFIT)

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

Cyclomatic complexity is too high in function get_business_categories_fpds. (104)
Open

def get_business_categories_fpds(row):
    # This function is supposed to be invoked as a Spark UDF with a named_struct containing the necessary
    # fields passed to it.

    def row_get(row, col_name):

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

Function get_business_categories_fpds has a Cognitive Complexity of 83 (exceeds 15 allowed). Consider refactoring.
Open

def get_business_categories_fpds(row):
    # This function is supposed to be invoked as a Spark UDF with a named_struct containing the necessary
    # fields passed to it.

    def row_get(row, col_name):
Severity: Minor
Found in usaspending_api/broker/helpers/get_business_categories.py - About 1 day 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 get_business_categories.py has 628 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

from usaspending_api.broker.helpers.build_business_categories_boolean_dict import (
    build_business_categories_boolean_dict,
    fpds_boolean_columns,
)

Severity: Major
Found in usaspending_api/broker/helpers/get_business_categories.py - About 1 day to fix

    Function get_business_categories_fpds has 60 lines of code (exceeds 45 allowed). Consider refactoring.
    Open

    def get_business_categories_fpds(row):
        # This function is supposed to be invoked as a Spark UDF with a named_struct containing the necessary
        # fields passed to it.
    
        def row_get(row, col_name):
    Severity: Major
    Found in usaspending_api/broker/helpers/get_business_categories.py - About 1 hr to fix

      Function get_business_categories_fabs has a Cognitive Complexity of 16 (exceeds 15 allowed). Consider refactoring.
      Open

      def get_business_categories_fabs(business_types):
          # This function is supposed to be invoked as a Spark UDF with the business_types field passed to it.
      
          business_category_set = set()
      
      
      Severity: Minor
      Found in usaspending_api/broker/helpers/get_business_categories.py - About 25 mins 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

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          if business_category_set & {
              "8a_program_participant",
              "ability_one_program",
              "dot_certified_disadvantaged_business_enterprise",
              "emerging_small_business",
      Severity: Major
      Found in usaspending_api/broker/helpers/get_business_categories.py and 1 other location - About 1 hr to fix
      usaspending_api/broker/helpers/get_business_categories.py on lines 282..304

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 40.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

              if business_category_set & {
                  "8a_program_participant",
                  "ability_one_program",
                  "dot_certified_disadvantaged_business_enterprise",
                  "emerging_small_business",
      Severity: Major
      Found in usaspending_api/broker/helpers/get_business_categories.py and 1 other location - About 1 hr to fix
      usaspending_api/broker/helpers/get_business_categories.py on lines 714..736

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 40.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status