Sign upLogin

albertyw/req-update

View on GitHub
Star
req_update/util.py

Summary

Maintainability
A
2 hrs
Test Coverage
A
100%

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

    def execute_shell(
        self,
        command: list[str],
        readonly: bool,
        cwd: Optional[Path] = None,
Severity: Minor
Found in req_update/util.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 execute_shell has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def execute_shell(
Severity: Minor
Found in req_update/util.py - About 35 mins to fix

    Avoid too many return statements within this function.
    Open

            return True
    Severity: Major
    Found in req_update/util.py - About 30 mins to fix

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

          def compare_versions(self, current: str, proposed: str) -> bool:
        """
        Take the current version and a proposed new version and return a bool
        for whether the new version is a valid upgrade.  The new version is a
        valid upgrade if the version structure matches and the version numbers
      Severity: Minor
      Found in req_update/util.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