Sign upLogin

chdemko/pandoc-latex-tip

View on GitHub
Star
pandoc_latex_tip.py

Summary

Maintainability
B
6 hrs
Test Coverage

File pandoc_latex_tip.py has 448 lines of code (exceeds 250 allowed). Consider refactoring.
Wontfix

##!/usr/bin/env python

"""
Pandoc filter for adding tip in LaTeX.
"""
Severity: Minor
Found in pandoc_latex_tip.py - About 6 hrs to fix

    Function _get_icons has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Wontfix

    def _get_icons(doc, definition, key_icons, color, collection, version, variant, link):
    # Test the icons definition
    if key_icons in definition:
        icons = []
        # pylint: disable=invalid-name
    Severity: Minor
    Found in pandoc_latex_tip.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_prefix has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def _get_prefix(position, odd=True):
    if position == "right":
        if odd:
            return "\\pandoclatextipoddright"
        return "\\pandoclatextipevenright"
    Severity: Minor
    Found in pandoc_latex_tip.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 _add_latex has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Wontfix

    def _add_latex(elem, latex):
    if bool(latex):
        # Is it a Span or a Code?
        if isinstance(elem, (Span, Code)):
            return [elem, RawInline(latex, "tex")]
    Severity: Minor
    Found in pandoc_latex_tip.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_icons has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def _get_icons(doc, definition, key_icons, color, collection, version, variant, link):
    Severity: Major
    Found in pandoc_latex_tip.py - About 1 hr to fix

      Function _tip has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Wontfix

      def _tip(elem, doc):
    # Is it in the right format and is it a Span, Div?
    if doc.format in ("latex", "beamer") and elem.tag in (
        "Span",
        "Div",
      Severity: Minor
      Found in pandoc_latex_tip.py - About 55 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 _create_images has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Wontfix

      def _create_images(doc, icons, size):
    # Generate the LaTeX image code
    images = []

    for icon in icons:
      Severity: Minor
      Found in pandoc_latex_tip.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 _add_icon has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Wontfix

      def _add_icon(doc, icons, icon):
    if "name" not in icon:
        # Bad formed icon
        debug("[WARNING] pandoc-latex-tip: Bad formed icon")
        return
      Severity: Minor
      Found in pandoc_latex_tip.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 pandoc_latex_tip.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return "\\pandoclatextipoddouter"
        Severity: Major
        Found in pandoc_latex_tip.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return "\\pandoclatextipevenouter"
          Severity: Major
          Found in pandoc_latex_tip.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                        return "\\pandoclatextipoddinner"
            Severity: Major
            Found in pandoc_latex_tip.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return "\\pandoclatextipeveninner"
              Severity: Major
              Found in pandoc_latex_tip.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                        return "\\pandoclatextipoddleft"
                Severity: Major
                Found in pandoc_latex_tip.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                      return "\\pandoclatextipevenleft"
                  Severity: Major
                  Found in pandoc_latex_tip.py - About 30 mins to fix

                    There are no issues that match your filters.

                    Category
                    Status