msgspec-xml 0.1.0__tar.gz → 0.2.0__tar.gz

msgspec_xml-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,94 @@
+repos:
+  - repo: local
+    hooks:
+      - id: toml-sort
+        args:
+          - "--in-place"
+        entry: toml-sort
+        exclude: "uv.lock|pylock.toml"
+        language: system
+        name: toml sort
+        types:
+          - toml
+      - id: mdformat
+        args:
+          - "--number"
+          - "--wrap=keep"
+        entry: mdformat
+        language: system
+        name: mdformat
+        types:
+          - markdown
+      - id: ruff-check
+        entry: ruff check .
+        language: system
+        name: ruff check
+        pass_filenames: false
+        types:
+          - python
+      - id: ruff-format
+        entry: ruff format .
+        language: system
+        name: ruff format
+        pass_filenames: false
+        types:
+          - python
+      - id: ty
+        entry: ty check .
+        language: system
+        name: ruff check
+        pass_filenames: false
+        types:
+          - python
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: forbid-submodules
+  - repo: builtin
+    hooks:
+      - id: check-added-large-files
+        args:
+          - "--enforce-all"
+      - id: check-case-conflict
+      # - id: check-executables-have-shebangs
+      # - id: check-illegal-windows-names
+      - id: check-json
+      # - id: check-json5
+      - id: check-merge-conflict
+        args:
+          - "--assume-in-merge"
+      - id: check-shebang-scripts-are-executable
+      # - id: check-symlinks
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-xml
+      - id: check-yaml
+        args:
+          - "--allow-multiple-documents"
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+        exclude_types:
+          - json
+          - svg
+          - xml
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args:
+          - "--fix=auto"
+      - id: pretty-format-json
+        args:
+          - "--autofix"
+          - "--indent=2"
+          - "--no-ensure-ascii"
+      - id: trailing-whitespace
+        args:
+          - "--markdown-linebreak-ext=md"
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

msgspec_xml-0.2.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: msgspec-xml
+Version: 0.2.0
+Summary: XML Serialization/Deserialization using msgspec
+Project-URL: Homepage, https://pypi.org/project/msgspec-xml
+Project-URL: Issues, https://codefloe.com/buriedincode/msgspec-xml/issues
+Project-URL: Source, https://codefloe.com/buriedincode/msgspec-xml
+Author-email: BuriedInCode <buriedincode@duckpond.nz>
+Maintainer-email: BuriedInCode <buriedincode@duckpond.nz>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: msgspec>=0.21.0
+Description-Content-Type: text/markdown
+
+# msgspec-xml
+
+[![PyPI - Python](https://img.shields.io/pypi/pyversions/msgspec-xml.svg?logo=Python&label=Python&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - Status](https://img.shields.io/pypi/status/msgspec-xml.svg?logo=Python&label=Status&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - Version](https://img.shields.io/pypi/v/msgspec-xml.svg?logo=Python&label=Version&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - License](https://img.shields.io/pypi/l/msgspec-xml.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/MIT)
+
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
+
+[![status-badge](https://ci.codefloe.com/api/v1/badges/1329/status.svg)](https://ci.codefloe.com/repos/1329)
+
+XML Serialization/Deserialization using [msgspec](https://github.com/msgspec/msgspec).
+
+## Installation
+
+```sh
+pdm add msgspec-xml
+```
+
+## Usage
+
+```python
+from decimal import Decimal
+from typing import Annotated
+
+from msgspec import Struct
+from msgspec_xml import XML, decode, encode
+
+
+class Price(Struct):
+    currency: Annotated[str, XML(attr=True)]
+    cost: Annotated[Decimal, XML(text=True)]
+
+
+class Book(Struct, rename="pascal"):
+    title: str
+    prices: Annotated[list[Price], XML(wrapper="Prices", tag="Price")]
+
+
+book = Book(
+    title="Example Book",
+    prices=[
+        Price(currency="USD", cost=Decimal("3.99")),
+        Price(currency="GBP", cost=Decimal("1.51")),
+    ],
+)
+
+xml = encode(book)
+# <Book>
+#   <Title>Example Book</Title>
+#   <Prices>
+#     <Price currency="USD">3.99</Price>
+#     <Price currency="GBP">1.51</Price>
+#   </Prices>
+# </Book>
+
+decoded = decode(xml, type_=Book)
+
+assert decoded == book
+```
+
+## Socials
+
+[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

msgspec_xml-0.2.0/README.md

@@ -0,0 +1,66 @@
+# msgspec-xml
+
+[![PyPI - Python](https://img.shields.io/pypi/pyversions/msgspec-xml.svg?logo=Python&label=Python&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - Status](https://img.shields.io/pypi/status/msgspec-xml.svg?logo=Python&label=Status&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - Version](https://img.shields.io/pypi/v/msgspec-xml.svg?logo=Python&label=Version&style=flat-square)](https://pypi.org/p/msgspec-xml/)
+[![PyPI - License](https://img.shields.io/pypi/l/msgspec-xml.svg?logo=Python&label=License&style=flat-square)](https://opensource.org/licenses/MIT)
+
+[![prek](https://img.shields.io/badge/prek-enabled-informational?logo=prek&style=flat-square)](https://github.com/j178/prek)
+[![Ruff](https://img.shields.io/badge/Ruff-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/badge/ty-enabled-informational?logo=ruff&style=flat-square)](https://github.com/astral-sh/ty)
+
+[![status-badge](https://ci.codefloe.com/api/v1/badges/1329/status.svg)](https://ci.codefloe.com/repos/1329)
+
+XML Serialization/Deserialization using [msgspec](https://github.com/msgspec/msgspec).
+
+## Installation
+
+```sh
+pdm add msgspec-xml
+```
+
+## Usage
+
+```python
+from decimal import Decimal
+from typing import Annotated
+
+from msgspec import Struct
+from msgspec_xml import XML, decode, encode
+
+
+class Price(Struct):
+    currency: Annotated[str, XML(attr=True)]
+    cost: Annotated[Decimal, XML(text=True)]
+
+
+class Book(Struct, rename="pascal"):
+    title: str
+    prices: Annotated[list[Price], XML(wrapper="Prices", tag="Price")]
+
+
+book = Book(
+    title="Example Book",
+    prices=[
+        Price(currency="USD", cost=Decimal("3.99")),
+        Price(currency="GBP", cost=Decimal("1.51")),
+    ],
+)
+
+xml = encode(book)
+# <Book>
+#   <Title>Example Book</Title>
+#   <Prices>
+#     <Price currency="USD">3.99</Price>
+#     <Price currency="GBP">1.51</Price>
+#   </Prices>
+# </Book>
+
+decoded = decode(xml, type_=Book)
+
+assert decoded == book
+```
+
+## Socials
+
+[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)

msgspec_xml-0.2.0/msgspec_xml/__init__.py

@@ -0,0 +1,6 @@
+__all__ = ["XML", "Decoder", "Encoder", "decode", "encode"]
+__version__ = "0.2.0"
+
+from msgspec_xml.decoder import Decoder, decode
+from msgspec_xml.encoder import Encoder, encode
+from msgspec_xml.metadata import XML

{msgspec_xml-0.1.0 → msgspec_xml-0.2.0}/msgspec_xml/decoder.py

@@ -1,18 +1,20 @@
 __all__ = ["Decoder", "decode"]
 
 from typing import Any, Generic, TypeVar
+from xml.etree import ElementTree as ET
 from xml.etree.ElementTree import Element
 
-from defusedxml import ElementTree
 from msgspec import Struct, convert
 from msgspec.structs import FieldInfo, fields
 
 from msgspec_xml.introspection import (
     FieldType,
     attribute_name,
+    class_namespaces,
     element_tag,
     inspect_annotation,
     item_tag,
+    wrapper_tag,
 )
 
 T = TypeVar("T", bound=Struct)
@@ -24,7 +26,7 @@ class Decoder(Generic[T]):
         self._type = type_
 
     def decode(self, xml: str | bytes) -> T:
-        root = ElementTree.fromstring(xml)
+        root = ET.fromstring(xml)  # noqa: S314
         data = _decode_struct(element=root, cls=self._type)
         return convert(data, type=self._type, strict=False)
 
@@ -34,25 +36,29 @@ def decode(xml: str | bytes, type_: type[T]) -> T:
 
 
 def _decode_struct(element: Element, cls: type[Struct]) -> dict[str, Any]:
+    namespaces = class_namespaces(cls=cls)
     result: dict[str, Any] = {}
     for field in fields(cls):
         info = inspect_annotation(annotation=field.type)
-        value = _decode_field(element=element, field=field, info=info)
+        value = _decode_field(element=element, field=field, info=info, namespaces=namespaces)
         if value is not _MISSING:
             result[field.encode_name] = value
     return result
 
 
-def _decode_field(element: Element, field: FieldInfo, info: FieldType) -> Any:  # noqa: ANN401
+def _decode_field(
+    element: Element, field: FieldInfo, info: FieldType, namespaces: dict[str, str]
+) -> Any:  # noqa: ANN401
     xml = info.xml
     if xml.attr:
-        name = attribute_name(field=field, info=info)
+        name = attribute_name(field=field, info=info, namespaces=namespaces)
         return element.attrib.get(name, _MISSING)
     if xml.text:
         return (element.text or "").strip()
     if info.item is not None:
-        return _decode_list(element=element, field=field, info=info)
-    child = element.find(element_tag(field=field, info=info))
+        return _decode_list(element=element, field=field, info=info, namespaces=namespaces)
+    tag = element_tag(field=field, info=info, namespaces=namespaces)
+    child = element.find(tag)
     if child is None:
         return _MISSING
     if info.is_struct:
@@ -60,13 +66,16 @@ def _decode_field(element: Element, field: FieldInfo, info: FieldType) -> Any:
     return (child.text or "").strip()
 
 
-def _decode_list(element: Element, field: FieldInfo, info: FieldType) -> list[Any]:
+def _decode_list(
+    element: Element, field: FieldInfo, info: FieldType, namespaces: dict[str, str]
+) -> list[Any]:
     item = info.item
     assert item is not None  # noqa: S101
-    parent = element.find(info.xml.wrapper) if info.xml.wrapper else element
+    wrapper = wrapper_tag(info=info, namespaces=namespaces)
+    parent = element.find(wrapper) if wrapper else element
     if parent is None:
         return []
-    tag = item_tag(field=field, info=info)
+    tag = item_tag(field=field, info=info, namespaces=namespaces)
     return [_decode_item(element=child, item=item) for child in parent.findall(tag)]
 
 

msgspec_xml-0.2.0/msgspec_xml/encoder.py

@@ -0,0 +1,109 @@
+__all__ = ["Encoder", "encode"]
+
+from xml.etree import ElementTree as ET
+from xml.etree.ElementTree import Element
+
+from msgspec import Struct, to_builtins
+from msgspec.structs import FieldInfo, fields
+
+from msgspec_xml.introspection import (
+    FieldType,
+    attribute_name,
+    class_namespaces,
+    class_tag,
+    element_tag,
+    inspect_annotation,
+    item_tag,
+    wrapper_tag,
+)
+
+
+class Encoder:
+    def __init__(
+        self,
+        indent: int | None = None,
+        xml_declaration: bool = False,
+        short_empty_elements: bool = True,
+    ) -> None:
+        if indent is not None and indent < 0:
+            raise ValueError("'indent' must be a non-negative integer")
+        self.indent = indent
+        self.xml_declaration = xml_declaration
+        self.short_empty_elements = short_empty_elements
+
+    def encode(self, obj: Struct) -> bytes:
+        root = _encode_struct(obj=obj, tag=class_tag(cls=type(obj)))
+        if self.indent is not None:
+            ET.indent(root, space=" " * self.indent)
+        return ET.tostring(
+            root,
+            encoding="UTF-8",
+            xml_declaration=self.xml_declaration,
+            short_empty_elements=self.short_empty_elements,
+        )
+
+
+def encode(
+    obj: Struct,
+    indent: int | None = None,
+    xml_declaration: bool = False,
+    short_empty_elements: bool = True,
+) -> bytes:
+    return Encoder(
+        indent=indent, xml_declaration=xml_declaration, short_empty_elements=short_empty_elements
+    ).encode(obj=obj)
+
+
+def _encode_struct(obj: Struct, tag: str) -> Element:
+    cls = type(obj)
+    namespaces = class_namespaces(cls=cls)
+    for prefix, uri in namespaces.items():
+        ET.register_namespace(prefix, uri)
+    element = ET.Element(tag)
+    for field in fields(cls):
+        value = getattr(obj, field.name)
+        if value is None:
+            continue
+        info = inspect_annotation(annotation=field.type)
+        _encode_field(element=element, field=field, info=info, value=value, namespaces=namespaces)
+    return element
+
+
+def _encode_field(
+    element: Element, field: FieldInfo, info: FieldType, value: object, namespaces: dict[str, str]
+) -> None:
+    xml = info.xml
+    if xml.attr:
+        name = attribute_name(field=field, info=info, namespaces=namespaces)
+        element.set(name, _stringify(value=value))
+    elif xml.text:
+        element.text = _stringify(value)
+    elif info.item is not None:
+        _encode_list(element=element, field=field, info=info, value=value, namespaces=namespaces)  # ty: ignore[invalid-argument-type]
+    elif info.is_struct:
+        struct_tag = element_tag(field=field, info=info, namespaces=namespaces)
+        element.append(_encode_struct(obj=value, tag=struct_tag))  # ty: ignore[invalid-argument-type]
+    else:
+        tag = element_tag(field=field, info=info, namespaces=namespaces)
+        child = ET.SubElement(element, tag)
+        child.text = _stringify(value)
+
+
+def _encode_list(
+    element: Element, field: FieldInfo, info: FieldType, value: list, namespaces: dict[str, str]
+) -> None:
+    item = info.item
+    assert item is not None  # noqa: S101
+    wrapper = wrapper_tag(info=info, namespaces=namespaces)
+    parent = ET.SubElement(element, wrapper) if wrapper else element
+    tag = item_tag(field=field, info=info, namespaces=namespaces)
+    for item_value in value:
+        if item.is_struct:
+            parent.append(_encode_struct(obj=item_value, tag=tag))
+        else:
+            child = ET.SubElement(parent, tag)
+            child.text = _stringify(item_value)
+
+
+def _stringify(value: object) -> str:
+    return str(to_builtins(value))

{msgspec_xml-0.1.0 → msgspec_xml-0.2.0}/msgspec_xml/introspection.py

@@ -1,10 +1,13 @@
 __all__ = [
     "FieldType",
     "attribute_name",
+    "class_namespaces",
     "class_tag",
     "element_tag",
     "inspect_annotation",
     "item_tag",
+    "qualify",
+    "wrapper_tag",
 ]
 
 from types import NoneType
@@ -45,29 +48,59 @@ def class_tag(cls: type[Struct]) -> str:
     return cls.__name__
 
 
-def attribute_name(field: FieldInfo, info: FieldType) -> str:
-    return info.xml.tag or field.encode_name
+def class_namespaces(cls: type[Struct]) -> dict[str, str]:
+    return getattr(cls, "__namespaces__", {})
 
 
-def element_tag(field: FieldInfo, info: FieldType) -> str:
+def attribute_name(field: FieldInfo, info: FieldType, namespaces: dict[str, str]) -> str:
+    name = info.xml.tag or field.encode_name
+    return qualify(tag=name, ns=_resolve_ns(prefix=info.xml.ns, namespaces=namespaces))
+
+
+def element_tag(field: FieldInfo, info: FieldType, namespaces: dict[str, str]) -> str:
     if info.xml.tag:
-        return info.xml.tag
-    if info.is_struct:
-        return class_tag(cls=info.type)
-    return field.encode_name
+        name = info.xml.tag
+    elif info.is_struct:
+        name = class_tag(cls=info.type)
+    else:
+        name = field.encode_name
+    return qualify(tag=name, ns=_resolve_ns(prefix=info.xml.ns, namespaces=namespaces))
 
 
-def item_tag(field: FieldInfo, info: FieldType) -> str:
+def item_tag(field: FieldInfo, info: FieldType, namespaces: dict[str, str]) -> str:
     item = info.item
     if item is None:
         raise TypeError("item_tag() requires a list field")
+    prefix = item.xml.ns if item.xml.ns is not None else info.xml.ns
     if item.xml.tag:
-        return item.xml.tag
-    if info.xml.tag:
-        return info.xml.tag
-    if item.is_struct:
-        return class_tag(cls=item.type)
-    return field.encode_name
+        name = item.xml.tag
+    elif info.xml.tag:
+        name = info.xml.tag
+    elif item.is_struct:
+        name = class_tag(cls=item.type)
+    else:
+        name = field.encode_name
+    return qualify(tag=name, ns=_resolve_ns(prefix=prefix, namespaces=namespaces))
+
+
+def wrapper_tag(info: FieldType, namespaces: dict[str, str]) -> str | None:
+    if info.xml.wrapper is None:
+        return None
+    return qualify(tag=info.xml.wrapper, ns=_resolve_ns(prefix=info.xml.ns, namespaces=namespaces))
+
+
+def qualify(tag: str, ns: str | None) -> str:
+    return f"{{{ns}}}{tag}" if ns else tag
+
+
+def _resolve_ns(prefix: str | None, namespaces: dict[str, str]) -> str | None:
+    if prefix is None:
+        return None
+    if prefix not in namespaces:
+        raise ValueError(
+            f"Namespace prefix {prefix!r} is not declared in this Struct's __namespaces__."
+        )
+    return namespaces[prefix]
 
 
 def _split_xml(annotation: Any) -> tuple[Any, XML]:  # noqa: ANN401

{msgspec_xml-0.1.0 → msgspec_xml-0.2.0}/msgspec_xml/metadata.py

@@ -8,6 +8,7 @@ class XML(Struct, frozen=True, forbid_unknown_fields=True):
     wrapper: str | None = None
     attr: bool = False
     text: bool = False
+    ns: str | None = None
 
     def __post_init__(self) -> None:
         if self.attr and self.text:
@@ -16,10 +17,14 @@ class XML(Struct, frozen=True, forbid_unknown_fields=True):
             raise ValueError("Wrapper elements cannot be used on XML attributes.")
         if self.wrapper is not None and self.text:
             raise ValueError("Wrapper elements cannot be used on XML text.")
+        if self.ns is not None and self.text:
+            raise ValueError("Namespaces cannot be used on XML text.")
         if self.tag == "":
             raise ValueError("tag cannot be empty.")
         if self.wrapper == "":
             raise ValueError("wrapper cannot be empty.")
+        if self.ns == "":
+            raise ValueError("ns cannot be empty.")
 
     @property
     def is_element(self) -> bool: