Olllom/pyworkdir

View on GitHub
pyworkdir/main.py

Summary

Maintainability
A
0 mins
Test Coverage

Function show has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Invalid

def show(workdir, variables=False, functions=False, sources=False, environment=False, commands=False, out=sys.stdout):
    """Print the working directory in yaml format."""
    dictionary = {"name": str(workdir)}
    if variables:
        variables = dict()
Severity: Minor
Found in pyworkdir/main.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 show has 7 arguments (exceeds 4 allowed). Consider refactoring.
Invalid

def show(workdir, variables=False, functions=False, sources=False, environment=False, commands=False, out=sys.stdout):
Severity: Major
Found in pyworkdir/main.py - About 50 mins to fix

    There are no issues that match your filters.

    Category
    Status