tabbycat/results/result.py
File result.py
has 737 lines of code (exceeds 600 allowed). Consider refactoring. Open
Open
"""Debate result classes.
Debate result classes aggregate scoresheets to produce results for an entire
debate, and interact with the database with respect to models recording scores
given in the debate. They do not deal with metadata (like motions), only scores
DebateResultByAdjudicator
has 32 functions (exceeds 20 allowed). Consider refactoring. Open
Open
class DebateResultByAdjudicator(BaseDebateResult):
"""Base class for voting ballots.
Voting ballots have a DebateResult with one scoresheet per voting adjudicator.
This also provides access to the TeamScoreByAdj table.
BaseDebateResult
has 26 functions (exceeds 20 allowed). Consider refactoring. Open
Open
class BaseDebateResult:
"""Base class for debate result.
The base class implements management of debate teams, side allocations and
team score saving.
DebateResultWithScoresMixin
has 23 functions (exceeds 20 allowed). Consider refactoring. Open
Open
class DebateResultWithScoresMixin:
"""Mixin to provide methods to interact with SpeakerScore."""
speakerscore_fields = ['score', 'speaker', 'ghost', 'rank']
ConsensusDebateResult
has 23 functions (exceeds 20 allowed). Consider refactoring. Open
Open
class ConsensusDebateResult(BaseDebateResult):
"""Consensus debate result without scores"""
def init_blank_buffer(self):
super().init_blank_buffer()
Cyclomatic complexity is too high in function get_result_class. (14) Open
Open
def get_result_class(ballotsub, round=None, tournament=None):
if round is None:
round = ballotsub.round
if tournament is None:
tournament = round.tournament
- Read upRead up
- Exclude checks
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. |
Function get_result_class
has a Cognitive Complexity of 15 (exceeds 8 allowed). Consider refactoring. Open
Open
def get_result_class(ballotsub, round=None, tournament=None):
if round is None:
round = ballotsub.round
if tournament is None:
tournament = round.tournament
- Read upRead up
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"