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

{msgspec_xml-0.2.0 → msgspec_xml-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: msgspec-xml
-Version: 0.2.0
+Version: 0.3.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
@@ -53,17 +53,17 @@ from decimal import Decimal
 from typing import Annotated
 
 from msgspec import Struct
-from msgspec_xml import XML, decode, encode
+from msgspec_xml import decode, encode, Attribute, Value, Wrapper
 
 
 class Price(Struct):
-    currency: Annotated[str, XML(attr=True)]
-    cost: Annotated[Decimal, XML(text=True)]
+    currency: Annotated[str, Attribute()]
+    cost: Annotated[Decimal, Value()]
 
 
 class Book(Struct, rename="pascal"):
-    title: str
-    prices: Annotated[list[Price], XML(wrapper="Prices", tag="Price")]
+    title: str  # Implied Element class
+    prices: Annotated[list[Price], Wrapper(wrapper="Prices", tag="Price")]
 
 
 book = Book(

{msgspec_xml-0.2.0 → msgspec_xml-0.3.0}/README.md

@@ -26,17 +26,17 @@ from decimal import Decimal
 from typing import Annotated
 
 from msgspec import Struct
-from msgspec_xml import XML, decode, encode
+from msgspec_xml import decode, encode, Attribute, Value, Wrapper
 
 
 class Price(Struct):
-    currency: Annotated[str, XML(attr=True)]
-    cost: Annotated[Decimal, XML(text=True)]
+    currency: Annotated[str, Attribute()]
+    cost: Annotated[Decimal, Value()]
 
 
 class Book(Struct, rename="pascal"):
-    title: str
-    prices: Annotated[list[Price], XML(wrapper="Prices", tag="Price")]
+    title: str  # Implied Element class
+    prices: Annotated[list[Price], Wrapper(wrapper="Prices", tag="Price")]
 
 
 book = Book(

msgspec_xml-0.3.0/msgspec_xml/__init__.py

@@ -0,0 +1,16 @@
+__all__ = [
+    "XML",
+    "Attribute",
+    "Decoder",
+    "Element",
+    "Encoder",
+    "Value",
+    "Wrapper",
+    "decode",
+    "encode",
+]
+__version__ = "0.3.0"
+
+from msgspec_xml.decoder import Decoder, decode
+from msgspec_xml.encoder import Encoder, encode
+from msgspec_xml.metadata import XML, Attribute, Element, Value, Wrapper

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

@@ -53,7 +53,7 @@ def _decode_field(
     if xml.attr:
         name = attribute_name(field=field, info=info, namespaces=namespaces)
         return element.attrib.get(name, _MISSING)
-    if xml.text:
+    if xml.value:
         return (element.text or "").strip()
     if info.item is not None:
         return _decode_list(element=element, field=field, info=info, namespaces=namespaces)

{msgspec_xml-0.2.0 → msgspec_xml-0.3.0}/msgspec_xml/encoder.py

@@ -76,7 +76,7 @@ def _encode_field(
     if xml.attr:
         name = attribute_name(field=field, info=info, namespaces=namespaces)
         element.set(name, _stringify(value=value))
-    elif xml.text:
+    elif xml.value:
         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]
@@ -106,4 +106,7 @@ def _encode_list(
 
 
 def _stringify(value: object) -> str:
-    return str(to_builtins(value))
+    value = to_builtins(value)
+    if isinstance(value, bool):
+        return "true" if value else "false"
+    return str(value)

msgspec_xml-0.3.0/msgspec_xml/metadata.py

@@ -0,0 +1,74 @@
+__all__ = ["XML", "Attribute", "Element", "Value", "Wrapper"]
+
+from msgspec import Struct
+from msgspec.structs import force_setattr
+
+
+class XML(Struct, frozen=True, forbid_unknown_fields=True):
+    tag: str | None = None
+    wrapper: str | None = None
+    attr: bool = False
+    value: bool = False
+    ns: str | None = None
+
+    def __post_init__(self) -> None:
+        if self.attr and self.value:
+            raise ValueError("A field cannot be both an XML attribute and element value.")
+        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.value:
+            raise ValueError("Wrapper elements cannot be used on XML value.")
+        if self.ns is not None and self.value:
+            raise ValueError("Namespaces cannot be used on XML value.")
+        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:
+        return not self.attr and not self.value
+
+    @property
+    def is_attribute(self) -> bool:
+        return self.attr
+
+    @property
+    def is_value(self) -> bool:
+        return self.value
+
+    @property
+    def is_wrapped(self) -> bool:
+        return self.wrapper is not None
+
+
+class Element(XML, frozen=True, forbid_unknown_fields=True):
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        if self.attr:
+            raise TypeError("Element does not support 'attr'; use Attribute instead.")
+        if self.value:
+            raise TypeError("Element does not support 'text'; use Value instead.")
+        if self.wrapper:
+            raise TypeError("Element does not support 'wrapper'; use Wrapper instead.")
+
+
+class Attribute(XML, frozen=True, forbid_unknown_fields=True):
+    def __post_init__(self) -> None:
+        force_setattr(self, "attr", True)
+        super().__post_init__()
+
+
+class Value(XML, frozen=True, forbid_unknown_fields=True):
+    def __post_init__(self) -> None:
+        force_setattr(self, "value", True)
+        super().__post_init__()
+
+
+class Wrapper(XML, frozen=True, forbid_unknown_fields=True):
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        if self.wrapper is None:
+            raise ValueError("Wrapper requires the 'wrapper' field to be set.")