TabbycatDebate/tabbycat

View on GitHub
tabbycat/results/dbutils.py

Summary

Maintainability
C
1 day
Test Coverage

Function add_result has a Cognitive Complexity of 41 (exceeds 8 allowed). Consider refactoring.
Open

def add_result(debate, submitter_type, user, discarded=False, confirmed=False, reply_random=False):
    """Adds a ballot set to a debate.

    ``debate`` is the Debate to which the ballot set should be added.
    ``submitter_type`` is a valid value of BallotSubmission.submitter_type.
Severity: Minor
Found in tabbycat/results/dbutils.py - About 5 hrs 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

Cyclomatic complexity is too high in function add_result. (30)
Open

def add_result(debate, submitter_type, user, discarded=False, confirmed=False, reply_random=False):
    """Adds a ballot set to a debate.

    ``debate`` is the Debate to which the ballot set should be added.
    ``submitter_type`` is a valid value of BallotSubmission.submitter_type.
Severity: Minor
Found in tabbycat/results/dbutils.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 fill_scoresheet_randomly has a Cognitive Complexity of 16 (exceeds 8 allowed). Consider refactoring.
Open

def fill_scoresheet_randomly(scoresheet, tournament, nattempts=1000):
    """Fills a scoresheet randomly. Operates in-place. Bails if it can't
    generate a valid scoresheet within 1000 attempts."""
    for attempt in range(nattempts):

Severity: Minor
Found in tabbycat/results/dbutils.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 add_result has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

def add_result(debate, submitter_type, user, discarded=False, confirmed=False, reply_random=False):
Severity: Minor
Found in tabbycat/results/dbutils.py - About 45 mins to fix

    There are no issues that match your filters.

    Category
    Status