pandoc_latex_newpage._main.prepare() - Code Metrics - Inspection of "Update dependencies" - chdemko/pandoc-latex-newpage - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 670678...eac4b4 )

by Christophe

created 2024-08-03 15:19 UTC

pandoc_latex_newpage._main.prepare() A

↳ Parent: pandoc_latex_newpage._main

Complexity

Conditions

Size

Total Lines	18
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	8
dl	0
loc	18
rs	9.3333
c	0
b	0
f	0
cc	5
nop	1

#!/usr/bin/env python

"""
Pandoc filter for converting horizontal rule to new page in LaTeX.
"""

from panflute import (
    Doc,
    Element,
    HorizontalRule,
    MetaBool,
    MetaMap,
    RawBlock,
    run_filter,
)


def newpage(elem: Element, doc: Doc) -> RawBlock | None:
    r"""
    Replace HorizontalRule by a \clearpage or a \cleardoublepage.

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

    Returns
    -------
    RawBlock | None
        A RawBlock or None.
    """
    # Is it in the right format and is it an HorizontalRule?
    if doc.format == "latex" and isinstance(elem, HorizontalRule):
        if doc.double:
            return RawBlock("\\cleardoublepage", "tex")
        return RawBlock("\\clearpage", "tex")
    return None


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

    Arguments
    ---------
    doc
        pandoc document
    """
    doc.double = True

    if (
        "pandoc-latex-newpage" in doc.metadata.content
        and isinstance(doc.metadata.content["pandoc-latex-newpage"], MetaMap)
        and "double" in doc.metadata.content["pandoc-latex-newpage"]
        and isinstance(doc.metadata.content["pandoc-latex-newpage"]["double"], MetaBool)
    ):
        doc.double = doc.metadata.content["pandoc-latex-newpage"]["double"].boolean


def main(doc: Doc | None = None) -> Doc:
    """
    Convert the pandoc document.

    Arguments
    ---------
    doc
        pandoc document

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


if __name__ == "__main__":
    main()


1			#!/usr/bin/env python
2
3			"""
4			Pandoc filter for converting horizontal rule to new page in LaTeX.
5			"""
6
7			from panflute import (
8			Doc,
9			Element,
10			HorizontalRule,
11			MetaBool,
12			MetaMap,
13			RawBlock,
14			run_filter,
15			)
16
17
18			def newpage(elem: Element, doc: Doc) -> RawBlock \| None:
19			r"""
20			Replace HorizontalRule by a \clearpage or a \cleardoublepage.
21
22			Arguments
23			---------
24			elem
25			A pandoc element
26			doc
27			pandoc document
28
29			Returns
30			-------
31			RawBlock \| None
32			A RawBlock or None.
33			"""
34			# Is it in the right format and is it an HorizontalRule?
35			if doc.format == "latex" and isinstance(elem, HorizontalRule):
36			if doc.double:
37			return RawBlock("\\cleardoublepage", "tex")
38			return RawBlock("\\clearpage", "tex")
39			return None
40
41
42			def prepare(doc: Doc) -> None:
43			"""
44			Prepare document.
45
46			Arguments
47			---------
48			doc
49			pandoc document
50			"""
51			doc.double = True
52
53			if (
54			"pandoc-latex-newpage" in doc.metadata.content
55			and isinstance(doc.metadata.content["pandoc-latex-newpage"], MetaMap)
56			and "double" in doc.metadata.content["pandoc-latex-newpage"]
57			and isinstance(doc.metadata.content["pandoc-latex-newpage"]["double"], MetaBool)
58			):
59			doc.double = doc.metadata.content["pandoc-latex-newpage"]["double"].boolean
60
61
62			def main(doc: Doc \| None = None) -> Doc:
63			"""
64			Convert the pandoc document.
65
66			Arguments
67			---------
68			doc
69			pandoc document
70
71			Returns
72			-------
73			Doc
74			The modified document.
75			"""
76			return run_filter(newpage, prepare=prepare, doc=doc)
77
78
79			if __name__ == "__main__":
80			main()
81

chdemko / pandoc-latex-newpage

Push — develop ( 670678...eac4b4 )

pandoc_latex_newpage._main.prepare() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like