blockdiag/sphinxcontrib-nwdiag

View on GitHub

Showing 44 of 44 total issues

File nwdiag.py has 259 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
"""
    nwdiag.sphinx_ext
    ~~~~~~~~~~~~~~~~~~~~

Severity: Minor
Found in sphinxcontrib/nwdiag.py - About 2 hrs to fix

    File rackdiag.py has 259 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    # -*- coding: utf-8 -*-
    """
        rackdiag.sphinx_ext
        ~~~~~~~~~~~~~~~~~~~~
    
    
    Severity: Minor
    Found in sphinxcontrib/rackdiag.py - About 2 hrs to fix

      File packetdiag.py has 259 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      # -*- coding: utf-8 -*-
      """
          packetdiag.sphinx_ext
          ~~~~~~~~~~~~~~~~~~~~~
      
      
      Severity: Minor
      Found in sphinxcontrib/packetdiag.py - About 2 hrs to fix

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

        def on_doctree_resolved(self, doctree, docname):
            if self.builder.format in ('html', 'slides'):
                return
        
            try:
        Severity: Minor
        Found in sphinxcontrib/rackdiag.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 on_doctree_resolved has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

        def on_doctree_resolved(self, doctree, docname):
            if self.builder.format in ('html', 'slides'):
                return
        
            try:
        Severity: Minor
        Found in sphinxcontrib/nwdiag.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 on_doctree_resolved has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

        def on_doctree_resolved(self, doctree, docname):
            if self.builder.format in ('html', 'slides'):
                return
        
            try:
        Severity: Minor
        Found in sphinxcontrib/packetdiag.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 resolve_reference has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

        def resolve_reference(builder, href):
            if href is None:
                return None
        
            pattern = re.compile("^:ref:`(.+?)`", re.UNICODE)
        Severity: Minor
        Found in sphinxcontrib/rackdiag.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 resolve_reference has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

        def resolve_reference(builder, href):
            if href is None:
                return None
        
            pattern = re.compile("^:ref:`(.+?)`", re.UNICODE)
        Severity: Minor
        Found in sphinxcontrib/nwdiag.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 resolve_reference has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

        def resolve_reference(builder, href):
            if href is None:
                return None
        
            pattern = re.compile("^:ref:`(.+?)`", re.UNICODE)
        Severity: Minor
        Found in sphinxcontrib/packetdiag.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 get_image_format_for has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_image_format_for(builder):
            if builder.format in ('html', 'slides'):
                image_format = builder.config.rackdiag_html_image_format.upper()
            elif builder.format == 'latex':
                if builder.config.rackdiag_tex_image_format:
        Severity: Minor
        Found in sphinxcontrib/rackdiag.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 get_image_format_for has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_image_format_for(builder):
            if builder.format in ('html', 'slides'):
                image_format = builder.config.nwdiag_html_image_format.upper()
            elif builder.format == 'latex':
                if builder.config.nwdiag_tex_image_format:
        Severity: Minor
        Found in sphinxcontrib/nwdiag.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 get_image_format_for has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_image_format_for(builder):
            if builder.format in ('html', 'slides'):
                image_format = builder.config.packetdiag_html_image_format.upper()
            elif builder.format == 'latex':
                if builder.config.packetdiag_tex_image_format:
        Severity: Minor
        Found in sphinxcontrib/packetdiag.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 html_render_png has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_render_png(self, node):
            image = node.to_drawer('PNG', self.builder)
            if not os.path.isfile(image.filename):
                image.draw()
                image.save()
        Severity: Minor
        Found in sphinxcontrib/packetdiag.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 html_visit_packetdiag has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_visit_packetdiag(self, node):
            try:
                image_format = get_image_format_for(self.builder)
                if image_format.upper() == 'SVG':
                    html_render_svg(self, node)
        Severity: Minor
        Found in sphinxcontrib/packetdiag.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 html_render_png has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_render_png(self, node):
            image = node.to_drawer('PNG', self.builder)
            if not os.path.isfile(image.filename):
                image.draw()
                image.save()
        Severity: Minor
        Found in sphinxcontrib/nwdiag.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 html_visit_nwdiag has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_visit_nwdiag(self, node):
            try:
                image_format = get_image_format_for(self.builder)
                if image_format.upper() == 'SVG':
                    html_render_svg(self, node)
        Severity: Minor
        Found in sphinxcontrib/nwdiag.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 html_visit_rackdiag has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_visit_rackdiag(self, node):
            try:
                image_format = get_image_format_for(self.builder)
                if image_format.upper() == 'SVG':
                    html_render_svg(self, node)
        Severity: Minor
        Found in sphinxcontrib/rackdiag.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 html_render_png has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def html_render_png(self, node):
            image = node.to_drawer('PNG', self.builder)
            if not os.path.isfile(image.filename):
                image.draw()
                image.save()
        Severity: Minor
        Found in sphinxcontrib/rackdiag.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

        Avoid too many return statements within this function.
        Open

                    return None
        Severity: Major
        Found in sphinxcontrib/rackdiag.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                      return None
          Severity: Major
          Found in sphinxcontrib/nwdiag.py - About 30 mins to fix
            Severity
            Category
            Status
            Source
            Language