Sign upLogin

JoKneeMo/sphinx-watermark

View on GitHub
Star

Showing 4 of 4 total issues

Function get_image has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

def get_image(app: Sphinx) -> tuple:
    '''Get image file.'''
    srcdir = Path(__file__).parent.resolve()
    confdir = str(app.confdir)
Severity: Minor
Found in sphinx_watermark/__init__.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 createimage has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

def createimage(app: Sphinx, srcdir: Path, buildpath: Path) -> str:
    '''Create PNG image from string.'''
    text_content = watermark_config['text']['content']

    # draw transparent background
Severity: Minor
Found in sphinx_watermark/__init__.py - About 1 hr to fix

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

    def deep_update(source, overrides):
    '''
    Update a nested dictionary or similar mapping.
    Modify ``source`` in place.
    '''
    Severity: Minor
    Found in sphinx_watermark/__init__.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

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

    def generate_watermark(app: Sphinx, env: BuildEnvironment) -> None:
    '''Generate watermark'''

    if isinstance(app.config.watermark['selector'], str):
        selector_class = str(app.config.watermark['selector'])
    Severity: Minor
    Found in sphinx_watermark/__init__.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

    Severity
    Category
    Status
    Source
    Language