TabbycatDebate/tabbycat

View on GitHub
tabbycat/standings/diversity.py

Summary

Maintainability
D
2 days
Test Coverage
B
86%

Cyclomatic complexity is too high in function get_diversity_data_sets. (27)
Open

def get_diversity_data_sets(t, for_public):

    all_regions = regions_ordered(t)

    region_values = [r['id'] for r in all_regions]
Severity: Minor
Found in tabbycat/standings/diversity.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_diversity_data_sets has a Cognitive Complexity of 32 (exceeds 8 allowed). Consider refactoring.
Open

def get_diversity_data_sets(t, for_public):

    all_regions = regions_ordered(t)

    region_values = [r['id'] for r in all_regions]
Severity: Minor
Found in tabbycat/standings/diversity.py - About 4 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

Function compile_grouped_means_by_gender has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

def compile_grouped_means_by_gender(titles, queryset, gender_field, group_field, group_values):
Severity: Minor
Found in tabbycat/standings/diversity.py - About 35 mins to fix

    Function compile_grouped_gender_counts has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def compile_grouped_gender_counts(titles, queryset, gender_field, group_field, group_values):
    Severity: Minor
    Found in tabbycat/standings/diversity.py - About 35 mins to fix

      Function compile_grouped_counts has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def compile_grouped_counts(title, queryset, group_field, group_values, group_labels):
      Severity: Minor
      Found in tabbycat/standings/diversity.py - About 35 mins to fix

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

            if Adjudicator.objects.exclude(institution__region__isnull=True).exists():
                data_sets['adjudicators_region'].append(compile_grouped_counts(_("All"), adjudicators,
                        F('institution__region__id'), region_values, region_labels))
        
                if t.pref('public_breaking_adjs') is True or for_public is False:
        Severity: Major
        Found in tabbycat/standings/diversity.py and 1 other location - About 5 hrs to fix
        tabbycat/standings/diversity.py on lines 150..157

        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 115.

        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

            if Team.objects.exclude(institution__region__isnull=True).exists():
                data_sets['speakers_region'].append(compile_grouped_counts(_("All Speakers"), speakers,
                        F('team__institution__region__id'), region_values, region_labels))
        
                if t.pref('public_breaking_teams') is True or for_public is False:
        Severity: Major
        Found in tabbycat/standings/diversity.py and 1 other location - About 5 hrs to fix
        tabbycat/standings/diversity.py on lines 186..192

        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 115.

        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