psono/psono-server

View on GitHub
examples/create_secret_in_datastore.py

Summary

Maintainability
C
1 day
Test Coverage

File create_secret_in_datastore.py has 365 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
A small demo script that shows how to create a secret in a datastore (unrestricted API key)
"""
import uuid
import requests
Severity: Minor
Found in examples/create_secret_in_datastore.py - About 4 hrs to fix

    Cyclomatic complexity is too high in function main. (7)
    Open

    def main():
        # 1. Generate the login info including the private key for PFS
        session_private_key, client_login_info = generate_client_login_info()
    
        # 2. Send the login request and handle eventual exceptions, problems and so on ...

    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 api_create_secret has 9 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def api_create_secret(token, session_secret_key, encrypted_data, encrypted_data_nonce, link_id, parent_datastore_id, callback_url, callback_user, callback_pass):
    Severity: Major
    Found in examples/create_secret_in_datastore.py - About 1 hr to fix

      Function create_secret has 8 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def create_secret(
      Severity: Major
      Found in examples/create_secret_in_datastore.py - About 1 hr to fix

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

        def api_request(method, endpoint, data = None, token = None, session_secret_key = None):
        Severity: Minor
        Found in examples/create_secret_in_datastore.py - About 35 mins to fix

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

          def api_write_datastore(token, session_secret_key, datastore_id, encrypted_data, encrypted_data_nonce):
          Severity: Minor
          Found in examples/create_secret_in_datastore.py - About 35 mins to fix

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

            def main():
                # 1. Generate the login info including the private key for PFS
                session_private_key, client_login_info = generate_client_login_info()
            
                # 2. Send the login request and handle eventual exceptions, problems and so on ...
            Severity: Minor
            Found in examples/create_secret_in_datastore.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

            Function api_request has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            def api_request(method, endpoint, data = None, token = None, session_secret_key = None):
            
                if token:
                    headers = {'content-type': 'application/json', 'authorization': 'Token ' + token}
                else:
            Severity: Minor
            Found in examples/create_secret_in_datastore.py - About 25 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

            There are no issues that match your filters.

            Category
            Status