Sign upLogin

SpamExperts/OrangeAssassin

View on GitHub
Star
oa/plugins/auto_learn_threshold.py

Summary

Maintainability
B
6 hrs
Test Coverage

Cyclomatic complexity is too high in method should_learn. (11)
Open

    def should_learn(self, msg):
        """Checks if the necessary conditions for learning are met"""
        body_points = self.get_local(msg, "body_points")
        header_points = self.get_local(msg, "header_points")
        learned_points = self.get_local(msg, "learned_points")
Severity: Minor
Found in oa/plugins/auto_learn_threshold.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

Cyclomatic complexity is too high in method prepare_learning_metadata. (10)
Open

    def prepare_learning_metadata(self, msg, tests):
        """Iterates through the tests and extracts necessary information
        * l:bayes_thinks_spam if the bayes plugin test BAYES_99 is present
        * l:bayes_thinks_ham if the bayes plugin test BAYES_00 is present
        * l:header_points total score for header rules
Severity: Minor
Found in oa/plugins/auto_learn_threshold.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 should_learn has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

    def should_learn(self, msg):
        """Checks if the necessary conditions for learning are met"""
        body_points = self.get_local(msg, "body_points")
        header_points = self.get_local(msg, "header_points")
        learned_points = self.get_local(msg, "learned_points")
Severity: Minor
Found in oa/plugins/auto_learn_threshold.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

Cyclomatic complexity is too high in class AutoLearnThreshold. (7)
Open

class AutoLearnThreshold(oa.plugins.base.BasePlugin):
    options = {
        "bayes_auto_learn_threshold_nonspam": ("float", 0.1),
        "bayes_auto_learn_threshold_spam": ("float", 12.0),
        "bayes_auto_learn_on_error": ("bool", False)
Severity: Minor
Found in oa/plugins/auto_learn_threshold.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 prepare_learning_metadata has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    def prepare_learning_metadata(self, msg, tests):
        """Iterates through the tests and extracts necessary information
        * l:bayes_thinks_spam if the bayes plugin test BAYES_99 is present
        * l:bayes_thinks_ham if the bayes plugin test BAYES_00 is present
        * l:header_points total score for header rules
Severity: Minor
Found in oa/plugins/auto_learn_threshold.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 too many return statements within this function.
Open

                return False
Severity: Major
Found in oa/plugins/auto_learn_threshold.py - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

            return True
    Severity: Major
    Found in oa/plugins/auto_learn_threshold.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                      return False
      Severity: Major
      Found in oa/plugins/auto_learn_threshold.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return False
        Severity: Major
        Found in oa/plugins/auto_learn_threshold.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                      return False
          Severity: Major
          Found in oa/plugins/auto_learn_threshold.py - About 30 mins to fix

            Function valid_tests has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                def valid_tests(self, tests):
        """Yields valid tests for autolearning.
         Exclude all tests flagged with noautolearn, userconf or have a 0 score
        """
        for name, rule in tests.items():
            Severity: Minor
            Found in oa/plugins/auto_learn_threshold.py - About 25 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

            Line too long (80 > 79 characters)
            Open

                                                msg.score, self.ctxt.conf['required_score'])
            Severity: Minor
            Found in oa/plugins/auto_learn_threshold.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

            Line too long (80 > 79 characters)
            Open

                                                msg.score, self.ctxt.conf['required_score'])
            Severity: Minor
            Found in oa/plugins/auto_learn_threshold.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

            Line too long (81 > 79 characters)
            Open

                        self.ctxt.log.debug("not learning, bayes agrees with classification")
            Severity: Minor
            Found in oa/plugins/auto_learn_threshold.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

            There are no issues that match your filters.

            Category
            Status