src/pyff/mdx.py

Summary

Maintainability
F
1 wk
Test Coverage

Function main has a Cognitive Complexity of 125 (exceeds 5 allowed). Consider refactoring.
Open

def main():
    """
    The main entrypoint for the pyffd command.
    """
    try:
Severity: Minor
Found in src/pyff/mdx.py - About 2 days 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

File mdx.py has 745 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
An implementation of draft-lajoie-md-query

.. code-block:: bash

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

    Function request has a Cognitive Complexity of 85 (exceeds 5 allowed). Consider refactoring.
    Open

        def request(self, **kwargs):
            """The main request processor. This code implements all rendering of metadata.
            """
            stats['MD Requests'] += 1
    
    
    Severity: Minor
    Found in src/pyff/mdx.py - About 1 day 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 main. (45)
    Open

    def main():
        """
        The main entrypoint for the pyffd command.
        """
        try:
    Severity: Minor
    Found in src/pyff/mdx.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 main has 169 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def main():
        """
        The main entrypoint for the pyffd command.
        """
        try:
    Severity: Major
    Found in src/pyff/mdx.py - About 6 hrs to fix

      Cyclomatic complexity is too high in method request. (34)
      Open

          def request(self, **kwargs):
              """The main request processor. This code implements all rendering of metadata.
              """
              stats['MD Requests'] += 1
      
      
      Severity: Minor
      Found in src/pyff/mdx.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 request has 156 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def request(self, **kwargs):
              """The main request processor. This code implements all rendering of metadata.
              """
              stats['MD Requests'] += 1
      
      
      Severity: Major
      Found in src/pyff/mdx.py - About 6 hrs to fix

        Cyclomatic complexity is too high in class MDServer. (14)
        Open

        class MDServer(object):
            """The MDServer class is the business logic of pyFF. This class is isolated from the request-decoding logic
            of MDRoot and from the ancilliary classes like MDStats and WellKnown.
            """
        
        
        Severity: Minor
        Found in src/pyff/mdx.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 webfinger has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
        Open

            @cherrypy.expose
            def webfinger(self, resource=None, rel=None):
                """An implementation the webfinger protocol (http://tools.ietf.org/html/draft-ietf-appsawg-webfinger-12)
                in order to provide information about up and downstream metadata available at this pyFF instance.
        
        
        Severity: Minor
        Found in src/pyff/mdx.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 webfinger. (8)
        Open

            @cherrypy.expose
            def webfinger(self, resource=None, rel=None):
                """An implementation the webfinger protocol (http://tools.ietf.org/html/draft-ietf-appsawg-webfinger-12)
                in order to provide information about up and downstream metadata available at this pyFF instance.
        
        
        Severity: Minor
        Found in src/pyff/mdx.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 __init__. (6)
        Open

            def __init__(self, pipes=None, observers=None):
        
                if not observers:
                    observers = []
                if not pipes:
        Severity: Minor
        Found in src/pyff/mdx.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 webfinger has 37 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            @cherrypy.expose
            def webfinger(self, resource=None, rel=None):
                """An implementation the webfinger protocol (http://tools.ietf.org/html/draft-ietf-appsawg-webfinger-12)
                in order to provide information about up and downstream metadata available at this pyFF instance.
        
        
        Severity: Minor
        Found in src/pyff/mdx.py - About 1 hr to fix

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

              def search(self, paged=False, query=None, page=0, page_limit=10, entity_filter=None, related=None):
          Severity: Major
          Found in src/pyff/mdx.py - About 50 mins to fix

            Avoid deeply nested control flow statements.
            Open

                            for p in self.plumbings:
                                state = {'request': True,
                                         'headers': {'Content-Type': 'text/xml'},
                                         'accept': accept,
                                         'url': cherrypy.url(relative=False),
            Severity: Major
            Found in src/pyff/mdx.py - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                  if referrer is not None:
                                      log.debug("including referrer: %s" % referrer)
                                      url = urlparse.urlparse(referrer)
                                      host = url.netloc
                                      if ':' in url.netloc:
              Severity: Major
              Found in src/pyff/mdx.py - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                            elif o in ('--port', '-P'):
                                config.port = int(a)
                            elif o in ('--pidfile', '-p'):
                                config.pid_file = a
                            elif o in ('--no-caching', '-C'):
                Severity: Major
                Found in src/pyff/mdx.py - About 45 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                                  if not q:
                                      if pfx:
                                          title = pfx
                                      else:
                                          title = _("Metadata By Attributes")
                  Severity: Major
                  Found in src/pyff/mdx.py - About 45 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                            return render_template("entity.html",
                                                                   headline=entity_display_name(entity),
                                                                   subheading=entity.get('entityID'),
                                                                   entity_id=entity.get('entityID'),
                                                                   samlmd=samlmd,
                    Severity: Major
                    Found in src/pyff/mdx.py - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

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

                        Avoid too many return statements within this function.
                        Open

                                                return render_template("metadata.html",
                                                                       md=self.md,
                                                                       samlmd=samlmd,
                                                                       subheading=q,
                                                                       entities=entities)
                        Severity: Major
                        Found in src/pyff/mdx.py - About 30 mins to fix

                          XXX found
                          Open

                                              # XXX fix this - urlparse is not 3.x and also this way to handle extra info sucks
                          Severity: Minor
                          Found in src/pyff/mdx.py by fixme

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

                                  if len(args) > 0 and args[0] in self.server.aliases:
                                      kwargs['pfx'] = args[0]
                                      if len(args) > 1:
                                          kwargs['path'] = args[1]
                                      return self.server.request(**kwargs)
                          Severity: Major
                          Found in src/pyff/mdx.py and 1 other location - About 1 day to fix
                          src/pyff/mdx.py on lines 454..462

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

                          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

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

                                  if len(args) > 0 and args[0] in self.server.aliases:
                                      kwargs['pfx'] = args[0]
                                      if len(args) > 1:
                                          kwargs['path'] = args[1]
                                      return self.server.request(**kwargs)
                          Severity: Major
                          Found in src/pyff/mdx.py and 1 other location - About 1 day to fix
                          src/pyff/mdx.py on lines 294..302

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

                          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 config.error_log is not None:
                                  if config.error_log.startswith('syslog:'):
                                      facility = config.error_log[7:]
                                      h = SysLogLibHandler(facility=facility)
                                      app.log.error_log.addHandler(h)
                          Severity: Major
                          Found in src/pyff/mdx.py and 1 other location - About 5 hrs to fix
                          src/pyff/mdx.py on lines 869..876

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

                          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 config.access_log is not None:
                                  if config.access_log.startswith('syslog:'):
                                      facility = config.error_log[7:]
                                      h = SysLogLibHandler(facility=facility)
                                      app.log.access_log.addHandler(h)
                          Severity: Major
                          Found in src/pyff/mdx.py and 1 other location - About 5 hrs to fix
                          src/pyff/mdx.py on lines 860..867

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

                          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