andreoliwa/nitpick

View on GitHub

Showing 38 of 41 total issues

Cyclomatic complexity is too high in method enforce_present_absent. (11)
Open

    def enforce_present_absent(self, *partial_names: str) -> Iterator[Fuss]:
        """Enforce files that should be present or absent.

        :param partial_names: Names of the files to enforce configs for.
        :return: Fuss generator.
Severity: Minor
Found in src/nitpick/core.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 enforce_present_absent has a Cognitive Complexity of 18 (exceeds 10 allowed). Consider refactoring.
Open

    def enforce_present_absent(self, *partial_names: str) -> Iterator[Fuss]:
        """Enforce files that should be present or absent.

        :param partial_names: Names of the files to enforce configs for.
        :return: Fuss generator.
Severity: Minor
Found in src/nitpick/core.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 find_root has a Cognitive Complexity of 14 (exceeds 10 allowed). Consider refactoring.
Open

def find_root(current_dir: Optional[PathOrStr] = None) -> Path:
    """Find the root dir of the Python project (the one that has one of the ``ROOT_FILES``).

    Start from the current working dir.
    """
Severity: Minor
Found in src/nitpick/project.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 __init__ has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __init__(
Severity: Minor
Found in src/nitpick/formats.py - About 35 mins to fix

Function flatten has a Cognitive Complexity of 11 (exceeds 10 allowed). Consider refactoring.
Open

def flatten(dict_, parent_key="", separator=".", current_lists=None) -> JsonDict:
    """Flatten a nested dict.

    Use :py:meth:`unflatten()` to revert.

Severity: Minor
Found in src/nitpick/generic.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

Unexpected tabs found.
Open

    @fd --changed-before $(RERUN_AFTER) auto .cache/make --exec-batch rm '{}' ;

Unexpected tabs found.
Open

    -rm .cache/make/auto-pre-commit

Unexpected tabs found.
Open

    pre-commit install --hook-type commit-msg

Unexpected tabs found.
Open

    $(MAKE)

Unexpected tabs found.
Open

    @# Remove files named auto* if they are older than 1 hour, so the targets will be rebuilt

Unexpected tabs found.
Open

    @echo '  pytest      to run tests'

Unexpected tabs found.
Open

    pytest

Unexpected tabs found.
Open

    pre-commit install

Unexpected tabs found.
Open

    touch .cache/make/auto-pre-commit

Unexpected tabs found.
Open

    @echo '  poetry      to update dependencies'

Unexpected tabs found.
Open

    @echo '  sphinx      to build docs'

Unexpected tabs found.
Open

    -rm .cache/make/sphinx

Unexpected tabs found.
Open

    touch .cache/make/sphinx

Unexpected tabs found.
Open

    touch .cache/make/auto-poetry

Unexpected tabs found.
Open

    $(MAKE)
Severity
Category
Status
Source
Language