cloudpassage/cloudpassage-halo-python-sdk

View on GitHub
cloudpassage/halo.py

Summary

Maintainability
B
4 hrs
Test Coverage

Cyclomatic complexity is too high in method __init__. (9)
Open

    def __init__(self, apikey, apisecret, **kwargs):
        self.auth_endpoint = 'oauth/access_token'
        self.api_host = 'api.cloudpassage.com'
        self.api_port = 443
        self.sdk_version = utility.get_sdk_version()
Severity: Minor
Found in cloudpassage/halo.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

File halo.py has 252 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""HaloSession class.

Manage session configuration for interacting with the CloudPassage Halo API.
"""

Severity: Minor
Found in cloudpassage/halo.py - About 2 hrs to fix

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

        def __init__(self, apikey, apisecret, **kwargs):
            self.auth_endpoint = 'oauth/access_token'
            self.api_host = 'api.cloudpassage.com'
            self.api_port = 443
            self.sdk_version = utility.get_sdk_version()
    Severity: Minor
    Found in cloudpassage/halo.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 authenticate_client has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        def authenticate_client(self):
            """This method attempts to set an OAuth token
    
            Call this method and it will use the API key and secret
            as well as the proxy settings (if used) to authenticate
    Severity: Minor
    Found in cloudpassage/halo.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"

    Further reading

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

        def get_response(self, client_method, verb, url, params, reqbody):
    Severity: Minor
    Found in cloudpassage/halo.py - About 35 mins to fix

      Line too long (97 > 79 characters)
      Open

                  self.client.proxies.update(self.build_proxy_struct(self.proxy_host, self.proxy_port))
      Severity: Minor
      Found in cloudpassage/halo.py by pep8

      Limit all lines to a maximum of 79 characters.

      There are still many devices around that are limited to 80 character
      lines; plus, limiting windows to 80 characters makes it possible to
      have several windows side-by-side.  The default wrapping on such
      devices looks ugly.  Therefore, please limit all lines to a maximum
      of 79 characters. For flowing long blocks of text (docstrings or
      comments), limiting the length to 72 characters is recommended.
      
      Reports error E501.

      There are no issues that match your filters.

      Category
      Status