failmap/admin

View on GitHub
websecmap/api/apis/zorgkaart.py

Summary

Maintainability
B
5 hrs
Test Coverage

File zorgkaart.py has 270 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/python3
# Note: run make fix and make check before committing code.

"""
Scrapes organisations from Zorgkaart Nederland API
Severity: Minor
Found in websecmap/api/apis/zorgkaart.py - About 2 hrs to fix

    Cyclomatic complexity is too high in function organization_and_url_import. (7)
    Open

    @transaction.atomic
    def organization_and_url_import(flat_organizations: List[Dict[str, Any]]):
    
        if not config.GOOGLE_MAPS_API_KEY:
            log.warning("Warning: the google maps api key is not set, fallback geocoding of addresses will not happen.")
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.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 function validate_flat_organization. (7)
    Open

    def validate_flat_organization(flat_organization: Dict):
        layer = OrganizationType.objects.all().filter(name=flat_organization.get("layer", "")).first()
        if not layer:
            raise ValueError(
                f"Layer {flat_organization.get('layer', '')} " f"not defined. Is this layer defined in this installation?"
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.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

    Function organization_and_url_import has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    def organization_and_url_import(flat_organizations: List[Dict[str, Any]]):
    
        if not config.GOOGLE_MAPS_API_KEY:
            log.warning("Warning: the google maps api key is not set, fallback geocoding of addresses will not happen.")
    
    
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.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 add_urls_to_organizations has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    def add_urls_to_organizations(organizations: List[Organization], urls: List[str]) -> None:
        for organization in organizations:
            for url in urls:
                # make the API easier to use:
                # will parse extensive urls: https://www.apple.com:80/yolo/swag
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.py - About 55 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

    Function do_request has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def do_request(url, params={}, previous_items=[]):
        """Internal function, performs API requests and merges paginated data"""
        # default to max limit of API
        if "limit" not in params.keys():
            params["limit"] = 10000
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.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

    Function validate_flat_organization has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    def validate_flat_organization(flat_organization: Dict):
        layer = OrganizationType.objects.all().filter(name=flat_organization.get("layer", "")).first()
        if not layer:
            raise ValueError(
                f"Layer {flat_organization.get('layer', '')} " f"not defined. Is this layer defined in this installation?"
    Severity: Minor
    Found in websecmap/api/apis/zorgkaart.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

    There are no issues that match your filters.

    Category
    Status