Sign upLogin

dmyersturnbull/pocketutils

View on GitHub
Star
src/pocketutils/tools/io_tools.py

Summary

Maintainability
B
4 hrs
Test Coverage

File io_tools.py has 252 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# SPDX-FileCopyrightText: Copyright 2020-2023, Contributors to pocketutils
# SPDX-PackageHomePage: https://github.com/dmyersturnbull/pocketutils
# SPDX-License-Identifier: Apache-2.0
"""
Severity: Minor
Found in src/pocketutils/tools/io_tools.py - About 2 hrs to fix

    Function get_encoding has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_encoding(self: Self, encoding: str = "utf-8") -> str:
        """
        Returns a text encoding from a more flexible string.
        Ignores hyphens and lowercases the string.
        Permits these nonstandard shorthands:
    Severity: Minor
    Found in src/pocketutils/tools/io_tools.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

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

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

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

          def hash_digest(
        self: Self,
        data: SupportsBytes | str,
        algorithm: HashAlgorithm,
        *,
      Severity: Minor
      Found in src/pocketutils/tools/io_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