TabbycatDebate/tabbycat

View on GitHub
tabbycat/draw/views.py

Summary

Maintainability
D
2 days
Test Coverage
F
52%

Cyclomatic complexity is too high in method get_standard_table. (14)
Open

    def get_standard_table(self):
        r = self.round

        if r.is_break_round:
            sort_key = "room-rank"
Severity: Minor
Found in tabbycat/draw/views.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 get_standard_table has a Cognitive Complexity of 20 (exceeds 8 allowed). Consider refactoring.
Open

    def get_standard_table(self):
        r = self.round

        if r.is_break_round:
            sort_key = "room-rank"
Severity: Minor
Found in tabbycat/draw/views.py - About 2 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

File views.py has 605 lines of code (exceeds 600 allowed). Consider refactoring.
Open

import datetime
import logging
import unicodedata
from itertools import product

Severity: Major
Found in tabbycat/draw/views.py - About 2 hrs to fix

    Function get_position_cost_function_str has a Cognitive Complexity of 10 (exceeds 8 allowed). Consider refactoring.
    Open

        def get_position_cost_function_str(self):
            cost_func = self.tournament.pref('bp_position_cost')
            if cost_func == 'entropy':
                renyi_order = self.tournament.pref('bp_renyi_order')
                cost_func_str = _("Rényi entropy of order %(order)s" % {'order': renyi_order})
    Severity: Minor
    Found in tabbycat/draw/views.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

    Avoid too many return statements within this function.
    Open

            return super().post(request, *args, **kwargs)
    Severity: Major
    Found in tabbycat/draw/views.py - About 30 mins to fix

      TODO found
      Open

              # TODO: account for shared teams
      Severity: Minor
      Found in tabbycat/draw/views.py by fixme

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

      class DrawReleaseView(DrawStatusEdit):
          action_log_type = ActionLogEntry.ACTION_TYPE_DRAW_RELEASE
          round_redirect_pattern_name = 'draw-display'
      
          def post(self, request, *args, **kwargs):
      Severity: Major
      Found in tabbycat/draw/views.py and 1 other location - About 4 hrs to fix
      tabbycat/draw/views.py on lines 750..762

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 102.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

      class DrawUnreleaseView(DrawStatusEdit):
          action_log_type = ActionLogEntry.ACTION_TYPE_DRAW_UNRELEASE
          round_redirect_pattern_name = 'draw-display'
      
          def post(self, request, *args, **kwargs):
      Severity: Major
      Found in tabbycat/draw/views.py and 1 other location - About 4 hrs to fix
      tabbycat/draw/views.py on lines 734..747

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 102.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          def get_extra(self):
              extra = super().get_extra()
              extra['url'] = self.request.build_absolute_uri(
                  reverse_tournament('privateurls-person-index', self.tournament, kwargs={'url_key': '0'}))[:-2]
              return extra
      Severity: Major
      Found in tabbycat/draw/views.py and 1 other location - About 1 hr to fix
      tabbycat/privateurls/views.py on lines 152..155

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 60.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status