Sign upLogin

ComplianceAsCode/content

View on GitHub
Star
ssg/rule_yaml.py
2c71e1e4

Summary

Maintainability
C
1 day
Test Coverage
F
12%

Function sort_section_keys has a Cognitive Complexity of 27 (exceeds 7 allowed). Consider refactoring.
Open

def sort_section_keys(file_path, file_contents, sections, sort_func=None):
    """
    Sort subkeys in a YAML file's section.

    Args:
Severity: Minor
Found in ssg/rule_yaml.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

Function has_duplicated_subkeys has a Cognitive Complexity of 23 (exceeds 7 allowed). Consider refactoring.
Open

def has_duplicated_subkeys(file_path, file_contents, sections):
    """
    Checks whether a section has duplicated keys in a YAML file.

    Note that these duplicated keys are silently ignored by the YAML parser used.
Severity: Minor
Found in ssg/rule_yaml.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 sort_section_keys. (16)
Open

def sort_section_keys(file_path, file_contents, sections, sort_func=None):
    """
    Sort subkeys in a YAML file's section.

    Args:
Severity: Minor
Found in ssg/rule_yaml.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 find_section_lines has a Cognitive Complexity of 16 (exceeds 7 allowed). Consider refactoring.
Open

def find_section_lines(file_contents, sec):
    """
    Parses the given file_contents as YAML to find the section with the given identifier.

    Note that this does not call into the yaml library and thus correctly handles Jinja macros at
Severity: Minor
Found in ssg/rule_yaml.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

Avoid deeply nested control flow statements.
Open

                    if subkey_counts[our_key] > 1:
                        print("Duplicated key " + our_key + " in " + section + " of " + file_path)
                        return True
Severity: Major
Found in ssg/rule_yaml.py - About 45 mins to fix

    Avoid deeply nested control flow statements.
    Open

                        if nonempty_line and file_contents[line_num][0] != ' ':
                        break
                    line_num += 1
    Severity: Major
    Found in ssg/rule_yaml.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if our_line:
                        # Not supposed to be possible to have multiple keys
                        # matching the same value in this file. We should've
                        # already fixed this with fix-rules.py's duplicate_subkeys.
                        msg = "File {0} has duplicated key {1}: {2} vs {3}"
      Severity: Major
      Found in ssg/rule_yaml.py - About 45 mins to fix

        Refactor this function to reduce its Cognitive Complexity from 28 to the 15 allowed.
        Open

        def sort_section_keys(file_path, file_contents, sections, sort_func=None):
        Severity: Critical
        Found in ssg/rule_yaml.py by sonar-python

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Refactor this function to reduce its Cognitive Complexity from 16 to the 15 allowed.
        Open

        def find_section_lines(file_contents, sec):
        Severity: Critical
        Found in ssg/rule_yaml.py by sonar-python

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Refactor this function to reduce its Cognitive Complexity from 23 to the 15 allowed.
        Open

        def has_duplicated_subkeys(file_path, file_contents, sections):
        Severity: Critical
        Found in ssg/rule_yaml.py by sonar-python

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        Merge this if statement with the enclosing one.
        Open

                    if file_contents[line_num][0:sec_len] == sec_id:
        Severity: Major
        Found in ssg/rule_yaml.py by sonar-python

        Merging collapsible if statements increases the code's readability.

        Noncompliant Code Example

        if condition1:
    if condition2:
        # ...

        Compliant Solution

        if condition1 and condition2:
    # ...

        Line too long (101 > 99 characters)
        Open

                list of str: A new list of strings with the key-value pair added and a blank line afterwards.
        Severity: Minor
        Found in ssg/rule_yaml.py by pep8

        Limit all lines to a maximum of 79 characters.

        There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

        Line too long (100 > 99 characters)
        Open

                sections (str or list of str): The section or list of sections to check for duplicated keys.
        Severity: Minor
        Found in ssg/rule_yaml.py by pep8

        Limit all lines to a maximum of 79 characters.

        There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

        There are no issues that match your filters.

        Category
        Status