Sign upLogin

fedspendingtransparency/usaspending-api

View on GitHub
Star
usaspending_api/awards/v2/filters/sub_award.py

Summary

Maintainability
D
2 days
Test Coverage
B
87%

Function subaward_filter has a Cognitive Complexity of 132 (exceeds 15 allowed). Consider refactoring.
Open

def subaward_filter(filters, for_downloads=False):
    queryset = SubawardSearch.objects.all()

    recipient_scope_q = Q(sub_legal_entity_country_code="USA") | Q(sub_legal_entity_country_name="UNITED STATES")
    pop_scope_q = Q(sub_place_of_perform_country_co="USA") | Q(sub_place_of_perform_country_name="UNITED STATES")
Severity: Minor
Found in usaspending_api/awards/v2/filters/sub_award.py - About 2 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 subaward_filter. (59)
Open

def subaward_filter(filters, for_downloads=False):
    queryset = SubawardSearch.objects.all()

    recipient_scope_q = Q(sub_legal_entity_country_code="USA") | Q(sub_legal_entity_country_name="UNITED STATES")
    pop_scope_q = Q(sub_place_of_perform_country_co="USA") | Q(sub_place_of_perform_country_name="UNITED STATES")
Severity: Minor
Found in usaspending_api/awards/v2/filters/sub_award.py by radon

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

File sub_award.py has 275 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

import itertools
import logging

from django.db.models import Exists, OuterRef, Q
Severity: Minor
Found in usaspending_api/awards/v2/filters/sub_award.py - About 2 hrs to fix

    Function geocode_filter_subaward_locations has a Cognitive Complexity of 29 (exceeds 15 allowed). Consider refactoring.
    Wontfix

    def geocode_filter_subaward_locations(scope: str, values: list) -> Q:
    """
    Function filter querysets for location data in subawards
    scope- place of performance or recipient location mappings
    values- array of location requests
    Severity: Minor
    Found in usaspending_api/awards/v2/filters/sub_award.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

    Avoid deeply nested control flow statements.
    Wontfix

                            if "toptier_name" in v:
                            funding_subtier |= Q(funding_subtier_agency_name=name) & Q(
                                funding_toptier_agency_name=v["toptier_name"]
                            )
                        else:
    Severity: Major
    Found in usaspending_api/awards/v2/filters/sub_award.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Wontfix

                              if "toptier_name" in v:
                            awarding_subtier |= Q(awarding_subtier_agency_name=name) & Q(
                                awarding_toptier_agency_name=v["toptier_name"]
                            )
                        else:
      Severity: Major
      Found in usaspending_api/awards/v2/filters/sub_award.py - About 45 mins to fix

        There are no issues that match your filters.

        Category
        Status