pandoc_latex_margin._main.margin() - Code Metrics - Inspection of "Merge branch 'release/1.0.0.4'" - chdemko/pandoc-latex-margin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( c5e6ce...6cb86e )

by Christophe

created 2024-08-03 12:51 UTC

pandoc_latex_margin._main.margin() C

↳ Parent: pandoc_latex_margin._main

Complexity

Conditions

Size

Total Lines	53
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	25
dl	0
loc	53
rs	5.4
c	0
b	0
f	0
cc	11
nop	2

How to fix Long Method Complexity

#!/usr/bin/env python

"""
Pandoc filter for changing margins in LaTeX.
"""
from __future__ import annotations

import re
from typing import Any

from panflute import (
    Doc,
    Element,
    MetaInlines,
    MetaList,
    RawBlock,
    RawInline,
    debug,
    run_filter,
)


# pylint:disable=line-too-long
def get_correct_margin(length: str) -> str:
    """
    Get the margin.

    Arguments
    ---------
    length
        A margin in LaTeX notation.

    Returns
    -------
    str
        A correct margin.
    """
    if (
        re.match(
            "^(-?([1-9][0-9]*)|0)(pt|mm|cm|in|ex|em|bp|pc|dd|cc|nd|nc|sp)$", length
        )
        is not None
    ):  # noqa: E501
        return length
    debug(
        "[WARNING] pandoc-latex-margin: "
        + length
        + " is not a correct LaTeX margin; using 0pt"
    )  # noqa: E501
    return "0pt"


# pylint: disable=inconsistent-return-statements
def margin(elem: Element, doc: Doc) -> list[Element] | None:
    """
    Add margin to element if needed.

    Arguments
    ---------
    elem
        A pandoc element
    doc
        The pandoc document

    Returns
    -------
    list[Element] | None
        A list of pandoc elements or None.
    """
    # Is it in the right format and is it a Div or CodeBlock?
    if doc.format in ("latex", "beamer") and elem.tag in ("Div", "CodeBlock"):
        left = None
        right = None

        # Get the classes
        classes = set(elem.classes)

        # Loop on all fontsize definition
        for definition in doc.defined:
            # Are the classes correct?
            if classes >= definition["classes"]:
                left = definition["left"]
                right = definition["right"]
                break

        # Is there a latex-margin-left attribute?
        if "latex-left-margin" in elem.attributes:
            left = get_correct_margin(elem.attributes["latex-left-margin"])

        # Is there a latex-margin-right attribute?
        if "latex-right-margin" in elem.attributes:
            right = get_correct_margin(elem.attributes["latex-right-margin"])

        if left is not None or right is not None:
            if left is None:
                left = "0pt"
            if right is None:
                right = "0pt"
            return [
                RawBlock(
                    "\\begin{pandocchangemargin}{" + left + "}{" + right + "}", "tex"
                ),  # noqa: E501
                elem,
                RawBlock("\\end{pandocchangemargin}", "tex"),
            ]
    return None


def prepare(doc: Doc) -> None:
    """
    Prepare the document.

    Arguments
    ---------
    doc
        The pandoc document
    """
    # Prepare the definitions
    doc.defined = []

    # Get the meta data
    meta = doc.get_metadata("pandoc-latex-margin")

    if isinstance(meta, list):
        # Loop on all definitions
        for definition in meta:
            # Verify the definition
            if (
                isinstance(definition, dict)
                and "classes" in definition
                and isinstance(definition["classes"], list)
            ):  # noqa: E501
                add_definition(doc.defined, definition)


def add_definition(defined: list[dict[str, Any]], definition: dict[str, Any]):
    """
    Add a definition.

    Arguments
    ---------
    defined
        A list of definition
    definition
        A new definition
    """
    # Get the classes
    classes = definition["classes"]

    # Get the left margin
    if "left" in definition:
        left = get_correct_margin(definition["left"])
    else:
        left = "0pt"

    # Get the left margin
    if "right" in definition:
        right = get_correct_margin(definition["right"])
    else:
        right = "0pt"

    # Add a definition
    defined.append({"classes": set(classes), "left": left, "right": right})


def finalize(doc: Doc) -> None:
    """
    Finalize the document.

    Arguments
    ---------
    doc
        The pandoc document
    """
    # Add header-includes if necessary
    if "header-includes" not in doc.metadata:
        doc.metadata["header-includes"] = MetaList()
    # Convert header-includes to MetaList if necessary
    elif not isinstance(doc.metadata["header-includes"], MetaList):
        doc.metadata["header-includes"] = MetaList(
            doc.metadata["header-includes"]
        )  # noqa: E501

    # Add useful LaTex definition
    doc.metadata["header-includes"].append(
        MetaInlines(
            RawInline(
                "\n".join(
                    [
                        "\\def\\pandocchangemargin#1#2{\\list{}{\\rightmargin#2\\leftmargin#1}\\item[]}",  # noqa: E501
                        "\\let\\endpandocchangemargin=\\endlist",
                        "",
                    ]
                ),
                "tex",
            )
        )
    )


def main(doc: Doc | None = None) -> Doc:
    """
    Process the transformation.

    Arguments
    ---------
    doc
        The pandoc document.

    Returns
    -------
    Doc
        The modified document.
    """
    return run_filter(margin, prepare=prepare, doc=doc, finalize=finalize)


if __name__ == "__main__":
    main()


1			#!/usr/bin/env python
2
3			"""
4			Pandoc filter for changing margins in LaTeX.
5			"""
6			from __future__ import annotations
7
8			import re
9			from typing import Any
10
11			from panflute import (
12			Doc,
13			Element,
14			MetaInlines,
15			MetaList,
16			RawBlock,
17			RawInline,
18			debug,
19			run_filter,
20			)
21
22
23			# pylint:disable=line-too-long
24			def get_correct_margin(length: str) -> str:
25			"""
26			Get the margin.
27
28			Arguments
29			---------
30			length
31			A margin in LaTeX notation.
32
33			Returns
34			-------
35			str
36			A correct margin.
37			"""
38			if (
39			re.match(
40			"^(-?([1-9][0-9]*)\|0)(pt\|mm\|cm\|in\|ex\|em\|bp\|pc\|dd\|cc\|nd\|nc\|sp)$", length
41			)
42			is not None
43			): # noqa: E501
44			return length
45			debug(
46			"[WARNING] pandoc-latex-margin: "
47			+ length
48			+ " is not a correct LaTeX margin; using 0pt"
49			) # noqa: E501
50			return "0pt"
51
52
53			# pylint: disable=inconsistent-return-statements
54			def margin(elem: Element, doc: Doc) -> list[Element] \| None:
55			"""
56			Add margin to element if needed.
57
58			Arguments
59			---------
60			elem
61			A pandoc element
62			doc
63			The pandoc document
64
65			Returns
66			-------
67			list[Element] \| None
68			A list of pandoc elements or None.
69			"""
70			# Is it in the right format and is it a Div or CodeBlock?
71			if doc.format in ("latex", "beamer") and elem.tag in ("Div", "CodeBlock"):
72			left = None
73			right = None
74
75			# Get the classes
76			classes = set(elem.classes)
77
78			# Loop on all fontsize definition
79			for definition in doc.defined:
80			# Are the classes correct?
81			if classes >= definition["classes"]:
82			left = definition["left"]
83			right = definition["right"]
84			break
85
86			# Is there a latex-margin-left attribute?
87			if "latex-left-margin" in elem.attributes:
88			left = get_correct_margin(elem.attributes["latex-left-margin"])
89
90			# Is there a latex-margin-right attribute?
91			if "latex-right-margin" in elem.attributes:
92			right = get_correct_margin(elem.attributes["latex-right-margin"])
93
94			if left is not None or right is not None:
95			if left is None:
96			left = "0pt"
97			if right is None:
98			right = "0pt"
99			return [
100			RawBlock(
101			"\\begin{pandocchangemargin}{" + left + "}{" + right + "}", "tex"
102			), # noqa: E501
103			elem,
104			RawBlock("\\end{pandocchangemargin}", "tex"),
105			]
106			return None
107
108
109			def prepare(doc: Doc) -> None:
110			"""
111			Prepare the document.
112
113			Arguments
114			---------
115			doc
116			The pandoc document
117			"""
118			# Prepare the definitions
119			doc.defined = []
120
121			# Get the meta data
122			meta = doc.get_metadata("pandoc-latex-margin")
123
124			if isinstance(meta, list):
125			# Loop on all definitions
126			for definition in meta:
127			# Verify the definition
128			if (
129			isinstance(definition, dict)
130			and "classes" in definition
131			and isinstance(definition["classes"], list)
132			): # noqa: E501
133			add_definition(doc.defined, definition)
134
135
136			def add_definition(defined: list[dict[str, Any]], definition: dict[str, Any]):
137			"""
138			Add a definition.
139
140			Arguments
141			---------
142			defined
143			A list of definition
144			definition
145			A new definition
146			"""
147			# Get the classes
148			classes = definition["classes"]
149
150			# Get the left margin
151			if "left" in definition:
152			left = get_correct_margin(definition["left"])
153			else:
154			left = "0pt"
155
156			# Get the left margin
157			if "right" in definition:
158			right = get_correct_margin(definition["right"])
159			else:
160			right = "0pt"
161
162			# Add a definition
163			defined.append({"classes": set(classes), "left": left, "right": right})
164
165
166			def finalize(doc: Doc) -> None:
167			"""
168			Finalize the document.
169
170			Arguments
171			---------
172			doc
173			The pandoc document
174			"""
175			# Add header-includes if necessary
176			if "header-includes" not in doc.metadata:
177			doc.metadata["header-includes"] = MetaList()
178			# Convert header-includes to MetaList if necessary
179			elif not isinstance(doc.metadata["header-includes"], MetaList):
180			doc.metadata["header-includes"] = MetaList(
181			doc.metadata["header-includes"]
182			) # noqa: E501
183
184			# Add useful LaTex definition
185			doc.metadata["header-includes"].append(
186			MetaInlines(
187			RawInline(
188			"\n".join(
189			[
190			"\\def\\pandocchangemargin#1#2{\\list{}{\\rightmargin#2\\leftmargin#1}\\item[]}", # noqa: E501
191			"\\let\\endpandocchangemargin=\\endlist",
192			"",
193			]
194			),
195			"tex",
196			)
197			)
198			)
199
200
201			def main(doc: Doc \| None = None) -> Doc:
202			"""
203			Process the transformation.
204
205			Arguments
206			---------
207			doc
208			The pandoc document.
209
210			Returns
211			-------
212			Doc
213			The modified document.
214			"""
215			return run_filter(margin, prepare=prepare, doc=doc, finalize=finalize)
216
217
218			if __name__ == "__main__":
219			main()
220

chdemko / pandoc-latex-margin

Push — main ( c5e6ce...6cb86e )

pandoc_latex_margin._main.margin() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like