Sign upLogin

SpamExperts/OrangeAssassin

View on GitHub
Star
oa/rules/header.py

Summary

Maintainability
D
2 days
Test Coverage

Function get_rule has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

    def get_rule(cls, name, data):
        kwargs = cls.get_rule_kwargs(data)
        value = data["value"]

        match_op = None
Severity: Minor
Found in oa/rules/header.py - About 3 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 method get_rule. (12)
Open

    @classmethod
    def get_rule(cls, name, data):
        kwargs = cls.get_rule_kwargs(data)
        value = data["value"]
Severity: Minor
Found in oa/rules/header.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 class HeaderRule. (7)
Open

class HeaderRule(oa.rules.base.BaseRule):
    """Abstract base class for all header rules."""

    rule_type = 'header'
Severity: Minor
Found in oa/rules/header.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 __init__ has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __init__(self, name, pattern=None, header_name=None, score=None,
Severity: Major
Found in oa/rules/header.py - About 50 mins to fix

    Function __init__ has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def __init__(self, name, pattern=None, header_name=None, score=None,
    Severity: Major
    Found in oa/rules/header.py - About 50 mins to fix

      Function __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def __init__(self, name, pattern, score=None, desc=None, priority=0,
      Severity: Minor
      Found in oa/rules/header.py - About 45 mins to fix

        Function __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            def __init__(self, name, header_name, score=None, desc=None, priority=0,
        Severity: Minor
        Found in oa/rules/header.py - About 45 mins to fix

          Function __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              def __init__(self, name, pattern, score=None, desc=None, priority=0,
          Severity: Minor
          Found in oa/rules/header.py - About 45 mins to fix

            Function get_rule has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                def get_rule(cls, name, data):
        kwargs = cls.get_rule_kwargs(data)
        value = data["value"].strip()

        if "=~" in value:
            Severity: Minor
            Found in oa/rules/header.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

            Function match has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                def match(self, msg):
        for header_name in self._headers or ():
            for value in msg.get_decoded_header(header_name):
                if self._pattern.match(value):
                    return True
            Severity: Minor
            Found in oa/rules/header.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 _PatternAddrHeaderRule(name, **kwargs)
            Severity: Major
            Found in oa/rules/header.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                              return _PatternHeaderRule(name, **kwargs)
              Severity: Major
              Found in oa/rules/header.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                    return _PatternNameHeaderRule(name, **kwargs)
                Severity: Major
                Found in oa/rules/header.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                              return _ExistsHeaderRule(name, **kwargs)
                  Severity: Major
                  Found in oa/rules/header.py - About 30 mins to fix

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

                        def __init__(self, name, pattern, score=None, desc=None, priority=0,
                 tflags=None):
        super(_MultiplePatternHeaderRule, self).__init__(name, score=score,
                                                         desc=desc,
                                                         priority=priority,
                    Severity: Major
                    Found in oa/rules/header.py and 5 other locations - About 2 hrs to fix
                    oa/rules/body.py on lines 19..23
                    oa/rules/full.py on lines 11..15
                    oa/rules/header.py on lines 122..126
                    oa/rules/header.py on lines 227..232
                    oa/rules/uri.py on lines 16..20

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

                    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 6 locations. Consider refactoring.
                    Open

                        def __init__(self, name, pattern, score=None, desc=None, priority=0,
                 tflags=None):
        super(_AllHeaderRule, self).__init__(name, score=score, desc=desc,
                                             priority=priority,
                                             tflags=tflags)
                    Severity: Major
                    Found in oa/rules/header.py and 5 other locations - About 2 hrs to fix
                    oa/rules/body.py on lines 19..23
                    oa/rules/full.py on lines 11..15
                    oa/rules/header.py on lines 122..126
                    oa/rules/header.py on lines 192..198
                    oa/rules/uri.py on lines 16..20

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

                    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 6 locations. Consider refactoring.
                    Open

                        def __init__(self, name, header_name, score=None, desc=None, priority=0,
                 tflags=None):
        super(_ExistsHeaderRule, self).__init__(name, score=score, desc=desc,
                                                priority=priority, tflags=tflags)
        self._header_name = header_name
                    Severity: Major
                    Found in oa/rules/header.py and 5 other locations - About 2 hrs to fix
                    oa/rules/body.py on lines 19..23
                    oa/rules/full.py on lines 11..15
                    oa/rules/header.py on lines 192..198
                    oa/rules/header.py on lines 227..232
                    oa/rules/uri.py on lines 16..20

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

                    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 4 locations. Consider refactoring.
                    Open

                    class _PatternAddrHeaderRule(_PatternHeaderRule):
    """Matches a header by name and a regular expression for the value. The
    value checked is the first address that appears in the header's value.
    """
                    Severity: Major
                    Found in oa/rules/header.py and 3 other locations - About 1 hr to fix
                    oa/rules/header.py on lines 60..69
                    oa/rules/header.py on lines 152..161
                    oa/rules/header.py on lines 176..185

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

                    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 4 locations. Consider refactoring.
                    Open

                    class _PatternMimeRawHeaderRule(_PatternMimeHeaderRule):
    """Matches a header by name and a regular expression for the value. The
    headers are NOT decoded, and the header name is NOT included.
    """
                    Severity: Major
                    Found in oa/rules/header.py and 3 other locations - About 1 hr to fix
                    oa/rules/header.py on lines 152..161
                    oa/rules/header.py on lines 164..173
                    oa/rules/header.py on lines 176..185

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

                    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 4 locations. Consider refactoring.
                    Open

                    class _PatternRawHeaderRule(_PatternHeaderRule):
    """Matches a header by name and a regular expression for the value. The
    headers are NOT decoded, and the header name is NOT included.
    """
                    Severity: Major
                    Found in oa/rules/header.py and 3 other locations - About 1 hr to fix
                    oa/rules/header.py on lines 60..69
                    oa/rules/header.py on lines 164..173
                    oa/rules/header.py on lines 176..185

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

                    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 4 locations. Consider refactoring.
                    Open

                    class _PatternNameHeaderRule(_PatternHeaderRule):
    """Matches a header by name and a regular expression for the value. The
    value checked is the first name that appears in the header's value.
    """
                    Severity: Major
                    Found in oa/rules/header.py and 3 other locations - About 1 hr to fix
                    oa/rules/header.py on lines 60..69
                    oa/rules/header.py on lines 152..161
                    oa/rules/header.py on lines 164..173

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

                    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

                    Line too long (81 > 79 characters)
                    Open

                                                                    priority=priority, tflags=tflags)
                    Severity: Minor
                    Found in oa/rules/header.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