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

Passed

Push — main ( 6ff65b...17a183 )

by Christophe

created 2024-10-22 15:20 UTC

pandoc_latex_newpage._main.newpage() A

↳ Parent: pandoc_latex_newpage._main

Complexity

Conditions

Size

Total Lines	22
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	22
rs	10
c	0
b	0
f	0
cc	4
nop	2

#!/usr/bin/env python

"""
Pandoc filter for converting horizontal rule to new page in LaTeX.
"""
from __future__ import annotations

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

chdemko / pandoc-latex-newpage

Push — main ( 6ff65b...17a183 )

pandoc_latex_newpage._main.newpage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like