markdown-to-confluence 0.4.6__py3-none-any.whl → 0.4.7__py3-none-any.whl

md2conf/csf.py

@@ -14,6 +14,8 @@ from typing import Callable, TypeVar
 import lxml.etree as ET
 from lxml.builder import ElementMaker
 
+ElementType = ET._Element  # pyright: ignore [reportPrivateUsage]
+
 # XML namespaces typically associated with Confluence Storage Format documents
 _namespaces = {
     "ac": "http://atlassian.com/content",
@@ -54,7 +56,7 @@ def with_entities(func: Callable[[Path], R]) -> R:
         return func(dtd_path)
 
 
-def _elements_from_strings(dtd_path: Path, items: list[str]) -> ET._Element:
+def _elements_from_strings(dtd_path: Path, items: list[str]) -> ElementType:
     """
     Creates an XML document tree from XML fragment strings.
 
@@ -90,7 +92,7 @@ def _elements_from_strings(dtd_path: Path, items: list[str]) -> ET._Element:
         raise ParseError() from ex
 
 
-def elements_from_strings(items: list[str]) -> ET._Element:
+def elements_from_strings(items: list[str]) -> ElementType:
     """
     Creates a Confluence Storage Format XML document tree from XML fragment strings.
 
@@ -103,7 +105,7 @@ def elements_from_strings(items: list[str]) -> ET._Element:
     return with_entities(lambda dtd_path: _elements_from_strings(dtd_path, items))
 
 
-def elements_from_string(content: str) -> ET._Element:
+def elements_from_string(content: str) -> ElementType:
     """
     Creates a Confluence Storage Format XML document tree from an XML string.
 
@@ -135,7 +137,7 @@ def content_to_string(content: str) -> str:
     return with_entities(lambda dtd_path: _content_to_string(dtd_path, content))
 
 
-def elements_to_string(root: ET._Element) -> str:
+def elements_to_string(root: ElementType) -> str:
     """
     Converts a Confluence Storage Format element tree into an XML string to push to Confluence REST API.
 
@@ -151,11 +153,11 @@ def elements_to_string(root: ET._Element) -> str:
         raise ValueError("expected: Confluence content")
 
 
-def is_block_like(elem: ET._Element) -> bool:
+def is_block_like(elem: ElementType) -> bool:
     return elem.tag in ["div", "li", "ol", "p", "pre", "td", "th", "ul"]
 
 
-def normalize_inline(elem: ET._Element) -> None:
+def normalize_inline(elem: ElementType) -> None:
     """
     Ensures that inline elements are direct children of an eligible block element.
 
@@ -179,7 +181,7 @@ def normalize_inline(elem: ET._Element) -> None:
     if not is_block_like(elem):
         raise ValueError(f"expected: block element; got: {elem.tag!s}")
 
-    contents: list[ET._Element] = []
+    contents: list[ElementType] = []
 
     paragraph = HTML.p()
     contents.append(paragraph)

md2conf/domain.py

@@ -33,6 +33,8 @@ class ConfluenceDocumentOptions:
     :param render_latex: Whether to pre-render LaTeX formulas into PNG/SVG images.
     :param diagram_output_format: Target image format for diagrams.
     :param webui_links: When true, convert relative URLs to Confluence Web UI links.
+    :param alignment: Alignment for block-level images and formulas.
+    :param use_panel: Whether to transform admonitions and alerts into a Confluence custom panel.
     """
 
     ignore_invalid_url: bool = False
@@ -46,3 +48,5 @@ class ConfluenceDocumentOptions:
     render_latex: bool = False
     diagram_output_format: Literal["png", "svg"] = "png"
     webui_links: bool = False
+    alignment: Literal["center", "left", "right"] = "center"
+    use_panel: bool = False

md2conf/drawio.py

@@ -20,6 +20,8 @@ from urllib.parse import unquote_to_bytes
 
 import lxml.etree as ET
 
+ElementType = ET._Element  # pyright: ignore [reportPrivateUsage]
+
 LOGGER = logging.getLogger(__name__)
 
 
@@ -49,7 +51,7 @@ def inflate(data: bytes) -> bytes:
     return zlib.decompress(data, -zlib.MAX_WBITS)
 
 
-def decompress_diagram(xml_data: typing.Union[bytes, str]) -> ET._Element:
+def decompress_diagram(xml_data: typing.Union[bytes, str]) -> ElementType:
     """
     Decompresses the text content of the `<diagram>` element in a draw.io XML document.
 
@@ -129,7 +131,7 @@ def decompress_diagram(xml_data: typing.Union[bytes, str]) -> ET._Element:
     return root
 
 
-def extract_xml_from_png(png_data: bytes) -> ET._Element:
+def extract_xml_from_png(png_data: bytes) -> ElementType:
     """
     Extracts an editable draw.io diagram from a PNG file.
 
@@ -190,7 +192,7 @@ def extract_xml_from_png(png_data: bytes) -> ET._Element:
     raise DrawioError("not a PNG file made with draw.io")
 
 
-def extract_xml_from_svg(svg_data: bytes) -> ET._Element:
+def extract_xml_from_svg(svg_data: bytes) -> ElementType:
     """
     Extracts an editable draw.io diagram from an SVG file.
 

md2conf/latex.py

@@ -40,7 +40,7 @@ else:
 
     matplotlib.rcParams["mathtext.fontset"] = "cm"  # change font to "Computer Modern"
 
-    LATEX_ENABLED = True
+    LATEX_ENABLED = True  # pyright: ignore[reportConstantRedefinition]
 
     def _render_latex(expression: str, f: BinaryIO, *, format: Literal["png", "svg"], dpi: int, font_size: int) -> None:
         # create a figure with no axis
@@ -219,7 +219,7 @@ def _get_png_dimensions(source_file: BinaryIO) -> tuple[int, int]:
     if ihdr.name != b"IHDR":
         raise ValueError(f"expected: IHDR chunk; got: {ihdr.name!r}")
 
-    (width, height, bit_depth, color_type, compression, filter, interlace) = unpack(">IIBBBBB", ihdr.data)
+    (width, height, bit_depth, color_type, compression, filter, interlace) = unpack(">IIBBBBB", ihdr.data)  # pyright: ignore[reportUnusedVariable]
     return width, height
 
 

md2conf/matcher.py

@@ -105,10 +105,8 @@ class MatcherOptions:
 def _entry_name_dir(entry: Union[Entry, os.DirEntry[str]]) -> tuple[str, bool]:
     if isinstance(entry, Entry):
         return entry.name, entry.is_dir
-    elif isinstance(entry, os.DirEntry):
-        return entry.name, entry.is_dir()
     else:
-        raise NotImplementedError("type match not exhaustive")
+        return entry.name, entry.is_dir()
 
 
 class Matcher:

md2conf/processor.py

@@ -140,7 +140,7 @@ class Processor:
         self._update_page(page_id, document, path)
 
     @abstractmethod
-    def _synchronize_tree(self, node: DocumentNode, page_id: Optional[ConfluencePageID]) -> None:
+    def _synchronize_tree(self, root: DocumentNode, root_id: Optional[ConfluencePageID]) -> None:
         """
         Creates the cross-reference index and synchronizes the directory tree structure with the Confluence page hierarchy.
 

md2conf/publisher.py

@@ -141,7 +141,7 @@ class SynchronizingProcessor(Processor):
         title = None
         if document.title is not None:
             meta = self.page_metadata.get(path)
-            if meta is not None and meta.space_key is not None and meta.title != document.title:
+            if meta is not None and meta.title != document.title:
                 conflicting_page_id = self.api.page_exists(document.title, space_id=self.api.space_key_to_id(meta.space_key))
                 if conflicting_page_id is None:
                     title = document.title

md2conf/scanner.py

@@ -7,9 +7,10 @@ Copyright 2022-2025, Levente Hunyadi
 """
 
 import re
+import typing
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Optional, TypeVar
+from typing import Any, Literal, Optional, TypeVar
 
 import yaml
 from strong_typing.core import JsonType
@@ -45,7 +46,7 @@ def extract_frontmatter_block(text: str) -> tuple[Optional[str], str]:
     return extract_value(r"(?ms)\A---$(.+?)^---$", text)
 
 
-def extract_frontmatter_properties(text: str) -> tuple[Optional[dict[str, Any]], str]:
+def extract_frontmatter_properties(text: str) -> tuple[Optional[dict[str, JsonType]], str]:
     "Extracts the front-matter from a Markdown document as a dictionary."
 
     block, text = extract_frontmatter_block(text)
@@ -54,7 +55,7 @@ def extract_frontmatter_properties(text: str) -> tuple[Optional[dict[str, Any]],
     if block is not None:
         data = yaml.safe_load(block)
         if isinstance(data, dict):
-            properties = data
+            properties = typing.cast(dict[str, JsonType], data)
 
     return properties, text
 
@@ -73,6 +74,7 @@ class DocumentProperties:
     :param tags: A list of tags (content labels) extracted from front-matter.
     :param synchronized: True if the document content is parsed and synchronized with Confluence.
     :param properties: A dictionary of key-value pairs extracted from front-matter to apply as page properties.
+    :param alignment: Alignment for block-level images and formulas.
     """
 
     page_id: Optional[str]
@@ -84,6 +86,7 @@ class DocumentProperties:
     tags: Optional[list[str]]
     synchronized: Optional[bool]
     properties: Optional[dict[str, JsonType]]
+    alignment: Optional[Literal["center", "left", "right"]]
 
 
 @dataclass
@@ -98,6 +101,7 @@ class ScannedDocument:
     :param tags: A list of tags (content labels) extracted from front-matter.
     :param synchronized: True if the document content is parsed and synchronized with Confluence.
     :param properties: A dictionary of key-value pairs extracted from front-matter to apply as page properties.
+    :param alignment: Alignment for block-level images and formulas.
     :param text: Text that remains after front-matter and inline properties have been extracted.
     """
 
@@ -108,6 +112,7 @@ class ScannedDocument:
     tags: Optional[list[str]]
     synchronized: Optional[bool]
     properties: Optional[dict[str, JsonType]]
+    alignment: Optional[Literal["center", "left", "right"]]
     text: str
 
 
@@ -134,6 +139,7 @@ class Scanner:
         tags: Optional[list[str]] = None
         synchronized: Optional[bool] = None
         properties: Optional[dict[str, JsonType]] = None
+        alignment: Optional[Literal["center", "left", "right"]] = None
 
         # extract front-matter
         data, text = extract_frontmatter_properties(text)
@@ -146,6 +152,7 @@ class Scanner:
             tags = p.tags
             synchronized = p.synchronized
             properties = p.properties
+            alignment = p.alignment
 
         return ScannedDocument(
             page_id=page_id,
@@ -155,6 +162,7 @@ class Scanner:
             tags=tags,
             synchronized=synchronized,
             properties=properties,
+            alignment=alignment,
             text=text,
         )
 
@@ -193,7 +201,7 @@ class MermaidScanner:
         ```
         """
 
-        properties, text = extract_frontmatter_properties(content)
+        properties, _ = extract_frontmatter_properties(content)
         if properties is not None:
             front_matter = _json_to_object(MermaidProperties, properties)
             config = front_matter.config or MermaidConfigProperties()

md2conf/xml.py

@@ -10,8 +10,11 @@ from typing import Iterable, Optional
 
 import lxml.etree as ET
 
+ElementType = ET._Element  # pyright: ignore [reportPrivateUsage]
+AttribType = ET._Attrib  # pyright: ignore[reportPrivateUsage]
 
-def _attrs_equal_excluding(attrs1: ET._Attrib, attrs2: ET._Attrib, exclude: set[str]) -> bool:
+
+def _attrs_equal_excluding(attrs1: AttribType, attrs2: AttribType, exclude: set[str]) -> bool:
     """
     Compares two dictionary objects, excluding keys in the skip set.
 
@@ -47,7 +50,7 @@ class ElementComparator:
         self.skip_attributes = set(skip_attributes) if skip_attributes else set()
         self.skip_elements = set(skip_elements) if skip_elements else set()
 
-    def is_equal(self, e1: ET._Element, e2: ET._Element) -> bool:
+    def is_equal(self, e1: ElementType, e2: ElementType) -> bool:
         """
         Recursively check if two XML elements are equal.
         """
@@ -82,7 +85,7 @@ class ElementComparator:
 
 
 def is_xml_equal(
-    tree1: ET._Element, tree2: ET._Element, *, skip_attributes: Optional[Iterable[str]] = None, skip_elements: Optional[Iterable[str]] = None
+    tree1: ElementType, tree2: ElementType, *, skip_attributes: Optional[Iterable[str]] = None, skip_elements: Optional[Iterable[str]] = None
 ) -> bool:
     """
     Compare two XML documents for equivalence, ignoring leading/trailing whitespace differences and attribute definition order.
@@ -99,13 +102,13 @@ def is_xml_equal(
     return ElementComparator(skip_attributes=skip_attributes, skip_elements=skip_elements).is_equal(tree1, tree2)
 
 
-def element_to_text(node: ET._Element) -> str:
+def element_to_text(node: ElementType) -> str:
     "Returns all text contained in an element as a concatenated string."
 
     return "".join(node.itertext()).strip()
 
 
-def unwrap_substitute(name: str, root: ET._Element) -> None:
+def unwrap_substitute(name: str, root: ElementType) -> None:
     """
     Substitutes all occurrences of an element with its contents.
 

markdown_to_confluence-0.4.6.dist-info/RECORD

@@ -1,34 +0,0 @@
-markdown_to_confluence-0.4.6.dist-info/licenses/LICENSE,sha256=56L-Y0dyZwyVlINRJRz3PNw-ka-oLVaAq-7d8zo6qlc,1077
-md2conf/__init__.py,sha256=-uM9--fczADkWeiQ7PSL-iFlkeCxy7lnd2KhxG3yFso,402
-md2conf/__main__.py,sha256=LiJ06zVr3wroMSLgkMf65ehraqJZgktvuN66dkBJaOI,10929
-md2conf/api.py,sha256=RcltUP8KhrhrUuVg7SqBqp-AvGZymjMXtUxpzRPGGGc,40847
-md2conf/collection.py,sha256=EobgMRJgkYloWlY03NZJ52MRC_SGLpTVCHkltDbQyt0,837
-md2conf/converter.py,sha256=olL2FSop5TFxMfVXU4zWk1Lj_fwGN0c73F2ZYv8PU6s,63250
-md2conf/csf.py,sha256=VlB0rYRZ8u-bNDdzEvNy2XrJSxaL-MW_hVRHxcoBluU,6409
-md2conf/domain.py,sha256=NpeGl-I9_rgKYCKKZT1Ygg3nl5U0-jJHYYrzDVpMSGQ,1965
-md2conf/drawio.py,sha256=3RJFFzlp5a7SNVNCnwO_HCDfMy0DqYQeXfHWRPInOVE,8527
-md2conf/emoticon.py,sha256=P2L5oQvnRXeVifJQ3sJ2Ck-6ptbxumq2vsT-rM0W0Ms,484
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/environment.py,sha256=RC1jY_TKVbOv2bJxXn27Fj4fNWzyoNUQt6ltgUyVQAQ,3987
-md2conf/extra.py,sha256=VuMxuOnnC2Qwy6y52ukIxsaYhrZArRqMmRHRE4QZl8g,687
-md2conf/latex.py,sha256=yAClNclguPv-xWBMVWbqvYWLbyUHBVufc2aUzwyKHew,7586
-md2conf/local.py,sha256=mvp2kA_eo6JUQ_rlM7zDdEFgBPVxMr3VKP_X1nsLjHE,3747
-md2conf/markdown.py,sha256=czabU17tUfhSX1JQGiI_TrMrTmtoVThOwFu_To_Oi_w,3176
-md2conf/matcher.py,sha256=m5rZjYZSjhKfdeKS8JdPq7cG861Mc6rVZBkrIOZTHGE,6916
-md2conf/mermaid.py,sha256=hGrITJVvhHprjQVoezQ1nQeo6a_lqNihF8L-oJ4t5rc,2633
-md2conf/metadata.py,sha256=LzZM-oPNnzCULmLhF516tPlV5zZBknccwMHt8Nan-xg,1007
-md2conf/processor.py,sha256=62Yr33uNVEb11Q7SQ8m1KJHMoJozBPSzeUJQ0fwHig0,9733
-md2conf/publisher.py,sha256=uSyYb9SOQzMkSGKKQqsoOL5S2CfkVIEbXaCx6CY0Suw,8696
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/scanner.py,sha256=APtENrcEgbslVfjjUnUyB81QpOmPoJgwfww0G7onNOY,6578
-md2conf/text.py,sha256=fHOrUaPXAjE4iRhHqFq-CiI-knpo4wvyHCWp0crewqA,1736
-md2conf/toc.py,sha256=hpqqDbFgNJg5-ul8qWjOglI3Am0sbwR-TLwGN5G9Qo0,2447
-md2conf/uri.py,sha256=KbLBdRFtZTQTZd8b4j0LtE8Pb68Ly0WkemF4iW-EAB4,1158
-md2conf/xml.py,sha256=Ybf3Ctt6EurVvel0eb1KezF33_e_cDpMwlUqHi4kNLE,5411
-markdown_to_confluence-0.4.6.dist-info/METADATA,sha256=zgUR1Bz7EnzbcAkZVPVKqL123Y0L4NeWzbhxyq5yVH4,34414
-markdown_to_confluence-0.4.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_to_confluence-0.4.6.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.4.6.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.4.6.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.4.6.dist-info/RECORD,,