src/pyff/resource.py

Summary

Maintainability
D
2 days
Test Coverage

File resource.py has 403 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""

An abstraction layer for metadata fetchers. Supports both synchronous and asynchronous fetchers with cache.

"""
Severity: Minor
Found in src/pyff/resource.py - About 5 hrs to fix

    Function parse has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
    Open

        def parse(self, getter: Callable[[str], Response]) -> Deque[Resource]:
            data, status, info = self.load_resource(getter)
    
            if not data:
                raise ResourceException(f'Nothing to parse when loading resource {self}')
    Severity: Minor
    Found in src/pyff/resource.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

    Resource has 28 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Resource(Watchable):
        def __init__(self, url: Optional[str], opts: ResourceOpts):
            super().__init__()
            self.url: Optional[str] = url
            self.opts: ResourceOpts = opts
    Severity: Minor
    Found in src/pyff/resource.py - About 3 hrs to fix

      Cyclomatic complexity is too high in method load_resource. (15)
      Open

          def load_resource(self, getter: Callable[[str], Response]) -> Tuple[Optional[str], int, ResourceInfo]:
              data: Optional[str] = None
              status: int = 500
              info = self.add_info()
              verify_tls = self.opts.verify_tls
      Severity: Minor
      Found in src/pyff/resource.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 parse. (11)
      Open

          def parse(self, getter: Callable[[str], Response]) -> Deque[Resource]:
              data, status, info = self.load_resource(getter)
      
              if not data:
                  raise ResourceException(f'Nothing to parse when loading resource {self}')
      Severity: Minor
      Found in src/pyff/resource.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 load_resource has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
      Open

          def load_resource(self, getter: Callable[[str], Response]) -> Tuple[Optional[str], int, ResourceInfo]:
              data: Optional[str] = None
              status: int = 500
              info = self.add_info()
              verify_tls = self.opts.verify_tls
      Severity: Minor
      Found in src/pyff/resource.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 _setup. (8)
      Open

          def _setup(self):
              if self.url is not None:
                  if "://" not in self.url:
                      pth = os.path.abspath(self.url)
                      if os.path.isdir(pth):
      Severity: Minor
      Found in src/pyff/resource.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 global_md_sources has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          def global_md_sources(self):
              from pyff.samlmd import SAMLParserInfo
      
              md_sources = defaultdict(list)
              for r in self.walk():
      Severity: Minor
      Found in src/pyff/resource.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

      Cyclomatic complexity is too high in method global_md_sources. (6)
      Open

          def global_md_sources(self):
              from pyff.samlmd import SAMLParserInfo
      
              md_sources = defaultdict(list)
              for r in self.walk():
      Severity: Minor
      Found in src/pyff/resource.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 _setup has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def _setup(self):
              if self.url is not None:
                  if "://" not in self.url:
                      pth = os.path.abspath(self.url)
                      if os.path.isdir(pth):
      Severity: Minor
      Found in src/pyff/resource.py - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Avoid deeply nested control flow statements.
      Open

                              if n_t is None:
                                  log.warn(f'callback did not return anything when parsing {self.url} {info}')
                              self.t = n_t
      Severity: Major
      Found in src/pyff/resource.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                for entity_id in info.parser_info.entities:
                                    md_sources[entity_id].append(r.url)
                return md_sources
        Severity: Major
        Found in src/pyff/resource.py - About 45 mins to fix

          Function i_handle has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              def i_handle(self, t, url=None, response=None, exception=None, last_fetched=None):
          Severity: Minor
          Found in src/pyff/resource.py - About 35 mins to fix

            Function i_handle has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                def i_handle(self, t, url=None, response=None, exception=None, last_fetched=None):
            Severity: Minor
            Found in src/pyff/resource.py - About 35 mins to fix

              Function i_handle has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                  def i_handle(self, t: Resource, url=None, response=None, exception=None, last_fetched=None):
              Severity: Minor
              Found in src/pyff/resource.py - About 35 mins to fix

                Function __call__ has 5 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                    def __call__(self, watched=None, url=None, response=None, exception=None, last_fetched=None):
                Severity: Minor
                Found in src/pyff/resource.py - About 35 mins to fix

                  TODO found
                  Open

                      # TODO: sort imports to make the correct typing work: Iterable[PipelineCallback] = Field([])
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                      status_code: Optional[str] = None # HTTP status code as string. TODO: change to int
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                      def cleanup(self) -> Iterable[Callable]:  # TODO: move classes to make this work -> Iterable['PipelineCallback']:
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                      alias: Optional[str] = Field(None, alias='as')  # TODO: Rename to 'name'?
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                      # TODO: move classes to make the correct typing work: Iterable[Union[Lambda, PipelineCallback]] = Field([])
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                          # TODO: move classes to be able to declare callback: Union['Lambda', 'PipelineCallback']
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  TODO found
                  Open

                      ) -> Iterable[Callable]:  # TODO: move classes to make this work -> List[Union['Lambda', 'PipelineCallback']]:
                  Severity: Minor
                  Found in src/pyff/resource.py by fixme

                  There are no issues that match your filters.

                  Category
                  Status