IdentityPython/pyFF

View on GitHub
src/pyff/utils.py

Summary

Maintainability
F
1 wk
Test Coverage

File utils.py has 512 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# coding=utf-8


"""

Severity: Major
Found in src/pyff/utils.py - About 1 day to fix

    Function guess_entity_software has a Cognitive Complexity of 49 (exceeds 5 allowed). Consider refactoring.
    Open

    def guess_entity_software(e):
        for elt in chain(e.findall(".//{%s}SingleSignOnService" % NS['md']),
                         e.findall(".//{%s}AssertionConsumerService" % NS['md'])):
            location = elt.get('Location')
            if location:
    Severity: Minor
    Found in src/pyff/utils.py - About 7 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 function guess_entity_software. (35)
    Open

    def guess_entity_software(e):
        for elt in chain(e.findall(".//{%s}SingleSignOnService" % NS['md']),
                         e.findall(".//{%s}AssertionConsumerService" % NS['md'])):
            location = elt.get('Location')
            if location:
    Severity: Minor
    Found in src/pyff/utils.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 function safe_write. (11)
    Open

    def safe_write(fn, data):
        """Safely write data to a file with name fn
        :param fn: a filename
        :param data: some string data to write
        :return: True or False depending on the outcome of the write
    Severity: Minor
    Found in src/pyff/utils.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 function resource_string. (9)
    Open

    def resource_string(name, pfx=None):
        """
    Attempt to load and return the contents (as a string) of the resource named by
    the first argument in the first location of:
    
    
    Severity: Minor
    Found in src/pyff/utils.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 function b2u. (8)
    Open

    def b2u(data):
        if is_text(data):
            return data
        elif isinstance(data, six.binary_type):
            return data.decode("utf-8")
    Severity: Minor
    Found in src/pyff/utils.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 function resource_filename. (7)
    Open

    def resource_filename(name, pfx=None):
        """
    Attempt to find and return the filename of the resource named by the first argument
    in the first location of:
    
    
    Severity: Minor
    Found in src/pyff/utils.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 function xslt_transform. (6)
    Open

    def xslt_transform(t, stylesheet, params=None):
        if not params:
            params = dict()
    
        if not hasattr(thread_data, 'xslt'):
    Severity: Minor
    Found in src/pyff/utils.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

    Consider simplifying this complex logical expression.
    Open

                if 'sso/post' in location \
                        or 'sso/redirect' in location \
                        or 'saml2/sp/acs' in location \
                        or 'saml2/ls' in location \
                        or 'saml2/acs' in location \
    Severity: Critical
    Found in src/pyff/utils.py - About 1 hr to fix

      Function safe_write has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      def safe_write(fn, data):
          """Safely write data to a file with name fn
          :param fn: a filename
          :param data: some string data to write
          :return: True or False depending on the outcome of the write
      Severity: Minor
      Found in src/pyff/utils.py - About 55 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 None
      Severity: Major
      Found in src/pyff/utils.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                        return 'OpenSSO'
        Severity: Major
        Found in src/pyff/utils.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                          return 'PingFederate'
          Severity: Major
          Found in src/pyff/utils.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                            return 'Novell Access Manager'
            Severity: Major
            Found in src/pyff/utils.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                              return 'PySAML'
              Severity: Major
              Found in src/pyff/utils.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                return 'Salesforce'
                Severity: Major
                Found in src/pyff/utils.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return data
                  Severity: Major
                  Found in src/pyff/utils.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                    return 'OpenAthens'
                    Severity: Major
                    Found in src/pyff/utils.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              return 'SimpleSAMLphp'
                      Severity: Major
                      Found in src/pyff/utils.py - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                return 'Shibboleth'
                        Severity: Major
                        Found in src/pyff/utils.py - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                              return 'other'
                          Severity: Major
                          Found in src/pyff/utils.py - About 30 mins to fix

                            Avoid too many return statements within this function.
                            Open

                                            return 'CASiteMinder'
                            Severity: Major
                            Found in src/pyff/utils.py - About 30 mins to fix

                              Avoid too many return statements within this function.
                              Open

                                              return 'IBMTivoliFIM'
                              Severity: Major
                              Found in src/pyff/utils.py - About 30 mins to fix

                                Avoid too many return statements within this function.
                                Open

                                                return 'SURFConext'
                                Severity: Major
                                Found in src/pyff/utils.py - About 30 mins to fix

                                  Avoid too many return statements within this function.
                                  Open

                                                  return 'Authentic2'
                                  Severity: Major
                                  Found in src/pyff/utils.py - About 30 mins to fix

                                    Avoid too many return statements within this function.
                                    Open

                                            return 'OpenAthens'
                                    Severity: Major
                                    Found in src/pyff/utils.py - About 30 mins to fix

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

                                      def b2u(data):
                                          if is_text(data):
                                              return data
                                          elif isinstance(data, six.binary_type):
                                              return data.decode("utf-8")
                                      Severity: Minor
                                      Found in src/pyff/utils.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

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

                                      def valid_until_ts(elt, default_ts):
                                          ts = default_ts
                                          valid_until = elt.get("validUntil", None)
                                          if valid_until is not None:
                                              dt = iso8601.parse_date(valid_until)
                                      Severity: Minor
                                      Found in src/pyff/utils.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

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

                                      def xslt_transform(t, stylesheet, params=None):
                                          if not params:
                                              params = dict()
                                      
                                          if not hasattr(thread_data, 'xslt'):
                                      Severity: Minor
                                      Found in src/pyff/utils.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

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

                                      def guess_entity_software(e):
                                          for elt in chain(e.findall(".//{%s}SingleSignOnService" % NS['md']),
                                                           e.findall(".//{%s}AssertionConsumerService" % NS['md'])):
                                              location = elt.get('Location')
                                              if location:
                                      Severity: Major
                                      Found in src/pyff/utils.py and 1 other location - About 4 days to fix
                                      src/pyff/samlmd.py on lines 392..445

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

                                      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

                                              return (dt.microseconds + (dt.seconds + dt.days * 24 * 3600) * 10 ** 6) / 10 ** 6
                                      Severity: Major
                                      Found in src/pyff/utils.py and 1 other location - About 1 hr to fix
                                      src/pyff/utils.py on lines 137..137

                                      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

                                          ts = (td.microseconds + (td.seconds + td.days * 24 * 3600) * 10 ** 6) / 1e6
                                      Severity: Major
                                      Found in src/pyff/utils.py and 1 other location - About 1 hr to fix
                                      src/pyff/utils.py on lines 433..433

                                      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

                                      There are no issues that match your filters.

                                      Category
                                      Status