zincware/ZnTrack

View on GitHub
zntrack/project/zntrack_project.py

Summary

Maintainability
D
1 day
Test Coverage

File zntrack_project.py has 417 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""The class for the ZnTrackProject."""

from __future__ import annotations

import contextlib
Severity: Minor
Found in zntrack/project/zntrack_project.py - About 6 hrs to fix

    Function run has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
    Open

        def run(
            self,
            eager=False,
            repro: bool = True,
            optional: dict = None,
    Severity: Minor
    Found in zntrack/project/zntrack_project.py - About 5 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 auto_remove has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        def auto_remove(self, remove_empty_dirs=True):
            """Remove all nodes from 'dvc.yaml' that are not in the graph."""
            _, dvc_node_names = get_groups(None, None)
            graph_node_names = [self.graph.nodes[x]["value"].name for x in self.graph.nodes]
    
    
    Severity: Minor
    Found in zntrack/project/zntrack_project.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

    Function run has 7 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def run(
    Severity: Major
    Found in zntrack/project/zntrack_project.py - About 50 mins to fix

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

          def group(self, *names: typing.List[str]):
              """Group nodes together.
      
              Parameters
              ----------
      Severity: Minor
      Found in zntrack/project/zntrack_project.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