Sign upLogin

treyhunner/django-simple-history

View on GitHub
Star
simple_history/utils.py

Summary

Maintainability
A
2 hrs
Test Coverage

Cyclomatic complexity is too high in function bulk_create_with_history. (12)
Open

def bulk_create_with_history(
    objs,
    model,
    batch_size=None,
    ignore_conflicts=False,
Severity: Minor
Found in simple_history/utils.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

Cyclomatic complexity is too high in function update_change_reason. (7)
Open

def update_change_reason(instance, reason):
    attrs = {}
    model = type(instance)
    manager = instance if instance.pk is not None else model
    history = get_history_manager_for_model(manager)
Severity: Minor
Found in simple_history/utils.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 bulk_update_with_history has 9 arguments (exceeds 7 allowed). Consider refactoring.
Open

def bulk_update_with_history(
Severity: Major
Found in simple_history/utils.py - About 45 mins to fix

    Function bulk_create_with_history has a Cognitive Complexity of 10 (exceeds 7 allowed). Consider refactoring.
    Open

    def bulk_create_with_history(
    objs,
    model,
    batch_size=None,
    ignore_conflicts=False,
    Severity: Minor
    Found in simple_history/utils.py - About 45 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 update_change_reason has a Cognitive Complexity of 10 (exceeds 7 allowed). Consider refactoring.
    Open

    def update_change_reason(instance, reason):
    attrs = {}
    model = type(instance)
    manager = instance if instance.pk is not None else model
    history = get_history_manager_for_model(manager)
    Severity: Minor
    Found in simple_history/utils.py - About 45 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 bulk_create_with_history has 8 arguments (exceeds 7 allowed). Consider refactoring.
    Open

    def bulk_create_with_history(
    Severity: Major
    Found in simple_history/utils.py - About 35 mins to fix

      Function "bulk_update_with_history" has 9 parameters, which is greater than the 7 authorized.
      Open

          objs,
    model,
    fields,
    batch_size=None,
    default_user=None,
      Severity: Major
      Found in simple_history/utils.py by sonar-python

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      def do_something(param1, param2, param3, param4, param5):
    ...

      Compliant Solution

      def do_something(param1, param2, param3, param4):
    ...

      Function "bulk_create_with_history" has 8 parameters, which is greater than the 7 authorized.
      Open

          objs,
    model,
    batch_size=None,
    ignore_conflicts=False,
    default_user=None,
      Severity: Major
      Found in simple_history/utils.py by sonar-python

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      def do_something(param1, param2, param3, param4, param5):
    ...

      Compliant Solution

      def do_something(param1, param2, param3, param4):
    ...

      There are no issues that match your filters.

      Category
      Status