maxml 1.0.2__tar.gz → 1.0.4__tar.gz

{maxml-1.0.2 → maxml-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxml
-Version: 1.0.2
+Version: 1.0.4
 Summary: A streamlined pure Python XML serializer.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -115,10 +115,10 @@ The `Element` class constructor `Element(...)` takes the following arguments:
 
 The `Element` class provides the following methods:
 
- * `register_namespace(prefix: str, uri: str)` – The `register_namespace()`  method
-	supports registering namespaces globally for the module or per instance depending
-	on whether the method is called on the class directly or whether it is called on a
-	specific instance of the class.
+ * `register_namespace(prefix: str, uri: str, promoted: bool = False)` –
+	The `register_namespace()`  method supports registering namespaces globally for the
+	module or per instance depending on whether the method is called on the class
+	directly or whether it is called on a specific instance of the class.
 
 	If a namespace is registered globally for the module, the registered namespaces
 	become available for use by any instance of the class created within the program
@@ -132,6 +132,12 @@ The `Element` class provides the following methods:
 
 	Each namespace consists of a prefix which can be used to prefix element names
 	and the URI associated with that namespace prefix.
+	
+	Optionally, a namespace can be marked as promoted during registration, which will
+	result in the namespace being serialized into the XML before any attributes on the
+	element. Namespaces that are not marked as promoted will appear after attributes.
+	Namespace promotion can be enabled for a given namespace during registration by
+	passing the optional `promoted` keyword argument with the value of `True`.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"

{maxml-1.0.2 → maxml-1.0.4}/README.md

@@ -84,10 +84,10 @@ The `Element` class constructor `Element(...)` takes the following arguments:
 
 The `Element` class provides the following methods:
 
- * `register_namespace(prefix: str, uri: str)` – The `register_namespace()`  method
-	supports registering namespaces globally for the module or per instance depending
-	on whether the method is called on the class directly or whether it is called on a
-	specific instance of the class.
+ * `register_namespace(prefix: str, uri: str, promoted: bool = False)` –
+	The `register_namespace()`  method supports registering namespaces globally for the
+	module or per instance depending on whether the method is called on the class
+	directly or whether it is called on a specific instance of the class.
 
 	If a namespace is registered globally for the module, the registered namespaces
 	become available for use by any instance of the class created within the program
@@ -101,6 +101,12 @@ The `Element` class provides the following methods:
 
 	Each namespace consists of a prefix which can be used to prefix element names
 	and the URI associated with that namespace prefix.
+	
+	Optionally, a namespace can be marked as promoted during registration, which will
+	result in the namespace being serialized into the XML before any attributes on the
+	element. Namespaces that are not marked as promoted will appear after attributes.
+	Namespace promotion can be enabled for a given namespace during registration by
+	passing the optional `promoted` keyword argument with the value of `True`.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"

maxml-1.0.4/source/maxml/__init__.py

@@ -0,0 +1,4 @@
+from maxml.element import Element
+from maxml.namespace import Namespace
+from maxml.enumerations import Escape
+from maxml.exceptions import MaXMLError

{maxml-1.0.2 → maxml-1.0.4}/source/maxml/element/__init__.py

@@ -2,9 +2,15 @@ from __future__ import annotations
 
 from maxml.namespace import Namespace
 from maxml.logging import logger
+from maxml.enumerations import (
+    Context,
+    Escape,
+)
+from maxml.exceptions import MaXMLError
 
 from classicist import hybridmethod
 
+import re
 
 logger = logger.getChild(__name__)
 
@@ -22,7 +28,7 @@ class Element(object):
     _mixed: bool = False
 
     @hybridmethod
-    def register_namespace(self, prefix: str, uri: str):
+    def register_namespace(self, prefix: str, uri: str, promoted: bool = False):
         """Supports registering namespaces globally for the module or per instance
         depending on whether the method is called on the class directly or whether it is
         called on a specific instance of the class.
@@ -68,6 +74,9 @@ class Element(object):
         if not isinstance(uri, str):
             raise TypeError("The 'uri' argument must have a string value!")
 
+        if not isinstance(promoted, bool):
+            raise TypeError("The 'promoted' argument must have a boolean value!")
+
         for namespace in self._namespaces:
             if namespace.prefix == prefix:
                 if namespace.uri == uri:
@@ -77,12 +86,12 @@ class Element(object):
                     )
                     break
                 else:
-                    raise ValueError(
-                        "The '%s' namespace has already been registered with a different URI!"
-                        % (prefix)
+                    raise MaXMLError(
+                        "The '%s' namespace, %s, has already been registered with a different URI: %s!"
+                        % (prefix, uri, namespace.uri)
                     )
         else:
-            if namespace := Namespace(prefix=prefix, uri=uri):
+            if namespace := Namespace(prefix=prefix, uri=uri, promoted=promoted):
                 self._namespaces.add(namespace)
 
     def __init__(
@@ -170,7 +179,7 @@ class Element(object):
 
                         break
                 else:
-                    raise ValueError(
+                    raise MaXMLError(
                         f"No namespace has been registered for the '{prefix}' prefix associated with the '{name}' element!"
                     )
 
@@ -180,7 +189,7 @@ class Element(object):
                 if namespace.uri == uri:
                     break
             else:
-                namespace = Namespace(prefix=prefix, uri=uri)
+                namespace = Namespace(prefix=prefix, uri=uri, promoted=False)
 
             self.__class__._namespaces.add(namespace)
 
@@ -557,6 +566,7 @@ class Element(object):
         pretty: bool = False,
         indent: str | int = None,
         encoding: str = None,
+        escape: Escape = Escape.All,
         **kwargs,
     ) -> str | bytes:
         """Supports serializing the current Element tree to a string or to a bytes array
@@ -565,6 +575,11 @@ class Element(object):
         if not isinstance(pretty, bool):
             raise TypeError("The 'pretty' argument must have a boolean value!")
 
+        if not isinstance(escape, Escape):
+            raise TypeError(
+                "The 'escape' argument must reference an Escape enumeration option!"
+            )
+
         if indent is None:
             indent = 2
 
@@ -585,10 +600,54 @@ class Element(object):
         elif not isinstance(encoding, str):
             raise TypeError("The 'encoding' argument must have a string value!")
 
+        def escaper(value: str, context: Context, escape: Escape) -> str:
+            """Helper method to escape special characters in XML attributes and text."""
+
+            if isinstance(value, str):
+                pass
+            elif hasattr(value, "__str__"):
+                value = str(value)
+            else:
+                raise TypeError(
+                    "The 'value' argument must have a string value or a value that can be cast to a string!"
+                )
+
+            replacements: dict[str, str] = {
+                "&": "&",
+                "<": "&lt;",
+                ">": "&gt;",
+                '"': "&quot;",
+                "'": "&apos;",
+            }
+
+            if context is Context.Attribute:
+                # Required replacements for element attribute values
+                required: list[str] = ["&", "<", '"']
+            elif context is Context.Text:
+                # Required replacements for element text
+                required: list[str] = ["&", "<"]
+            else:
+                # Require all replacements for other contexts
+                required: list[str] = [key for key in replacements]
+
+            for search, replacement in replacements.items():
+                if (escape is Escape.All) or (search in required):
+                    if search == "&":
+                        # Ensure only standalone "&" characters are replaced, ignoring
+                        # any that are part of an XML special character escape sequence
+                        value = re.sub(
+                            r"&(?!(([a-z]+|#x?[0-9a-fA-F]+);))", replacement, value
+                        )
+                    else:
+                        value = value.replace(search, replacement)
+
+            return value
+
         def stringify(
             element: Element,
             depth: int,
             pretty: bool = False,
+            escape: Escape = Escape.All,
             indent: str = None,
             **kwargs,
         ) -> str:
@@ -606,7 +665,7 @@ class Element(object):
             # Add any promoted namespaces (those which should proceed any attributes)
             count = len(element.namespaced)
             for index, namespace in enumerate(element.namespaced, start=1):
-                if not namespace.promoted:
+                if namespace.promoted is False:
                     continue
 
                 if pretty and count > 1 and (newline or (index > 1 and index <= count)):
@@ -624,6 +683,8 @@ class Element(object):
                     string += f"\n{indent * (depth + 2)}"
                     newline = True
 
+                value = escaper(value, context=Context.Attribute, escape=escape)
+
                 string += f' {key}="{value}"'
 
             # Add any non-promoted namespaces (those which can follow any attributes)
@@ -633,7 +694,7 @@ class Element(object):
                 newline = True
 
             for index, namespace in enumerate(element.namespaced, start=1):
-                if namespace.promoted:
+                if namespace.promoted is True:
                     continue
 
                 if pretty and count > 1 and (newline or (index > 1 and index <= count)):
@@ -656,7 +717,7 @@ class Element(object):
 
                 # Include the element's text content, if any
                 if element.text and (element.mixed or not element.children):
-                    string += element.text
+                    string += escaper(element.text, context=Context.Text, escape=escape)
 
                 # Include the element's children, if any
                 if element.children and (element.mixed or not element.text):
@@ -669,6 +730,7 @@ class Element(object):
                             depth=(depth + 1),
                             pretty=pretty,
                             indent=indent,
+                            escape=escape,
                             **kwargs,
                         )
 
@@ -684,6 +746,7 @@ class Element(object):
             depth=0,
             pretty=pretty,
             indent=indent,
+            escape=escape,
             **kwargs,
         )
 

maxml-1.0.4/source/maxml/enumerations/__init__.py

@@ -0,0 +1,25 @@
+from enumerific import Enumeration, auto
+
+
+class Context(Enumeration):
+    """List of XML contexts, to denote the XML context currently being processed."""
+
+    Unknown = auto()
+    Root = auto(description="Document root node")
+    Prolog = auto(description="Document declaration (prolog)")
+    Instruction = auto(description="Document processing instruction")
+    DocType = auto(description="Document type")
+    Element = auto(description="Element comprising opening/closing or self-closing tag")
+    TagOpen = auto(description="Opening tag of an element (maybe self-closing)")
+    TagClose = auto(description="Closing tag of an element")
+    Attribute = auto(description="Attribute held by an element's tag")
+    Text = auto(description="Text held between an element's opening and closing tags")
+    Data = auto(description="Data held in a CDATA section")
+    Comment = auto(description="Comment held in a comment section")
+
+
+class Escape(Enumeration):
+    """List of XML special character escape modes."""
+
+    All = auto(description="Escape all XML special characters")
+    Required = auto(description="Escpae only required XML special characters")

maxml-1.0.4/source/maxml/exceptions/__init__.py

@@ -0,0 +1,2 @@
+class MaXMLError(Exception):
+    pass

{maxml-1.0.2 → maxml-1.0.4}/source/maxml/namespace/__init__.py

@@ -14,7 +14,7 @@ class Namespace(object):
     _uri: str = None
     _promoted: bool = False
 
-    def __init__(self, prefix: str, uri: str):
+    def __init__(self, prefix: str, uri: str, promoted: bool = False):
         """Initialize the Namespace class"""
 
         if not isinstance(prefix, str):
@@ -27,6 +27,11 @@ class Namespace(object):
 
         self._uri = uri
 
+        if not isinstance(promoted, bool):
+            raise TypeError("The 'promoted' argument must have a boolean value!")
+
+        self._promoted = promoted
+
     def __str__(self) -> str:
         """Return a string representation of the class for debugging purposes."""
 

maxml-1.0.4/source/maxml/version.txt

@@ -0,0 +1 @@
+1.0.4

{maxml-1.0.2 → maxml-1.0.4}/source/maxml.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxml
-Version: 1.0.2
+Version: 1.0.4
 Summary: A streamlined pure Python XML serializer.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -115,10 +115,10 @@ The `Element` class constructor `Element(...)` takes the following arguments:
 
 The `Element` class provides the following methods:
 
- * `register_namespace(prefix: str, uri: str)` – The `register_namespace()`  method
-	supports registering namespaces globally for the module or per instance depending
-	on whether the method is called on the class directly or whether it is called on a
-	specific instance of the class.
+ * `register_namespace(prefix: str, uri: str, promoted: bool = False)` –
+	The `register_namespace()`  method supports registering namespaces globally for the
+	module or per instance depending on whether the method is called on the class
+	directly or whether it is called on a specific instance of the class.
 
 	If a namespace is registered globally for the module, the registered namespaces
 	become available for use by any instance of the class created within the program
@@ -132,6 +132,12 @@ The `Element` class provides the following methods:
 
 	Each namespace consists of a prefix which can be used to prefix element names
 	and the URI associated with that namespace prefix.
+	
+	Optionally, a namespace can be marked as promoted during registration, which will
+	result in the namespace being serialized into the XML before any attributes on the
+	element. Namespaces that are not marked as promoted will appear after attributes.
+	Namespace promotion can be enabled for a given namespace during registration by
+	passing the optional `promoted` keyword argument with the value of `True`.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"

{maxml-1.0.2 → maxml-1.0.4}/source/maxml.egg-info/SOURCES.txt

@@ -12,6 +12,8 @@ source/maxml.egg-info/requires.txt
 source/maxml.egg-info/top_level.txt
 source/maxml.egg-info/zip-safe
 source/maxml/element/__init__.py
+source/maxml/enumerations/__init__.py
+source/maxml/exceptions/__init__.py
 source/maxml/logging/__init__.py
 source/maxml/namespace/__init__.py
 tests/test_element.py

{maxml-1.0.2 → maxml-1.0.4}/tests/test_element.py

@@ -391,3 +391,119 @@ def test_maxml_fragment_tostring(element: maxml.Element, data: callable):
     assert isinstance(compare, str)
 
     assert string == compare
+
+
+def test_maxml_special_tostring(data: callable):
+    """Check serialization functionality works as expected with special characters"""
+
+    element = maxml.Element(name="my:test", namespace="http://namespace.example.org/my")
+
+    # Ensure that the element object's type is as expected
+    assert isinstance(element, maxml.Element)
+
+    sub = element.subelement("my:sub")
+
+    # Ensure that the subelement's type is as expected
+    assert isinstance(sub, maxml.Element)
+
+    # Ensure that the subelement's name prefix was parsed correctly
+    assert sub.prefix == "my"
+
+    # Ensure that the subelement's name was parsed correctly
+    assert sub.name == "sub"
+
+    # Ensure that the element's fullname was parsed correctly
+    assert sub.fullname == "my:sub"
+
+    # Ensure that the element's namespace prefix was registered correctly
+    assert sub.namespace.prefix == "my"
+
+    # Ensure that the element's namespace URI was registered correctly
+    assert sub.namespace.uri == "http://namespace.example.org/my"
+
+    # Ensure that the root has the expected depth
+    assert sub.depth == 1
+
+    sub.set("another", 'Test\'s all of the special characters "2 > 3 < 1" & more!')
+
+    values = [
+        "This & That",
+        "1 < 2",
+        "3 > 2",
+        "That's looking good!",
+        'Yes, I\'d agree, it is "looking good"!',
+        "This &gt; is already encoded &#129;!",
+    ]
+
+    sequence = sub.subelement("my:seq")
+
+    for index, value in enumerate(values, start=1):
+        item = sequence.subelement("my:li")
+        item.set("my:index", str(index))
+        item.text = value
+
+    string: str = element.tostring(pretty=True)
+
+    assert isinstance(string, str)
+
+    compare: str = data("examples/example03special-all.xml")
+
+    assert isinstance(compare, str)
+
+    assert string == compare
+
+    string: str = element.tostring(pretty=True, escape=maxml.Escape.Required)
+
+    assert isinstance(string, str)
+
+    compare: str = data("examples/example03special-required.xml")
+
+    assert isinstance(compare, str)
+
+    assert string == compare
+
+
+def test_maxml_namespace_promotion_non_promoted_namespace(data: callable):
+    """Check promotion of registered namespaces works as expected"""
+
+    maxml.Element.register_namespace(
+        prefix="my1", uri="http://namespace.example.org/my1", promoted=False
+    )
+
+    element = maxml.Element(name="my1:test")
+
+    # Ensure that the element object's type is as expected
+    assert isinstance(element, maxml.Element)
+
+    element.set("my1:attribute", "1234")
+
+    string: str = element.tostring(pretty=True)
+
+    assert isinstance(string, str)
+
+    compare: str = data("examples/example04namespace-unpromoted.xml")
+
+    assert string == compare
+
+
+def test_maxml_namespace_promotion_promoted_namespace(data: callable):
+    """Check promotion of registered namespaces works as expected"""
+
+    maxml.Element.register_namespace(
+        prefix="my2", uri="http://namespace.example.org/my2", promoted=True
+    )
+
+    element = maxml.Element(name="my2:test")
+
+    # Ensure that the element object's type is as expected
+    assert isinstance(element, maxml.Element)
+
+    element.set("my2:attribute", "1234")
+
+    string: str = element.tostring(pretty=True)
+
+    assert isinstance(string, str)
+
+    compare: str = data("examples/example04namespace-promoted.xml")
+
+    assert string == compare

maxml-1.0.2/source/maxml/__init__.py

@@ -1,2 +0,0 @@
-from maxml.element import Element
-from maxml.namespace import Namespace

maxml-1.0.2/source/maxml/version.txt

@@ -1 +0,0 @@
-1.0.2