ulikoehler/UliEngineering

View on GitHub
UliEngineering/SignalProcessing/Filter.py

Summary

Maintainability
A
3 hrs
Test Coverage

File Filter.py has 256 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
A high-level API for digital filters:

Severity: Minor
Found in UliEngineering/SignalProcessing/Filter.py - About 2 hrs to fix

    Function _check_filter_type has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def _check_filter_type(btype, freqs):
        if btype == "lowpass" or btype == "highpass":
            if not isinstance(freqs, numbers.Number):
                raise ValueError("Pass-type {0} requires a single critical frequency, not {1}".format(btype, freqs))
        elif btype == "bandpass" or btype == "bandstop":
    Severity: Minor
    Found in UliEngineering/SignalProcessing/Filter.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 _normalize_frequencies has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def _normalize_frequencies(freqs):
        # Normalize freqs: Allow [1.0] instead of 1.0
        if freqs is None:
            raise ValueError("Critical frequencies may not be None")
        # Allow multiple frequencies, but only 1 or 2
    Severity: Minor
    Found in UliEngineering/SignalProcessing/Filter.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

    There are no issues that match your filters.

    Category
    Status