bitranox/rst_include

View on GitHub
rst_include/libs/lib_get_include_options.py

Summary

Maintainability
A
3 hrs
Test Coverage
A
97%

File lib_get_include_options.py has 279 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# STDLIB
from typing import List, Tuple, Union

# OWN
import lib_log_utils
Severity: Minor
Found in rst_include/libs/lib_get_include_options.py - About 2 hrs to fix

    Function get_include_filename has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_include_filename(block: Block) -> Tuple[pathlib.Path, pathlib.Path]:
        """
        >>> block = lib_test.get_test_block_ok()
    
        >>> # test include Filename OK
    Severity: Minor
    Found in rst_include/libs/lib_get_include_options.py - About 35 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