CiscoUcs/ucsmsdk

View on GitHub
ucsmsdk/utils/inventory.py

Summary

Maintainability
F
4 days
Test Coverage

File inventory.py has 413 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Copyright 2017 Cisco Systems, Inc.
#
# 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: Minor
Found in ucsmsdk/utils/inventory.py - About 5 hrs to fix

    Function _get_inventory_html has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_inventory_html(inventory, file_name, spec=inventory_spec):
        if file_name is None:
            raise UcsOperationError("Inventory collection",
                                    "file_name is a required parameter")
        f = open(file_name, "w")
    Severity: Minor
    Found in ucsmsdk/utils/inventory.py - About 4 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 _get_inventory has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_inventory(handle, comp, spec, inventory):
        component = spec[comp]
        class_id = component["class_id"]
        mos = handle.query_classid(class_id)
    
    
    Severity: Minor
    Found in ucsmsdk/utils/inventory.py - About 4 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 _get_inventory_csv has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_inventory_csv(inventory, file_name, spec=inventory_spec):
        import csv
        if file_name is None:
            raise UcsOperationError("Inventory collection",
                                    "file_name is a required parameter")
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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 get_inventory has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_inventory(handle,
                      component="all",
                      file_format="json",
                      file_name=None,
                      spec=inventory_spec):
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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

    Cyclomatic complexity is too high in function _get_inventory_html. (13)
    Open

    def _get_inventory_html(inventory, file_name, spec=inventory_spec):
        if file_name is None:
            raise UcsOperationError("Inventory collection",
                                    "file_name is a required parameter")
        f = open(file_name, "w")
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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 function get_inventory. (12)
    Open

    def get_inventory(handle,
                      component="all",
                      file_format="json",
                      file_name=None,
                      spec=inventory_spec):
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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 function _get_inventory. (11)
    Open

    def _get_inventory(handle, comp, spec, inventory):
        component = spec[comp]
        class_id = component["class_id"]
        mos = handle.query_classid(class_id)
    
    
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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 function _get_inventory_csv. (10)
    Open

    def _get_inventory_csv(inventory, file_name, spec=inventory_spec):
        import csv
        if file_name is None:
            raise UcsOperationError("Inventory collection",
                                    "file_name is a required parameter")
    Severity: Minor
    Found in ucsmsdk/utils/inventory.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

    Avoid deeply nested control flow statements.
    Open

                        if _should_ignore(component, sub_mo):
                            continue
                        _sanitize_and_store(mo_dict, prop, sub_mo)
    Severity: Major
    Found in ucsmsdk/utils/inventory.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if each is None:
                              each = ""
                          html += "<td>" + each + "</td>"
      Severity: Major
      Found in ucsmsdk/utils/inventory.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                            if key not in entry:
                                continue
                            row_val.append(entry[key])
        Severity: Major
        Found in ucsmsdk/utils/inventory.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              if key not in entry:
                                  continue
                              row_val.append(entry[key])
          Severity: Major
          Found in ucsmsdk/utils/inventory.py - About 45 mins to fix

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

            def get_inventory(handle,
            Severity: Minor
            Found in ucsmsdk/utils/inventory.py - About 35 mins to fix

              Refactor this function to reduce its Cognitive Complexity from 22 to the 15 allowed.
              Open

              def get_inventory(handle,
              Severity: Critical
              Found in ucsmsdk/utils/inventory.py by sonar-python

              Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

              See

              Refactor this function to reduce its Cognitive Complexity from 33 to the 15 allowed.
              Open

              def _get_inventory_html(inventory, file_name, spec=inventory_spec):
              Severity: Critical
              Found in ucsmsdk/utils/inventory.py by sonar-python

              Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

              See

              Refactor this function to reduce its Cognitive Complexity from 22 to the 15 allowed.
              Open

              def _get_inventory_csv(inventory, file_name, spec=inventory_spec):
              Severity: Critical
              Found in ucsmsdk/utils/inventory.py by sonar-python

              Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

              See

              Refactor this function to reduce its Cognitive Complexity from 32 to the 15 allowed.
              Open

              def _get_inventory(handle, comp, spec, inventory):
              Severity: Critical
              Found in ucsmsdk/utils/inventory.py by sonar-python

              Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

              See

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

                  "storage": {
                      "class_id": "StorageController",
                      "props": [
                          {"label": "Server", "prop": "dn"},
                          {"prop": "id"},
              Severity: Major
              Found in ucsmsdk/utils/inventory.py and 1 other location - About 2 hrs to fix
              ucsmsdk/utils/inventory.py on lines 82..94

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

              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

                  "pci": {
                      "class_id": "PciEquipSlot",
                      "props": [
                          {"label": "Server", "prop": "dn"},
                          {"prop": "id"},
              Severity: Major
              Found in ucsmsdk/utils/inventory.py and 1 other location - About 2 hrs to fix
              ucsmsdk/utils/inventory.py on lines 120..132

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

              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

                              for key in keys:
                                  if key not in entry:
                                      continue
                                  row_val.append(entry[key])
              Severity: Minor
              Found in ucsmsdk/utils/inventory.py and 1 other location - About 30 mins to fix
              ucsmsdk/utils/inventory.py on lines 390..393

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

              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

                              for key in keys:
                                  if key not in entry:
                                      continue
                                  row_val.append(entry[key])
              Severity: Minor
              Found in ucsmsdk/utils/inventory.py and 1 other location - About 30 mins to fix
              ucsmsdk/utils/inventory.py on lines 297..300

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

              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