Sign upLogin

psono/psono-server

View on GitHub
Star
examples/export_as_json.py

Summary

Maintainability
D
1 day
Test Coverage

Cyclomatic complexity is too high in function filter_datastore_export. (23)
Open

def filter_datastore_export(folder, include_trash_bin_items=False):

    unwanted_folder_properties = [
        "id",
        "datastore_id",
Severity: Minor
Found in examples/export_as_json.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 export_as_json.py has 357 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
A small demo script that shows how to export the datastore (unrestricted API key)
"""
import requests
import json
Severity: Minor
Found in examples/export_as_json.py - About 4 hrs to fix

    Function get_all_secrets has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_all_secrets(datastore, token, session_secret_key, include_trash_bin_items=False):

    def handle_items(items):
        for item in items:
            if not "secret_id" in item:
    Severity: Minor
    Found in examples/export_as_json.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 filter_datastore_export has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
    Open

    def filter_datastore_export(folder, include_trash_bin_items=False):

    unwanted_folder_properties = [
        "id",
        "datastore_id",
    Severity: Minor
    Found in examples/export_as_json.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_all_shares has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_all_shares(folder, token, session_secret_key):

    def handle_share(share):
        share_read_result = api_read_share(token, session_secret_key, share['share_id'])
        share_content = None
    Severity: Minor
    Found in examples/export_as_json.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_all_shares. (11)
    Open

    def get_all_shares(folder, token, session_secret_key):

    def handle_share(share):
        share_read_result = api_read_share(token, session_secret_key, share['share_id'])
        share_content = None
    Severity: Minor
    Found in examples/export_as_json.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

    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/export_as_json.py - About 35 mins to fix

      There are no issues that match your filters.

      Category
      Status