SpamExperts/OrangeAssassin

View on GitHub
oa/received_parser.py

Summary

Maintainability
F
3 days
Test Coverage

File received_parser.py has 535 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
Parser for Received headers
It extracts the following metadata:
:rdns
:ip
Severity: Major
Found in oa/received_parser.py - About 1 day to fix

    Cyclomatic complexity is too high in method get_rdns. (23)
    Open

        @staticmethod
        def get_rdns(header):
            """Parsing rdns from Received header
    
            :param header: The received header without the 'from ' at the begin
    Severity: Minor
    Found in oa/received_parser.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_rdns has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_rdns(header):
            """Parsing rdns from Received header
    
            :param header: The received header without the 'from ' at the begin
            :return: rdns if is found if not it returns an empty string
    Severity: Minor
    Found in oa/received_parser.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

    Cyclomatic complexity is too high in method check_for_skip. (18)
    Open

        @staticmethod
        def check_for_skip(header):
            """STUFF TO IGNORE
    
            # Received headers which doesn't start with 'from'
    Severity: Minor
    Found in oa/received_parser.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 get_helo. (14)
    Open

        @staticmethod
        def get_helo(header):
            """Parsing the helo server from Received header
    
            :param header: The received header without the 'from ' at the begin
    Severity: Minor
    Found in oa/received_parser.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 get_auth. (13)
    Open

        @staticmethod
        def get_auth(header):
            """Parsing the authentication from Received header
    
            :param header: The received header without the 'from ' at the begin
    Severity: Minor
    Found in oa/received_parser.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 ReceivedParser. (8)
    Open

    class ReceivedParser(object):
        def __init__(self, received_headers):
            self.received_headers = list()
            self.received = list()
            for header in received_headers:
    Severity: Minor
    Found in oa/received_parser.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 check_for_skip has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        def check_for_skip(header):
            """STUFF TO IGNORE
    
            # Received headers which doesn't start with 'from'
            # Skip fetchmail handovers
    Severity: Minor
    Found in oa/received_parser.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 method get_ip. (6)
    Open

        @staticmethod
        def get_ip(header):
            """Parsing the relay ip address from Received header
    
            :param header: The received header without the 'from ' at the begin
    Severity: Minor
    Found in oa/received_parser.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_helo has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_helo(header):
            """Parsing the helo server from Received header
    
            :param header: The received header without the 'from ' at the begin
            :return: helo if is found if not it returns an empty string
    Severity: Minor
    Found in oa/received_parser.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

    Function get_auth has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_auth(header):
            """Parsing the authentication from Received header
    
            :param header: The received header without the 'from ' at the begin
            :return: auth if is found if not it returns an empty string
    Severity: Minor
    Found in oa/received_parser.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

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

        def _parse_message(self):
            for header in self.received_headers:
                if not self.check_for_skip(header):
                    rdns = self.get_rdns(header)
                    ip = self.get_ip(header)
    Severity: Minor
    Found in oa/received_parser.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 get_ip has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_ip(header):
            """Parsing the relay ip address from Received header
    
            :param header: The received header without the 'from ' at the begin
            :return: ip address if is found if not it returns an empty string
    Severity: Minor
    Found in oa/received_parser.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 False
    Severity: Major
    Found in oa/received_parser.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

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

        Avoid too many return statements within this function.
        Open

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

          Avoid too many return statements within this function.
          Open

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

            Avoid too many return statements within this function.
            Open

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

              Avoid too many return statements within this function.
              Open

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

                Avoid too many return statements within this function.
                Open

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

                  Avoid too many return statements within this function.
                  Open

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

                    Avoid too many return statements within this function.
                    Open

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

                      Avoid too many return statements within this function.
                      Open

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

                        Avoid too many return statements within this function.
                        Open

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

                          Avoid too many return statements within this function.
                          Open

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

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

                                    try:
                                        id = ID_RE.match(header).groups()[0]
                                        id = id.strip("<>")
                                    except (AttributeError, IndexError):
                            Severity: Major
                            Found in oa/received_parser.py and 1 other location - About 1 hr to fix
                            oa/received_parser.py on lines 470..473

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

                            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

                                    try:
                                        envfrom = ENVFROM_RE.match(header).groups()[0]
                                        envfrom = envfrom.strip("><[]")
                                    except (AttributeError, IndexError):
                            Severity: Major
                            Found in oa/received_parser.py and 1 other location - About 1 hr to fix
                            oa/received_parser.py on lines 635..638

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

                            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 HELO_RE2.match(header):
                                            helo = HELO_RE2.match(header).groups()[0]
                                            if helo == 'unknown':
                                                helo = ""
                            Severity: Minor
                            Found in oa/received_parser.py and 1 other location - About 55 mins to fix
                            oa/received_parser.py on lines 488..491

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

                            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 HELO_RE7.match(header):
                                            rdns = HELO_RE7.match(header).groups()[1]
                                            if rdns == "softdnserr":
                                                rdns = ""
                            Severity: Minor
                            Found in oa/received_parser.py and 1 other location - About 55 mins to fix
                            oa/received_parser.py on lines 581..584

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

                            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 (80 > 79 characters)
                            Open

                            AUTH_RE4 = Regex(r'.* by (mail\.gmx\.(net|com)) \([^\)]+\) with ((ESMTP|SMTP))')
                            Severity: Minor
                            Found in oa/received_parser.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.

                            Missing whitespace after ','
                            Open

                                        clean_ip = clean_ip.lower().replace('ipv6:','')
                            Severity: Minor
                            Found in oa/received_parser.py by pep8

                            Each comma, semicolon or colon should be followed by whitespace.

                            Okay: [a, b]
                            Okay: (3,)
                            Okay: a[1:4]
                            Okay: a[:4]
                            Okay: a[1:]
                            Okay: a[1:4:2]
                            E231: ['a','b']
                            E231: foo(bar,baz)
                            E231: [{'a':'b'}]

                            Missing whitespace after ','
                            Open

                                        clean_ip = clean_ip.lower().replace('::ffff:','')
                            Severity: Minor
                            Found in oa/received_parser.py by pep8

                            Each comma, semicolon or colon should be followed by whitespace.

                            Okay: [a, b]
                            Okay: (3,)
                            Okay: a[1:4]
                            Okay: a[:4]
                            Okay: a[1:]
                            Okay: a[1:4:2]
                            E231: ['a','b']
                            E231: foo(bar,baz)
                            E231: [{'a':'b'}]

                            Continuation line over-indented for visual indent
                            Open

                                                  r'HTTP|SMTP)')
                            Severity: Minor
                            Found in oa/received_parser.py by pep8

                            Continuation lines indentation.

                            Continuation lines should align wrapped elements either vertically
                            using Python's implicit line joining inside parentheses, brackets
                            and braces, or using a hanging indent.
                            
                            When using a hanging indent these considerations should be applied:
                            - there should be no arguments on the first line, and
                            - further indentation should be used to clearly distinguish itself
                              as a continuation line.
                            
                            Okay: a = (\n)
                            E123: a = (\n    )
                            
                            Okay: a = (\n    42)
                            E121: a = (\n   42)
                            E122: a = (\n42)
                            E123: a = (\n    42\n    )
                            E124: a = (24,\n     42\n)
                            E125: if (\n    b):\n    pass
                            E126: a = (\n        42)
                            E127: a = (24,\n      42)
                            E128: a = (24,\n    42)
                            E129: if (a or\n    b):\n    pass
                            E131: a = (\n    42\n 24)

                            There are no issues that match your filters.

                            Category
                            Status