msgspec-xml 0.1.0__tar.gz

msgspec_xml-0.1.0/.gitattributes

@@ -0,0 +1,116 @@
+# Common settings that generally should always be used with your language specific settings
+
+# Auto detect text files and perform LF normalization
+*          text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+# Documents
+*.bibtex   text diff=bibtex
+*.doc      diff=astextplain
+*.DOC      diff=astextplain
+*.docx     diff=astextplain
+*.DOCX     diff=astextplain
+*.dot      diff=astextplain
+*.DOT      diff=astextplain
+*.pdf      diff=astextplain
+*.PDF      diff=astextplain
+*.rtf      diff=astextplain
+*.RTF      diff=astextplain
+*.md       text diff=markdown
+*.mdx      text diff=markdown
+*.tex      text diff=tex
+*.adoc     text
+*.textile  text
+*.mustache text
+*.csv      text eol=crlf
+*.tab      text
+*.tsv      text
+*.txt      text
+*.sql      text
+*.epub     diff=astextplain
+
+# Graphics
+*.png      binary
+*.jpg      binary
+*.jpeg     binary
+*.gif      binary
+*.tif      binary
+*.tiff     binary
+*.ico      binary
+# SVG treated as text by default.
+*.svg      text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg    binary
+*.eps      binary
+
+# Scripts
+*.bash     text eol=lf
+*.fish     text eol=lf
+*.sh       text eol=lf
+*.zsh      text eol=lf
+# These are explicitly windows files and should use crlf
+*.bat      text eol=crlf
+*.cmd      text eol=crlf
+*.ps1      text eol=crlf
+
+# Serialisation
+*.json     text
+*.toml     text
+*.xml      text
+*.yaml     text
+*.yml      text
+
+# Archives
+*.7z       binary
+*.gz       binary
+*.tar      binary
+*.tgz      binary
+*.zip      binary
+
+# Text files where line endings should be preserved
+*.patch    -text
+
+#
+# Exclude files from exporting
+#
+
+.gitattributes export-ignore
+.gitignore     export-ignore
+.gitkeep       export-ignore
+# Apply override to all files in the directory
+*.md linguist-detectable
+# Basic .gitattributes for a python repo.
+
+# Source files
+# ============
+*.pxd    text diff=python
+*.py     text diff=python
+*.py3    text diff=python
+*.pyw    text diff=python
+*.pyx    text diff=python
+*.pyz    text diff=python
+*.pyi    text diff=python
+
+# Binary files
+# ============
+*.db     binary
+*.p      binary
+*.pkl    binary
+*.pickle binary
+*.pyc    binary export-ignore
+*.pyo    binary export-ignore
+*.pyd    binary
+
+# Jupyter notebook
+*.ipynb  text eol=lf
+
+# Note: .db, .p, and .pkl files are associated
+# with the python modules ``pickle``, ``dbm.*``,
+# ``shelve``, ``marshal``, ``anydbm``, & ``bsddb``
+# (among others).
+# Fix syntax highlighting on GitHub to allow comments
+.vscode/*.json linguist-language=JSON-with-Comments

msgspec_xml-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# =====Folders=====
+__pycache__/
+__pypackages__/
+.idea/
+.pytest_cache/
+.ruff_cache/
+.tox/
+.venv/
+build/
+dist/
+logs/
+site/
+
+# =====Files=====
+*.iml
+*.log
+*.txt
+.coverage
+.envrc
+.pdm-python
+.python-version

msgspec_xml-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonah Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

msgspec_xml-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: msgspec-xml
+Version: 0.1.0
+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: defusedxml>=0.7.0
+Requires-Dist: msgspec>=0.21.0
+Description-Content-Type: text/markdown
+
+# msgspec-xml

msgspec_xml-0.1.0/README.md

@@ -0,0 +1 @@
+# msgspec-xml

msgspec_xml-0.1.0/msgspec_xml/__init__.py

@@ -0,0 +1,5 @@
+__all__ = ["Decoder", "Encoder", "decode", "encode"]
+__version__ = "0.1.0"
+
+from msgspec_xml.decoder import Decoder, decode
+from msgspec_xml.encoder import Encoder, encode

msgspec_xml-0.1.0/msgspec_xml/decoder.py

@@ -0,0 +1,76 @@
+__all__ = ["Decoder", "decode"]
+
+from typing import Any, Generic, TypeVar
+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,
+    element_tag,
+    inspect_annotation,
+    item_tag,
+)
+
+T = TypeVar("T", bound=Struct)
+_MISSING: Any = object()
+
+
+class Decoder(Generic[T]):
+    def __init__(self, type_: type[T]):
+        self._type = type_
+
+    def decode(self, xml: str | bytes) -> T:
+        root = ElementTree.fromstring(xml)
+        data = _decode_struct(element=root, cls=self._type)
+        return convert(data, type=self._type, strict=False)
+
+
+def decode(xml: str | bytes, type_: type[T]) -> T:
+    return Decoder(type_=type_).decode(xml=xml)
+
+
+def _decode_struct(element: Element, cls: type[Struct]) -> dict[str, Any]:
+    result: dict[str, Any] = {}
+    for field in fields(cls):
+        info = inspect_annotation(annotation=field.type)
+        value = _decode_field(element=element, field=field, info=info)
+        if value is not _MISSING:
+            result[field.encode_name] = value
+    return result
+
+
+def _decode_field(element: Element, field: FieldInfo, info: FieldType) -> Any:  # noqa: ANN401
+    xml = info.xml
+    if xml.attr:
+        name = attribute_name(field=field, info=info)
+        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))
+    if child is None:
+        return _MISSING
+    if info.is_struct:
+        return _decode_struct(element=child, cls=info.type)
+    return (child.text or "").strip()
+
+
+def _decode_list(element: Element, field: FieldInfo, info: FieldType) -> list[Any]:
+    item = info.item
+    assert item is not None  # noqa: S101
+    parent = element.find(info.xml.wrapper) if info.xml.wrapper else element
+    if parent is None:
+        return []
+    tag = item_tag(field=field, info=info)
+    return [_decode_item(element=child, item=item) for child in parent.findall(tag)]
+
+
+def _decode_item(element: Element, item: FieldType) -> Any:  # noqa: ANN401
+    if item.is_struct:
+        return _decode_struct(element=element, cls=item.type)
+    return (element.text or "").strip()

msgspec_xml-0.1.0/msgspec_xml/encoder.py

@@ -0,0 +1,69 @@
+__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_tag,
+    element_tag,
+    inspect_annotation,
+    item_tag,
+)
+
+
+class Encoder:
+    def encode(self, obj: Struct) -> bytes:
+        root = _encode_struct(obj=obj, tag=class_tag(cls=type(obj)))
+        return ET.tostring(root, encoding="UTF-8")
+
+
+def encode(obj: Struct) -> bytes:
+    return Encoder().encode(obj=obj)
+
+
+def _encode_struct(obj: Struct, tag: str) -> Element:
+    element = ET.Element(tag)
+    for field in fields(type(obj)):
+        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)
+    return element
+
+
+def _encode_field(element: Element, field: FieldInfo, info: FieldType, value: object) -> None:
+    xml = info.xml
+    if xml.attr:
+        element.set(attribute_name(field=field, info=info), _stringify(value))
+    elif xml.text:
+        element.text = _stringify(value)
+    elif info.item is not None:
+        _encode_list(element=element, field=field, info=info, value=value)  # ty: ignore[invalid-argument-type]
+    elif info.is_struct:
+        element.append(_encode_struct(obj=value, tag=element_tag(field=field, info=info)))  # ty: ignore[invalid-argument-type]
+    else:
+        child = ET.SubElement(element, element_tag(field=field, info=info))
+        child.text = _stringify(value)
+
+
+def _encode_list(element: Element, field: FieldInfo, info: FieldType, value: list) -> None:
+    item = info.item
+    assert item is not None  # noqa: S101
+    parent = ET.SubElement(element, info.xml.wrapper) if info.xml.wrapper else element
+    tag = item_tag(field=field, info=info)
+    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/introspection.py

@@ -0,0 +1,84 @@
+__all__ = [
+    "FieldType",
+    "attribute_name",
+    "class_tag",
+    "element_tag",
+    "inspect_annotation",
+    "item_tag",
+]
+
+from types import NoneType
+from typing import Annotated, Any, Optional, get_args, get_origin
+
+from msgspec import Struct
+from msgspec.inspect import is_struct_type
+from msgspec.structs import FieldInfo
+
+from msgspec_xml.metadata import XML
+
+
+class FieldType(Struct, frozen=True, kw_only=True):
+    type: Any
+    xml: XML
+    is_struct: bool = False
+    item: Optional["FieldType"] = None
+
+
+def inspect_annotation(annotation: Any) -> FieldType:  # noqa: ANN401
+    annotation, xml = _split_xml(annotation)
+    annotation = _unwrap_optional(annotation=annotation)
+    if get_origin(annotation) is list:
+        (item_annotation,) = get_args(annotation)
+        return FieldType(
+            type=annotation, xml=xml, item=inspect_annotation(annotation=item_annotation)
+        )
+    return FieldType(type=annotation, xml=xml, is_struct=is_struct_type(annotation))
+
+
+def class_tag(cls: type[Struct]) -> str:
+    tag = getattr(cls, "__tag__", None)
+    if tag is not None:
+        return tag
+    config_tag = cls.__struct_config__.tag
+    if isinstance(config_tag, str):
+        return config_tag
+    return cls.__name__
+
+
+def attribute_name(field: FieldInfo, info: FieldType) -> str:
+    return info.xml.tag or field.encode_name
+
+
+def element_tag(field: FieldInfo, info: FieldType) -> str:
+    if info.xml.tag:
+        return info.xml.tag
+    if info.is_struct:
+        return class_tag(cls=info.type)
+    return field.encode_name
+
+
+def item_tag(field: FieldInfo, info: FieldType) -> str:
+    item = info.item
+    if item is None:
+        raise TypeError("item_tag() requires a list field")
+    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
+
+
+def _split_xml(annotation: Any) -> tuple[Any, XML]:  # noqa: ANN401
+    if get_origin(annotation) is Annotated:
+        base, *metadata = get_args(annotation)
+        return base, next((value for value in metadata if isinstance(value, XML)), XML())
+    return annotation, XML()
+
+
+def _unwrap_optional(annotation: Any) -> Any:  # noqa: ANN401
+    args = get_args(annotation)
+    if len(args) == 2 and NoneType in args:
+        return next(arg for arg in args if arg is not NoneType)
+    return annotation

msgspec_xml-0.1.0/msgspec_xml/metadata.py

@@ -0,0 +1,38 @@
+__all__ = ["XML"]
+
+from msgspec import Struct
+
+
+class XML(Struct, frozen=True, forbid_unknown_fields=True):
+    tag: str | None = None
+    wrapper: str | None = None
+    attr: bool = False
+    text: bool = False
+
+    def __post_init__(self) -> None:
+        if self.attr and self.text:
+            raise ValueError("A field cannot be both an XML attribute and element text.")
+        if self.wrapper is not None and self.attr:
+            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.tag == "":
+            raise ValueError("tag cannot be empty.")
+        if self.wrapper == "":
+            raise ValueError("wrapper cannot be empty.")
+
+    @property
+    def is_element(self) -> bool:
+        return not self.attr and not self.text
+
+    @property
+    def is_attribute(self) -> bool:
+        return self.attr
+
+    @property
+    def is_text(self) -> bool:
+        return self.text
+
+    @property
+    def is_wrapped(self) -> bool:
+        return self.wrapper is not None

msgspec_xml-0.1.0/pdm.toml

@@ -0,0 +1,2 @@
+[lock]
+format = "pylock"

msgspec_xml-0.1.0/prek.toml

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