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

md2conf/scanner.py

@@ -10,25 +10,17 @@ import re
 import typing
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Literal, Optional, TypeVar
+from typing import Any, Literal, TypeVar
 
 import yaml
-from strong_typing.core import JsonType
-from strong_typing.serialization import DeserializerOptions, json_to_object
 
 from .mermaid import MermaidConfigProperties
+from .serializer import JsonType, json_to_object
 
 T = TypeVar("T")
 
 
-def _json_to_object(
-    typ: type[T],
-    data: JsonType,
-) -> T:
-    return json_to_object(typ, data, options=DeserializerOptions(skip_unassigned=True))
-
-
-def extract_value(pattern: str, text: str) -> tuple[Optional[str], str]:
+def extract_value(pattern: str, text: str) -> tuple[str | None, str]:
     values: list[str] = []
 
     def _repl_func(matchobj: re.Match[str]) -> str:
@@ -40,18 +32,18 @@ def extract_value(pattern: str, text: str) -> tuple[Optional[str], str]:
     return value, text
 
 
-def extract_frontmatter_block(text: str) -> tuple[Optional[str], str]:
+def extract_frontmatter_block(text: str) -> tuple[str | None, str]:
     "Extracts the front-matter from a Markdown document as a blob of unparsed text."
 
     return extract_value(r"(?ms)\A---$(.+?)^---$", text)
 
 
-def extract_frontmatter_properties(text: str) -> tuple[Optional[dict[str, JsonType]], str]:
+def extract_frontmatter_properties(text: str) -> tuple[dict[str, JsonType] | None, str]:
     "Extracts the front-matter from a Markdown document as a dictionary."
 
     block, text = extract_frontmatter_block(text)
 
-    properties: Optional[dict[str, Any]] = None
+    properties: dict[str, Any] | None = None
     if block is not None:
         data = yaml.safe_load(block)
         if isinstance(data, dict):
@@ -77,16 +69,16 @@ class DocumentProperties:
     :param alignment: Alignment for block-level images and formulas.
     """
 
-    page_id: Optional[str]
-    space_key: Optional[str]
-    confluence_page_id: Optional[str]
-    confluence_space_key: Optional[str]
-    generated_by: Optional[str]
-    title: Optional[str]
-    tags: Optional[list[str]]
-    synchronized: Optional[bool]
-    properties: Optional[dict[str, JsonType]]
-    alignment: Optional[Literal["center", "left", "right"]]
+    page_id: str | None = None
+    space_key: str | None = None
+    confluence_page_id: str | None = None
+    confluence_space_key: str | None = None
+    generated_by: str | None = None
+    title: str | None = None
+    tags: list[str] | None = None
+    synchronized: bool | None = None
+    properties: dict[str, JsonType] | None = None
+    alignment: Literal["center", "left", "right"] | None = None
 
 
 @dataclass
@@ -105,14 +97,14 @@ class ScannedDocument:
     :param text: Text that remains after front-matter and inline properties have been extracted.
     """
 
-    page_id: Optional[str]
-    space_key: Optional[str]
-    generated_by: Optional[str]
-    title: Optional[str]
-    tags: Optional[list[str]]
-    synchronized: Optional[bool]
-    properties: Optional[dict[str, JsonType]]
-    alignment: Optional[Literal["center", "left", "right"]]
+    page_id: str | None
+    space_key: str | None
+    generated_by: str | None
+    title: str | None
+    tags: list[str] | None
+    synchronized: bool | None
+    properties: dict[str, JsonType] | None
+    alignment: Literal["center", "left", "right"] | None
     text: str
 
 
@@ -135,16 +127,16 @@ class Scanner:
         # extract 'generated-by' tag text
         generated_by, text = extract_value(r"<!--\s+generated[-_]by:\s*(.*)\s+-->", text)
 
-        title: Optional[str] = None
-        tags: Optional[list[str]] = None
-        synchronized: Optional[bool] = None
-        properties: Optional[dict[str, JsonType]] = None
-        alignment: Optional[Literal["center", "left", "right"]] = None
+        title: str | None = None
+        tags: list[str] | None = None
+        synchronized: bool | None = None
+        properties: dict[str, JsonType] | None = None
+        alignment: Literal["center", "left", "right"] | None = None
 
         # extract front-matter
         data, text = extract_frontmatter_properties(text)
         if data is not None:
-            p = _json_to_object(DocumentProperties, data)
+            p = json_to_object(DocumentProperties, data)
             page_id = page_id or p.confluence_page_id or p.page_id
             space_key = space_key or p.confluence_space_key or p.space_key
             generated_by = generated_by or p.generated_by
@@ -176,8 +168,8 @@ class MermaidProperties:
     :param config: Configuration options for rendering.
     """
 
-    title: Optional[str] = None
-    config: Optional[MermaidConfigProperties] = None
+    title: str | None = None
+    config: MermaidConfigProperties | None = None
 
 
 class MermaidScanner:
@@ -203,7 +195,7 @@ class MermaidScanner:
 
         properties, _ = extract_frontmatter_properties(content)
         if properties is not None:
-            front_matter = _json_to_object(MermaidProperties, properties)
+            front_matter = json_to_object(MermaidProperties, properties)
             config = front_matter.config or MermaidConfigProperties()
 
             return MermaidProperties(title=front_matter.title, config=config)

md2conf/serializer.py

@@ -0,0 +1,52 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
+from typing import TypeVar
+
+from cattrs.preconf.json import make_converter
+
+JsonType = None | bool | int | float | str | dict[str, "JsonType"] | list["JsonType"]
+JsonComposite = dict[str, "JsonType"] | list["JsonType"]
+
+T = TypeVar("T")
+
+
+_converter = make_converter(forbid_extra_keys=False)
+
+
+@_converter.register_structure_hook
+def json_type_structure_hook(value: JsonType, cls: type[JsonType]) -> JsonType:
+    return value
+
+
+@_converter.register_structure_hook
+def json_composite_structure_hook(value: JsonComposite, cls: type[JsonComposite]) -> JsonComposite:
+    return value
+
+
+def json_to_object(typ: type[T], data: JsonType) -> T:
+    """
+    Converts a raw JSON object to a structured object, validating input data.
+
+    :param typ: Target structured type.
+    :param data: Source data as a JSON object.
+    :returns: A valid object instance of the expected type.
+    """
+
+    return _converter.structure(data, typ)
+
+
+def object_to_json_payload(data: object) -> bytes:
+    """
+    Converts a structured object to a JSON string encoded in UTF-8.
+
+    :param data: Object to convert to a JSON string.
+    :returns: JSON string encoded in UTF-8.
+    """
+
+    return _converter.dumps(data).encode("utf-8")

md2conf/toc.py

@@ -7,7 +7,6 @@ Copyright 2022-2025, Levente Hunyadi
 """
 
 from dataclasses import dataclass
-from typing import Optional
 
 
 @dataclass(eq=True)
@@ -24,7 +23,7 @@ class TableOfContentsEntry:
     text: str
     children: list["TableOfContentsEntry"]
 
-    def __init__(self, level: int, text: str, children: Optional[list["TableOfContentsEntry"]] = None) -> None:
+    def __init__(self, level: int, text: str, children: list["TableOfContentsEntry"] | None = None) -> None:
         self.level = level
         self.text = text
         self.children = children or []
@@ -74,7 +73,7 @@ class TableOfContentsBuilder:
         # push new level onto the stack
         self._stack.append(item)
 
-    def get_title(self) -> Optional[str]:
+    def get_title(self) -> str | None:
         """
         Returns a proposed document title.
 

md2conf/xml.py

@@ -6,7 +6,7 @@ Copyright 2022-2025, Levente Hunyadi
 :see: https://github.com/hunyadi/md2conf
 """
 
-from typing import Iterable, Optional
+from typing import Iterable
 
 import lxml.etree as ET
 
@@ -39,7 +39,7 @@ class ElementComparator:
     skip_attributes: set[str]
     skip_elements: set[str]
 
-    def __init__(self, *, skip_attributes: Optional[Iterable[str]] = None, skip_elements: Optional[Iterable[str]] = None):
+    def __init__(self, *, skip_attributes: Iterable[str] | None = None, skip_elements: Iterable[str] | None = None):
         """
         Initializes a new element tree comparator.
 
@@ -81,12 +81,10 @@ class ElementComparator:
         # compare children recursively
         if len(e1) != len(e2):
             return False
-        return all(self.is_equal(c1, c2) for c1, c2 in zip(e1, e2))
+        return all(self.is_equal(c1, c2) for c1, c2 in zip(e1, e2, strict=True))
 
 
-def is_xml_equal(
-    tree1: ElementType, tree2: ElementType, *, skip_attributes: Optional[Iterable[str]] = None, skip_elements: Optional[Iterable[str]] = None
-) -> bool:
+def is_xml_equal(tree1: ElementType, tree2: ElementType, *, skip_attributes: Iterable[str] | None = None, skip_elements: Iterable[str] | None = None) -> bool:
     """
     Compare two XML documents for equivalence, ignoring leading/trailing whitespace differences and attribute definition order.
 

markdown_to_confluence-0.4.7.dist-info/RECORD

@@ -1,34 +0,0 @@
-markdown_to_confluence-0.4.7.dist-info/licenses/LICENSE,sha256=56L-Y0dyZwyVlINRJRz3PNw-ka-oLVaAq-7d8zo6qlc,1077
-md2conf/__init__.py,sha256=3R4-8WktKk6Q4JGEjAHqEU8S4u_w39RdcpBl-yL-0Tc,402
-md2conf/__main__.py,sha256=pp3Zi60gmhXRqK0uoR4lZMVLlOO8ryAmk8UMPiI-Cew,11527
-md2conf/api.py,sha256=uEPMcR4B-07MMFM96m92z7Znnj7pzhkLLAGcOIseERY,41398
-md2conf/collection.py,sha256=EobgMRJgkYloWlY03NZJ52MRC_SGLpTVCHkltDbQyt0,837
-md2conf/converter.py,sha256=wghwaa_07cN-xXY1DIOJgy6VJjfnJWDjbT4aB5NAL08,68845
-md2conf/csf.py,sha256=rugs3qC2aJQCJSTczeBw9WhqSZZtMq14LjwT0V1b6Hc,6476
-md2conf/domain.py,sha256=rN6QSuoP3JMj-WE8BAggHqHEO8nJbnQDf0b0uhStNZk,2221
-md2conf/drawio.py,sha256=0FoCl0BWxyxO-KLPlDZPyYvSTRpgu9Z6yFKl10TGGMI,8594
-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=i5C_ZqsBG_Df1bNoMJpAKpiYMFcMEn5aoAv6bdSsE1k,7674
-md2conf/local.py,sha256=mvp2kA_eo6JUQ_rlM7zDdEFgBPVxMr3VKP_X1nsLjHE,3747
-md2conf/markdown.py,sha256=czabU17tUfhSX1JQGiI_TrMrTmtoVThOwFu_To_Oi_w,3176
-md2conf/matcher.py,sha256=8g2yiKXfEkYJPIvKD2cswTG9BxFY24BtVcPgKaEVAs8,6812
-md2conf/mermaid.py,sha256=hGrITJVvhHprjQVoezQ1nQeo6a_lqNihF8L-oJ4t5rc,2633
-md2conf/metadata.py,sha256=LzZM-oPNnzCULmLhF516tPlV5zZBknccwMHt8Nan-xg,1007
-md2conf/processor.py,sha256=G1icOxYsPAOjK4fnVdA-vwTsRiZMBpEAmMPOwfOebtQ,9733
-md2conf/publisher.py,sha256=V4TzmrJ5LAv61EPpDYUGWv_6KHb-BcDjtYdByNt6su8,8665
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/scanner.py,sha256=O4iOgmSqTe1CYgmdaiF1QyAESzA4SRNEKVY9gOodXDY,7035
-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=SpFfcfZm1BPbB4zZM2UC1K-GkzHRhFiotiPMPt5_XPI,5541
-markdown_to_confluence-0.4.7.dist-info/METADATA,sha256=iHeyUxkIuoI9_g9dvCLlxC4BCqnH3JStloGAfP-bWsY,34628
-markdown_to_confluence-0.4.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_to_confluence-0.4.7.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.4.7.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.4.7.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.4.7.dist-info/RECORD,,