fedspendingtransparency/usaspending-api

View on GitHub
usaspending_api/download/filestreaming/download_generation.py

Summary

Maintainability
D
2 days
Test Coverage
B
82%

File download_generation.py has 625 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import json
import logging
import multiprocessing
import os
from copy import deepcopy
Severity: Major
Found in usaspending_api/download/filestreaming/download_generation.py - About 1 day to fix

    Function get_download_sources has a Cognitive Complexity of 43 (exceeds 15 allowed). Consider refactoring.
    Open

    def get_download_sources(
        json_request: dict, download_job: DownloadJob = None, origination: Optional[str] = None
    ) -> List[DownloadSource]:
        download_sources = []
        for download_type in json_request["download_types"]:
    Severity: Minor
    Found in usaspending_api/download/filestreaming/download_generation.py - About 4 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 _select_columns has a Cognitive Complexity of 30 (exceeds 15 allowed). Consider refactoring.
    Open

    def _select_columns(sql: str) -> Tuple[str, List[str]]:
        in_quotes = False
        in_cte = False
        parens_depth = 0
        last_processed_index = 0
    Severity: Minor
    Found in usaspending_api/download/filestreaming/download_generation.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

    Cyclomatic complexity is too high in function generate_download. (22)
    Open

    def generate_download(download_job: DownloadJob, origination: Optional[str] = None):
        """Create data archive files from the download job object"""
    
        # Parse data from download_job
        json_request = json.loads(download_job.json_request)

    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 generate_download has a Cognitive Complexity of 24 (exceeds 15 allowed). Consider refactoring.
    Open

    def generate_download(download_job: DownloadJob, origination: Optional[str] = None):
        """Create data archive files from the download job object"""
    
        # Parse data from download_job
        json_request = json.loads(download_job.json_request)
    Severity: Minor
    Found in usaspending_api/download/filestreaming/download_generation.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

    Function parse_source has 9 arguments (exceeds 6 allowed). Consider refactoring.
    Open

    def parse_source(
    Severity: Major
    Found in usaspending_api/download/filestreaming/download_generation.py - About 50 mins to fix

      Function create_empty_data_file has 7 arguments (exceeds 6 allowed). Consider refactoring.
      Open

      def create_empty_data_file(
      Severity: Major
      Found in usaspending_api/download/filestreaming/download_generation.py - About 35 mins to fix

        Function build_data_file_name has a Cognitive Complexity of 17 (exceeds 15 allowed). Consider refactoring.
        Open

        def build_data_file_name(source, download_job, piid, assistance_id):
            if download_job and download_job.monthly_download:
                # For monthly archives, use the existing detailed zip filename for the data files
                # e.g. FY(All)-012_Contracts_Delta_20191108.zip -> FY(All)-012_Contracts_Delta_20191108_%.csv
                return strip_file_extension(download_job.file_name)
        Severity: Minor
        Found in usaspending_api/download/filestreaming/download_generation.py - About 35 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

        There are no issues that match your filters.

        Category
        Status