Sign upLogin

fedspendingtransparency/usaspending-api

View on GitHub
Star
usaspending_api/common/api_request_utils.py

Summary

Maintainability
F
3 days
Test Coverage
F
37%

Function validate_post_request has a Cognitive Complexity of 96 (exceeds 15 allowed). Consider refactoring.
Open

    def validate_post_request(self, request):
        if "filters" in request:
            for filt in request["filters"]:
                if "combine_method" in filt:
                    try:
Severity: Minor
Found in usaspending_api/common/api_request_utils.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

Function create_q_from_filter has a Cognitive Complexity of 50 (exceeds 15 allowed). Consider refactoring.
Open

    def create_q_from_filter(self, filt):
        if "combine_method" in filt:
            return self.create_q_from_filter_list(filt["filters"], filt["combine_method"])
        else:
            q_kwargs = {}
Severity: Minor
Found in usaspending_api/common/api_request_utils.py - About 6 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 api_request_utils.py has 346 lines of code (exceeds 250 allowed). Consider refactoring.
Open

from datetime import date, time, datetime
from django.contrib.postgres.search import SearchVector
from django.db.models import Q
from django.utils import timezone
from usaspending_api.common.exceptions import InvalidParameterException
Severity: Minor
Found in usaspending_api/common/api_request_utils.py - About 4 hrs to fix

    Cyclomatic complexity is too high in method validate_post_request. (30)
    Open

        def validate_post_request(self, request):
        if "filters" in request:
            for filt in request["filters"]:
                if "combine_method" in filt:
                    try:
    Severity: Minor
    Found in usaspending_api/common/api_request_utils.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

    Cyclomatic complexity is too high in method create_q_from_filter. (24)
    Open

        def create_q_from_filter(self, filt):
        if "combine_method" in filt:
            return self.create_q_from_filter_list(filt["filters"], filt["combine_method"])
        else:
            q_kwargs = {}
    Severity: Minor
    Found in usaspending_api/common/api_request_utils.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

    Avoid deeply nested control flow statements.
    Wontfix

                                if not isinstance(filt["value"], list):
                                raise InvalidParameterException("Invalid value, operation 'in' requires an array value")
                        if filt["operation"] == "range":
    Severity: Major
    Found in usaspending_api/common/api_request_utils.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Wontfix

                                  if not isinstance(filt["value"], list) or len(filt["value"]) != 2:
                                raise InvalidParameterException(
                                    "Invalid value, operation 'range' requires an array value of length 2"
                                )
                        if filt["operation"] == "range_intersect":
      Severity: Major
      Found in usaspending_api/common/api_request_utils.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Wontfix

                                    if not isinstance(filt["field"], list) or len(filt["field"]) != 2:
                                raise InvalidParameterException(
                                    "Invalid field, operation 'range_intersect' "
                                    "requires an array of length 2 for field"
                                )
        Severity: Major
        Found in usaspending_api/common/api_request_utils.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Wontfix

                                      if (
                                not isinstance(filt["value"], list) or len(filt["value"]) != 2
                            ) and "value_format" not in filt:
                                raise InvalidParameterException(
                                    "Invalid value, operation 'range_intersect' requires "
          Severity: Major
          Found in usaspending_api/common/api_request_utils.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Wontfix

                                        if not isinstance(filt["field"], list) and not self.is_string_field(filt["field"]):
                                raise InvalidParameterException(
                                    "Invalid field: '"
                                    + filt["field"]
                                    + "', operation 'search' requires a text-field for "
            Severity: Major
            Found in usaspending_api/common/api_request_utils.py - About 45 mins to fix

              Avoid too many return statements within this function.
              Open

                              return Q()
              Severity: Major
              Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return ~self.range_intersect(field, value)
                Severity: Major
                Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                  return ~Q(**q_kwargs)
                  Severity: Major
                  Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                        return q_obj
                    Severity: Major
                    Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                                          return ~fy.get_filter_object(field)
                      Severity: Minor
                      Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                        return self.range_intersect(field, value)
                        Severity: Major
                        Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                          return fy.get_filter_object(field)
                          Severity: Major
                          Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                        return Q(**q_kwargs)
                            Severity: Major
                            Found in usaspending_api/common/api_request_utils.py - About 30 mins to fix

                              There are no issues that match your filters.

                              Category
                              Status