zhmcclient/python-zhmcclient

View on GitHub
zhmcclient/_resource.py

Summary

Maintainability
D
2 days
Test Coverage

File _resource.py has 568 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Copyright 2016,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.
# You may obtain a copy of the License at
Severity: Major
Found in zhmcclient/_resource.py - About 1 day to fix

    Function pull_properties has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

        def pull_properties(self, properties):
            """
            Retrieve the specified set of resource properties from the HMC and
            cache them in this Python object.
    
    
    Severity: Minor
    Found in zhmcclient/_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

    BaseResource has 22 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class BaseResource(object):
        """
        Abstract base class for resource classes (e.g. :class:`~zhmcclient.Cpc`)
        representing manageable resources.
    
    
    Severity: Minor
    Found in zhmcclient/_resource.py - About 2 hrs to fix

      Function get_properties_local has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          def get_properties_local(self, names, defaults=None):
              """
              Return the values of a set of resource properties, using default values
              for those that are not cached in this Python object, without
              retrieving them from the HMC.
      Severity: Minor
      Found in zhmcclient/_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

      Function __init__ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

          def __init__(self, manager, uri, name, properties):
              # This method intentionally has no docstring, because it is internal.
              #
              # Parameters:
              #   manager (subclass of :class:`~zhmcclient.BaseManager`):
      Severity: Minor
      Found in zhmcclient/_resource.py - About 35 mins 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

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

                  try:
                      subset_properties = self.manager.session.get(
                          self._uri, resource=self)
                      is_full = True
                  except HTTPError as exc:
      Severity: Major
      Found in zhmcclient/_resource.py and 1 other location - About 1 hr to fix
      zhmcclient/_resource.py on lines 264..271

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

      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

              try:
                  full_properties = self.manager.session.get(self._uri, resource=self)
              except HTTPError as exc:
                  if exc.http_status == 404 and exc.reason == 1:
                      # The resource no longer exists
      Severity: Major
      Found in zhmcclient/_resource.py and 1 other location - About 1 hr to fix
      zhmcclient/_resource.py on lines 364..373

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

      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