Sign upLogin

uktrade/directory-client-core

View on GitHub
Star
directory_client_core/helpers.py

Summary

Maintainability
B
5 hrs
Test Coverage

Function fallback has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

def fallback(cache):
    """
    Caches content retrieved by the client, thus allowing the cached
    content to be used later if the live content cannot be retrieved.
Severity: Minor
Found in directory_client_core/helpers.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

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

        def wrapper(client, url, params={}, *args, **kwargs):
Severity: Minor
Found in directory_client_core/helpers.py - About 35 mins to fix

    Avoid too many return statements within this function.
    Open

                            return FailureResponse.from_response(response)
    Severity: Major
    Found in directory_client_core/helpers.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                          return LiveResponse.from_response(response)
      Severity: Major
      Found in directory_client_core/helpers.py - About 30 mins to fix

        At least two spaces before inline comment
        Open

                                return CacheResponse.from_cached_content(cached_content) # noqa
        Severity: Minor
        Found in directory_client_core/helpers.py by pep8

        Separate inline comments by at least two spaces.

        An inline comment is a comment on the same line as a statement.
Inline comments should be separated by at least two spaces from the
statement. They should start with a # and a single space.

Each line of a block comment starts with a # and a single space
(unless it is indented text inside the comment).

Okay: x = x + 1  # Increment x
Okay: x = x + 1    # Increment x
Okay: # Block comment
E261: x = x + 1 # Increment x
E262: x = x + 1  #Increment x
E262: x = x + 1  #  Increment x
E265: #Block comment
E266: ### Block comment

        There are no issues that match your filters.

        Category
        Status