KarrLab/wc_utils

View on GitHub
wc_utils/util/decorate_default_data_struct.py

Summary

Maintainability
A
1 hr
Test Coverage
C
77%

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

def default_mutable_params(mutable_args):
    """A function or method decorator that handles mutable optional parameters.

    Optional parameters with mutable default values like d and l in "def f( d={}, l=[])" have
    the awkward behavior that a global mutable data strcture is created when the function (or
Severity: Minor
Found in wc_utils/util/decorate_default_data_struct.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 none_to_empty has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

def none_to_empty( param, value ):
    ''' If value is None, return an empty data structure whose type is indicated by param

    Args:
        param (:obj:`str`): a variable name whose prefix or suffix indicates its data type
Severity: Minor
Found in wc_utils/util/decorate_default_data_struct.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