dmyersturnbull/pocketutils

View on GitHub
src/pocketutils/tools/path_tools.py

Summary

Maintainability
B
5 hrs
Test Coverage

Function sanitize_node has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    def sanitize_node(
        self: Self,
        bit: PurePath | str,
        *,
        is_file: bool | None = None,
Severity: Minor
Found in src/pocketutils/tools/path_tools.py - About 3 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 sanitize_node has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def sanitize_node(
Severity: Minor
Found in src/pocketutils/tools/path_tools.py - About 45 mins to fix

    Function sanitize_path has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def sanitize_path(
    Severity: Minor
    Found in src/pocketutils/tools/path_tools.py - About 45 mins to fix

      Function sanitize_nodes has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def sanitize_nodes(
      Severity: Minor
      Found in src/pocketutils/tools/path_tools.py - About 35 mins to fix

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

            def sanitize_nodes(
                self: Self,
                bits: Sequence[PurePath | str],
                *,
                is_file: bool | None = None,
        Severity: Minor
        Found in src/pocketutils/tools/path_tools.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