zhmcclient/python-zhmcclient

View on GitHub
zhmcclient/_auto_updater.py

Summary

Maintainability
D
2 days
Test Coverage

Function on_message has a Cognitive Complexity of 78 (exceeds 5 allowed). Consider refactoring.
Open

    def on_message(self, headers, message):
        """
        Event method that gets called when this listener has received a JMS
        message (representing an HMC notification).

Severity: Minor
Found in zhmcclient/_auto_updater.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

File _auto_updater.py has 354 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python
# Copyright 2021 IBM Corp. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Severity: Minor
Found in zhmcclient/_auto_updater.py - About 4 hrs to fix

    Cyclomatic complexity is too high in method on_message. (30)
    Open

        def on_message(self, headers, message):
            """
            Event method that gets called when this listener has received a JMS
            message (representing an HMC notification).
    
    
    Severity: Minor
    Found in zhmcclient/_auto_updater.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 _manager_uri_from_notification has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def _manager_uri_from_notification(self, headers):
            """
            Return the manager URI from the headers of an inventory notification
            and the resource URI.
            """
    Severity: Minor
    Found in zhmcclient/_auto_updater.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 mgr_obj.auto_update_enabled():
                                mgr_obj.remove_resource_local(uri)
                    for obj in self._updater.registered_objects(uri):
    Severity: Major
    Found in zhmcclient/_auto_updater.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                              if mgr_obj.auto_update_enabled():
                                  mgr_obj.auto_update_trigger_pull()
                  elif action == 'remove':
      Severity: Major
      Found in zhmcclient/_auto_updater.py - About 45 mins to fix

        Avoid too many return statements within this function.
        Open

                        return
        Severity: Major
        Found in zhmcclient/_auto_updater.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                              return
          Severity: Major
          Found in zhmcclient/_auto_updater.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                                return
            Severity: Major
            Found in zhmcclient/_auto_updater.py - About 30 mins to fix

              There are no issues that match your filters.

              Category
              Status