avaframe/AvaFrame

View on GitHub
avaframe/com1DFA/com1DFATools.py

Summary

Maintainability
A
55 mins
Test Coverage
A
93%

Function compareSimCfgToDefaultCfgCom1DFA has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def compareSimCfgToDefaultCfgCom1DFA(simCfg):
    """Compares the given simulation configuration (as dict) to the default
    com1DFA configuration. Disregards values like avalancheDir that are expected to
    change. Returns True if it is the default + an identifier string: D = Default and
    C = Changed
Severity: Minor
Found in avaframe/com1DFA/com1DFATools.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 checkCfgInfoType has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Invalid

def checkCfgInfoType(cfgInfo):
    """check if cfgInfo is a configparser object, a file or a directory

    Parameters
    ------------
Severity: Minor
Found in avaframe/com1DFA/com1DFATools.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