Sign upLogin

q-optimize/c3

View on GitHub
Star
c3/utils/qt_utils.py

Summary

Maintainability
C
1 day
Test Coverage

File qt_utils.py has 471 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""Useful functions to get basis vectors and matrices of the right size."""
import itertools
import numpy as np
from typing import List
from scipy.linalg import block_diag as scipy_block_diag
Severity: Minor
Found in c3/utils/qt_utils.py - About 7 hrs to fix

    Cyclomatic complexity is too high in function pauli_basis. (8)
    Open

    def pauli_basis(dims=[2]):
    """
    Qutip implementation of the Pauli basis.

    Parameters
    Severity: Minor
    Found in c3/utils/qt_utils.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 two_qubit_gate_tomography. (8)
    Open

    def two_qubit_gate_tomography(gate):
    """
    Sequences to generate tomography for evaluating a two qubit gate.
    """
    # THE 4 GATES
    Severity: Minor
    Found in c3/utils/qt_utils.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 two_qubit_gate_tomography has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

    def two_qubit_gate_tomography(gate):
    """
    Sequences to generate tomography for evaluating a two qubit gate.
    """
    # THE 4 GATES
    Severity: Minor
    Found in c3/utils/qt_utils.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

    Rename function "single_length_RB" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
    Invalid

    def single_length_RB(
    Severity: Major
    Found in c3/utils/qt_utils.py by sonar-python

    Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

    Noncompliant Code Example

    With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

    def MyFunction(a,b):
    ...

    Compliant Solution

    def my_function(a,b):
    ...

    Rename function "T1_sequence" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
    Invalid

    def T1_sequence(length, target):
    Severity: Major
    Found in c3/utils/qt_utils.py by sonar-python

    Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

    Noncompliant Code Example

    With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

    def MyFunction(a,b):
    ...

    Compliant Solution

    def my_function(a,b):
    ...

    Rename function "inverseC" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
    Invalid

    def inverseC(sequence):
    Severity: Major
    Found in c3/utils/qt_utils.py by sonar-python

    Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

    Noncompliant Code Example

    With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

    def MyFunction(a,b):
    ...

    Compliant Solution

    def my_function(a,b):
    ...

    There are no issues that match your filters.

    Category
    Status