fedspendingtransparency/usaspending-api

View on GitHub
usaspending_api/common/sqs/sqs_work_dispatcher.py

Summary

Maintainability
D
2 days
Test Coverage
D
69%

File sqs_work_dispatcher.py has 825 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import logging
import inspect
import json
import os

Severity: Major
Found in usaspending_api/common/sqs/sqs_work_dispatcher.py - About 1 day to fix

    Function _handle_exit_signal has a Cognitive Complexity of 35 (exceeds 15 allowed). Consider refactoring.
    Open

        def _handle_exit_signal(self, signum, frame, parent_dispatcher_signaled=True, is_retry=False):
            """Attempt to gracefully handle the exiting of the job as a result of receiving an exit signal.
    
            NOTE: This handler is only expected to be run from the parent dispatcher process. It is an error
            condition if it is invoked from the child worker process. Signals received in the child worker
    Severity: Minor
    Found in usaspending_api/common/sqs/sqs_work_dispatcher.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

    Cyclomatic complexity is too high in method _handle_exit_signal. (22)
    Open

        def _handle_exit_signal(self, signum, frame, parent_dispatcher_signaled=True, is_retry=False):
            """Attempt to gracefully handle the exiting of the job as a result of receiving an exit signal.
    
            NOTE: This handler is only expected to be run from the parent dispatcher process. It is an error
            condition if it is invoked from the child worker process. Signals received in the child worker

    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 __init__ has 7 arguments (exceeds 6 allowed). Consider refactoring.
    Open

        def __init__(
    Severity: Major
    Found in usaspending_api/common/sqs/sqs_work_dispatcher.py - About 35 mins to fix

      There are no issues that match your filters.

      Category
      Status