LiberTEM/LiberTEM

View on GitHub
src/libertem/api.py

Summary

Maintainability
F
4 days
Test Coverage

File api.py has 1211 lines of code (exceeds 400 allowed). Consider refactoring.
Open

from typing import (
    TYPE_CHECKING, Any, List, Optional, Union, Iterable, Generator, Coroutine,
    AsyncGenerator, overload, Tuple
)
from typing_extensions import Literal
Severity: Major
Found in src/libertem/api.py - About 2 days to fix

    Cyclomatic complexity is too high in method _prepare_plots. (12)
    Open

        def _prepare_plots(self, udfs, dataset, roi, plots):
            runner_cls = self.executor.get_udf_runner()
            dry_results = runner_cls.dry_run(udfs, dataset, roi)
    
            # cases to consider:
    Severity: Minor
    Found in src/libertem/api.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 _run_sync has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

        def _run_sync(
            self,
            dataset: DataSet,
            udf: Union[UDF, Iterable[UDF]],
            roi: RoiT,
    Severity: Minor
    Found in src/libertem/api.py - About 2 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 method _run_sync. (9)
    Open

        def _run_sync(
            self,
            dataset: DataSet,
            udf: Union[UDF, Iterable[UDF]],
            roi: RoiT,
    Severity: Minor
    Found in src/libertem/api.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 create_com_analysis. (8)
    Open

        def create_com_analysis(self, dataset: DataSet, cx: int = None, cy: int = None,
                                mask_radius: float = None, flip_y: bool = False,
                                mask_radius_inner: float = None,
                                scan_rotation: float = 0.0) -> COMAnalysis:
            """
    Severity: Minor
    Found in src/libertem/api.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 make_with. (7)
    Open

        @classmethod
        def make_with(cls, executor_spec: ExecutorSpecType, *args, **kwargs) -> 'Context':
            '''
            Create a Context with a specific kind of executor.
    
    
    Severity: Minor
    Found in src/libertem/api.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 run_udf has 9 arguments (exceeds 8 allowed). Consider refactoring.
    Open

        def run_udf(
    Severity: Major
    Found in src/libertem/api.py - About 35 mins to fix

      Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
      Open

          def _run_sync(
      Severity: Major
      Found in src/libertem/api.py - About 35 mins to fix

        Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
        Open

            def _run_async(
        Severity: Major
        Found in src/libertem/api.py - About 35 mins to fix

          Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
          Open

              def _run_sync(
          Severity: Major
          Found in src/libertem/api.py - About 35 mins to fix

            Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
            Open

                def _run_sync(
            Severity: Major
            Found in src/libertem/api.py - About 35 mins to fix

              Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
              Open

                  def _run_async(
              Severity: Major
              Found in src/libertem/api.py - About 35 mins to fix

                Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
                Open

                    def _run_sync(
                Severity: Major
                Found in src/libertem/api.py - About 35 mins to fix

                  Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
                  Open

                      def _run_sync(
                  Severity: Major
                  Found in src/libertem/api.py - About 35 mins to fix

                    Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                    Open

                        def _run_async(
                    Severity: Major
                    Found in src/libertem/api.py - About 35 mins to fix

                      Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                      Open

                          def _run_async(
                      Severity: Major
                      Found in src/libertem/api.py - About 35 mins to fix

                        Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                        Open

                            def _run_async(
                        Severity: Major
                        Found in src/libertem/api.py - About 35 mins to fix

                          Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
                          Open

                              def _run_sync(
                          Severity: Major
                          Found in src/libertem/api.py - About 35 mins to fix

                            Function run_udf_iter has 9 arguments (exceeds 8 allowed). Consider refactoring.
                            Open

                                def run_udf_iter(
                            Severity: Major
                            Found in src/libertem/api.py - About 35 mins to fix

                              Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                              Open

                                  def _run_async(
                              Severity: Major
                              Found in src/libertem/api.py - About 35 mins to fix

                                Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
                                Open

                                    def _run_sync(
                                Severity: Major
                                Found in src/libertem/api.py - About 35 mins to fix

                                  Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                                  Open

                                      def _run_async(
                                  Severity: Major
                                  Found in src/libertem/api.py - About 35 mins to fix

                                    Function create_radial_fourier_analysis has 9 arguments (exceeds 8 allowed). Consider refactoring.
                                    Open

                                        def create_radial_fourier_analysis(self, dataset: DataSet, cx: float = None, cy: float = None,
                                    Severity: Major
                                    Found in src/libertem/api.py - About 35 mins to fix

                                      Function _run_sync has 9 arguments (exceeds 8 allowed). Consider refactoring.
                                      Open

                                          def _run_sync(
                                      Severity: Major
                                      Found in src/libertem/api.py - About 35 mins to fix

                                        Function _run_async has 9 arguments (exceeds 8 allowed). Consider refactoring.
                                        Open

                                            def _run_async(
                                        Severity: Major
                                        Found in src/libertem/api.py - About 35 mins to fix

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

                                              def make_with(cls, executor_spec: ExecutorSpecType, *args, **kwargs) -> 'Context':
                                                  '''
                                                  Create a Context with a specific kind of executor.
                                          
                                                  .. versionadded:: 0.9.0
                                          Severity: Minor
                                          Found in src/libertem/api.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 create_com_analysis has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                                          Open

                                              def create_com_analysis(self, dataset: DataSet, cx: int = None, cy: int = None,
                                                                      mask_radius: float = None, flip_y: bool = False,
                                                                      mask_radius_inner: float = None,
                                                                      scan_rotation: float = 0.0) -> COMAnalysis:
                                                  """
                                          Severity: Minor
                                          Found in src/libertem/api.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

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

                                              def _prepare_plots(self, udfs, dataset, roi, plots):
                                                  runner_cls = self.executor.get_udf_runner()
                                                  dry_results = runner_cls.dry_run(udfs, dataset, roi)
                                          
                                                  # cases to consider:
                                          Severity: Minor
                                          Found in src/libertem/api.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