LiberTEM/LiberTEM

View on GitHub
src/libertem/analysis/gridmatching.py

Summary

Maintainability
A
3 hrs
Test Coverage

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

        assert all(len(centers) == len(other) for other in [refineds, peak_values, peak_elevations])

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

        assert len(indices) == len(self)

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

        assert len(ref) == len(weighs)

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

            assert len(correlation_result.centers) == len(selector)

Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.
Open

    assert ref.shape == peaks.shape

File gridmatching.py has 414 lines of code (exceeds 400 allowed). Consider refactoring.
Open

import numpy as np
from libertem.utils import calc_coords, within_frame


class CorrelationResult:
Severity: Minor
Found in src/libertem/analysis/gridmatching.py - About 2 hrs to fix

    Cyclomatic complexity is too high in method calc_coords. (8)
    Open

        def calc_coords(self, indices=None, drop_zero=False, frame_shape=None, r=0):
            '''
            Shorthand to calculate peak coordinates.
    
            Parameters
    Severity: Minor
    Found in src/libertem/analysis/gridmatching.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 method derive. (6)
    Open

        def derive(self, selector=None, zero=None, a=None, b=None, indices=None):
            if zero is None:
                zero = self.zero
            if a is None:
                a = self.a
    Severity: Minor
    Found in src/libertem/analysis/gridmatching.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 calc_coords has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        def calc_coords(self, indices=None, drop_zero=False, frame_shape=None, r=0):
            '''
            Shorthand to calculate peak coordinates.
    
            Parameters
    Severity: Minor
    Found in src/libertem/analysis/gridmatching.py - About 55 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

    Method "fastmatch" has 8 parameters, which is greater than the 7 authorized.
    Open

        def fastmatch(self, centers, zero, a, b, refineds=None, peak_values=None, peak_elevations=None):

    A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

    Noncompliant Code Example

    With a maximum number of 4 parameters:

    def do_something(param1, param2, param3, param4, param5):
        ...
    

    Compliant Solution

    def do_something(param1, param2, param3, param4):
        ...
    

    Either remove or fill this block of code.
    Open

            pass

    Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.

    Noncompliant Code Example

    for i in range(3):
        pass
    

    Exceptions

    When a block contains a comment, this block is not considered to be empty.

    Either remove or fill this block of code.
    Open

                pass

    Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.

    Noncompliant Code Example

    for i in range(3):
        pass
    

    Exceptions

    When a block contains a comment, this block is not considered to be empty.

    There are no issues that match your filters.

    Category
    Status