Sign upLogin

uktrade/directory-client-core

View on GitHub
Star

Showing 9 of 9 total issues

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

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

    def post(self, url, data={}, files=None, authenticator=None):
        if files:
            response = self.request(
                url=url,
                method="POST",
Severity: Major
Found in directory_client_core/base.py and 1 other location - About 3 hrs to fix
directory_client_core/base.py on lines 38..55

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

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

    def patch(self, url, data, files=None, authenticator=None):
        if files:
            response = self.request(
                url=url,
                method="PATCH",
Severity: Major
Found in directory_client_core/base.py and 1 other location - About 3 hrs to fix
directory_client_core/base.py on lines 66..83

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

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

Function request has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def request(
Severity: Major
Found in directory_client_core/base.py - About 1 hr to fix

    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

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

          def send(self, method, url, request=None, *args, **kwargs):
      Severity: Minor
      Found in directory_client_core/base.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
            Severity
            Category
            Status
            Source
            Language