Sign upLogin

bitranox/rst_include

View on GitHub
Star
rst_include/rst_include.py

Summary

Maintainability
A
3 hrs
Test Coverage
F
25%

Function import_module_from_file has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

def import_module_from_file(module_fullpath: Union[pathlib.Path, str], reload: bool = False):  # type: ignore
    """
    TODO : replace with lib_import when avail maybe take from pycharm
    """
    module_fullpath = pathlib.Path(module_fullpath)
Severity: Minor
Found in rst_include/rst_include.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 replace has 9 arguments (exceeds 4 allowed). Consider refactoring.
Open

def replace(
Severity: Major
Found in rst_include/rst_include.py - About 1 hr to fix

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

    def include(source: str, target: str, quiet: bool, inplace: bool, source_encoding: str, target_encoding: str) -> None:
    Severity: Minor
    Found in rst_include/rst_include.py - About 45 mins to fix

      There are no issues that match your filters.

      Category
      Status