Sign upLogin

tum-esm/utils

View on GitHub
Star
tum_esm_utils/files.py

Summary

Maintainability
A
3 hrs
Test Coverage

Function render_directory_tree has a Cognitive Complexity of 39 (exceeds 5 allowed). Consider refactoring.
Wontfix

def render_directory_tree(
    root: str,
    ignore: list[str] = [],
    max_depth: Optional[int] = None,
    root_alias: Optional[str] = None,
Severity: Minor
Found in tum_esm_utils/files.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 read_last_n_lines has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

def read_last_n_lines(
    file_path: str,
    n: int,
    ignore_trailing_whitespace: bool = False,
) -> list[str]:
Severity: Minor
Found in tum_esm_utils/files.py - About 1 hr 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

Avoid deeply nested control flow statements.
Wontfix

                    if j == 0:
                        prefix = "├───"
                    else:
                        prefix = "│   "
                else:
Severity: Major
Found in tum_esm_utils/files.py - About 45 mins to fix

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

    def list_directory(
    Severity: Minor
    Found in tum_esm_utils/files.py - About 45 mins to fix

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

      def render_directory_tree(
      Severity: Minor
      Found in tum_esm_utils/files.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Wontfix

                            if j == 0:
                        prefix = "└───"
                    else:
                        prefix = "    "
                out += f"\n{prefix} {line}"
        Severity: Major
        Found in tum_esm_utils/files.py - About 45 mins to fix

          Avoid too many return statements within this function.
          Wontfix

              return ""
          Severity: Major
          Found in tum_esm_utils/files.py - About 30 mins to fix

            There are no issues that match your filters.

            Category
            Status