TabbycatDebate/tabbycat

View on GitHub
tabbycat/adjallocation/allocators/anneal.py

Summary

Maintainability
B
4 hrs
Test Coverage

Function anneal has a Cognitive Complexity of 16 (exceeds 8 allowed). Consider refactoring.
Open

    def anneal(self, steps, min_temp, max_temp, state):

        self.energy = self.calc_energy(state)
        logger.info("start energy %.2f", self.energy)
        self.save_best()
Severity: Minor
Found in tabbycat/adjallocation/allocators/anneal.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

Avoid deeply nested control flow statements.
Open

                        if self.energy == 0:
                            break

Severity: Major
Found in tabbycat/adjallocation/allocators/anneal.py - About 45 mins to fix

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

        def score_adj_team_conflict(self, debate, panel):
            score = 0
    
            for adj in panel:
                for team in debate.teams:
    Severity: Minor
    Found in tabbycat/adjallocation/allocators/anneal.py and 1 other location - About 50 mins to fix
    tabbycat/adjallocation/allocators/anneal.py on lines 181..188

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

    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

        def score_adj_team_history(self, debate, panel):
            score = 0
    
            for adj in panel:
                for team in debate.teams:
    Severity: Minor
    Found in tabbycat/adjallocation/allocators/anneal.py and 1 other location - About 50 mins to fix
    tabbycat/adjallocation/allocators/anneal.py on lines 173..179

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

    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