# CiscoUcs/ucsmsdk

ucsmsdk/ucsgenutils.py

### Summary

D
1 day

#### File `ucsgenutils.py` has 374 lines of code (exceeds 250 allowed). Consider refactoring. Open

``````# Copyright 2015 Cisco Systems, Inc.
#
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at``````
Found in ucsmsdk/ucsgenutils.py - About 5 hrs to fix

#### Cyclomatic complexity is too high in function get_java_installation_path. (11) Open

``````def get_java_installation_path():
"""
Method returns the java installation path in the windows or
Linux environment.
"""``````

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

#### Function `get_java_installation_path` has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring. Open

``````def get_java_installation_path():
"""
Method returns the java installation path in the windows or
Linux environment.
"""``````
Found in ucsmsdk/ucsgenutils.py - About 2 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"

#### Cyclomatic complexity is too high in function check_registry_key. (6) Open

``````def check_registry_key(java_key):
""" Method checks for the java in the registry entries. """

# Added KEY_WOW64_64KEY, KEY_ALL_ACCESS. This lets 32bit python access
# registry keys of 64bit Application on Windows supporting 64 bit.``````

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

#### Cyclomatic complexity is too high in function remove_invalid_chars. (6) Open

``````def remove_invalid_chars(xml_str):
replace_dict = {
'<': '&lt;',
'>': '&gt;',
'&': '&amp;'``````

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

#### Function `remove_invalid_chars` has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open

``````def remove_invalid_chars(xml_str):
replace_dict = {
'<': '&lt;',
'>': '&gt;',
'&': '&amp;'``````
Found in ucsmsdk/ucsgenutils.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"

#### Function `check_registry_key` has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open

``````def check_registry_key(java_key):
""" Method checks for the java in the registry entries. """

# Added KEY_WOW64_64KEY, KEY_ALL_ACCESS. This lets 32bit python access
# registry keys of 64bit Application on Windows supporting 64 bit.``````
Found in ucsmsdk/ucsgenutils.py - About 45 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"

#### Function `download_file` has 5 arguments (exceeds 4 allowed). Consider refactoring. Open

``def download_file(driver, file_url, file_dir, file_name, progress=Progress()):``
Found in ucsmsdk/ucsgenutils.py - About 35 mins to fix

#### Function `upload_file` has 5 arguments (exceeds 4 allowed). Consider refactoring. Open

``def upload_file(driver, uri, file_dir, file_name, progress=Progress()):``
Found in ucsmsdk/ucsgenutils.py - About 35 mins to fix

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

``def get_java_installation_path():``
Found in ucsmsdk/ucsgenutils.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

#### Remove this commented out code. Open

``    # auth = cipher[-8:]``
Found in ucsmsdk/ucsgenutils.py by sonar-python

Programmers should not comment out code as it bloats programs and reduces readability.

Unused code should be deleted and can be retrieved from source control history if required.

## See

• MISRA C:2004, 2.4 - Sections of code should not be "commented out".
• MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
• MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
• MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

#### Remove this commented out code. Open

``    # k_auth = h_hash('auth' + key + uhash)``
Found in ucsmsdk/ucsgenutils.py by sonar-python

Programmers should not comment out code as it bloats programs and reduces readability.

Unused code should be deleted and can be retrieved from source control history if required.

## See

• MISRA C:2004, 2.4 - Sections of code should not be "commented out".
• MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
• MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
• MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

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

``````    for i in range(len(password_stream)):
Found in ucsmsdk/ucsgenutils.py and 1 other location - About 1 hr to fix
ucsmsdk/ucsgenutils.py on lines 455..456

## 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 43.

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

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

``````    for i_cnt in range(len(password_stream)):
Found in ucsmsdk/ucsgenutils.py and 1 other location - About 1 hr to fix
ucsmsdk/ucsgenutils.py on lines 492..493

## 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 43.

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

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

``````def word_l(word):
""" Method makes the first letter of the given string as lower case. """

return word[0].lower() + word[1:]``````
Found in ucsmsdk/ucsgenutils.py and 1 other location - About 40 mins to fix
ucsmsdk/ucsgenutils.py on lines 103..106

## 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 34.

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

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

``````def word_u(word):
""" Method makes the first letter of the given string as capital. """

return word[0].upper() + word[1:]``````
Found in ucsmsdk/ucsgenutils.py and 1 other location - About 40 mins to fix
ucsmsdk/ucsgenutils.py on lines 97..100

## 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 34.

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