maxml 1.0.3__tar.gz → 1.0.5__tar.gz

{maxml-1.0.3 → maxml-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxml
-Version: 1.0.3
+Version: 1.0.5
 Summary: A streamlined pure Python XML serializer.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -19,9 +19,9 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: classicist==1.0.*
-Requires-Dist: enumerific==1.0.*
+Requires-Dist: enumerific==1.1.*
 Provides-Extra: development
-Requires-Dist: black==24.10.*; extra == "development"
+Requires-Dist: black==26.1.*; extra == "development"
 Requires-Dist: pytest==8.3.*; extra == "development"
 Requires-Dist: pytest-codeblocks==0.17.0; extra == "development"
 Provides-Extra: distribution
@@ -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,16 @@ 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 being 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 being promoted will appear after any
+	attributes on the element. Namespace promotion can be enabled for a given namespace
+	during registration by passing the optional `promoted` keyword argument with the
+	value of `True`. Whether a namespace is marked as promoted or not can be changed
+	after registration by changing a `Namespace` entity's `promoted` property value or
+	by using the `promote()` and `unpromote()` methods. See the **Namespace Class** for
+	more information.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"
@@ -278,6 +288,9 @@ The `Namespace` class constructor `Namespace(...)` takes the following arguments
 
  * `prefix` (`str`) – The required `prefix` argument sets the namespace prefix.
  * `uri` (`str`) – The required `uri` argument sets the namespace URI.
+ * `promoted` (`bool`) – The optional `promoted` argument sets whether the namespace is
+    marked as being promoted or not. Promoted namespaces result in the namespace being
+    serialized into the XML before any attributes on their associated element.
 
 The `Namespace` class provides the following methods:
 

{maxml-1.0.3 → maxml-1.0.5}/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,16 @@ 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 being 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 being promoted will appear after any
+	attributes on the element. Namespace promotion can be enabled for a given namespace
+	during registration by passing the optional `promoted` keyword argument with the
+	value of `True`. Whether a namespace is marked as promoted or not can be changed
+	after registration by changing a `Namespace` entity's `promoted` property value or
+	by using the `promote()` and `unpromote()` methods. See the **Namespace Class** for
+	more information.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"
@@ -247,6 +257,9 @@ The `Namespace` class constructor `Namespace(...)` takes the following arguments
 
  * `prefix` (`str`) – The required `prefix` argument sets the namespace prefix.
  * `uri` (`str`) – The required `uri` argument sets the namespace URI.
+ * `promoted` (`bool`) – The optional `promoted` argument sets whether the namespace is
+    marked as being promoted or not. Promoted namespaces result in the namespace being
+    serialized into the XML before any attributes on their associated element.
 
 The `Namespace` class provides the following methods:
 

{maxml-1.0.3 → maxml-1.0.5}/requirements.development.txt

@@ -1,4 +1,4 @@
 # MaXML Library: Development & Test Dependencies
-black==24.10.*
+black==26.1.*
 pytest==8.3.*
 pytest-codeblocks==0.17.0

{maxml-1.0.3 → maxml-1.0.5}/requirements.txt

@@ -1,3 +1,3 @@
 # MaXML Library: Runtime Dependencies
 classicist==1.0.*
-enumerific==1.0.*
+enumerific==1.1.*

{maxml-1.0.3 → maxml-1.0.5}/source/maxml/element/__init__.py

@@ -28,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.
@@ -74,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:
@@ -88,7 +91,7 @@ class Element(object):
                         % (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__(
@@ -119,7 +122,7 @@ class Element(object):
         prefix: str = None
 
         if ":" in name:
-            (prefix, basename) = name.split(":", maxsplit=1)
+            prefix, basename = name.split(":", maxsplit=1)
 
         self._prefix: str = prefix
 
@@ -186,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)
 
@@ -662,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)):
@@ -691,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)):

{maxml-1.0.3 → maxml-1.0.5}/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."""
 
@@ -89,7 +94,7 @@ class Namespace(object):
     def copy(self) -> Namespace:
         """Create an independent copy of the current Namespace instance."""
 
-        return Namespace(prefix=self.prefix, uri=self.uri)
+        return Namespace(prefix=self.prefix, uri=self.uri, promoted=self.promoted)
 
     @property
     def promoted(self) -> bool:

maxml-1.0.5/source/maxml/version.txt

@@ -0,0 +1 @@
+1.0.5

{maxml-1.0.3 → maxml-1.0.5}/source/maxml.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maxml
-Version: 1.0.3
+Version: 1.0.5
 Summary: A streamlined pure Python XML serializer.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -19,9 +19,9 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: classicist==1.0.*
-Requires-Dist: enumerific==1.0.*
+Requires-Dist: enumerific==1.1.*
 Provides-Extra: development
-Requires-Dist: black==24.10.*; extra == "development"
+Requires-Dist: black==26.1.*; extra == "development"
 Requires-Dist: pytest==8.3.*; extra == "development"
 Requires-Dist: pytest-codeblocks==0.17.0; extra == "development"
 Provides-Extra: distribution
@@ -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,16 @@ 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 being 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 being promoted will appear after any
+	attributes on the element. Namespace promotion can be enabled for a given namespace
+	during registration by passing the optional `promoted` keyword argument with the
+	value of `True`. Whether a namespace is marked as promoted or not can be changed
+	after registration by changing a `Namespace` entity's `promoted` property value or
+	by using the `promote()` and `unpromote()` methods. See the **Namespace Class** for
+	more information.
 
 	For example, the 'rdf' prefix is associated with the following canonical URI:
 		"http://www.w3.org/1999/02/22-rdf-syntax-ns#"
@@ -278,6 +288,9 @@ The `Namespace` class constructor `Namespace(...)` takes the following arguments
 
  * `prefix` (`str`) – The required `prefix` argument sets the namespace prefix.
  * `uri` (`str`) – The required `uri` argument sets the namespace URI.
+ * `promoted` (`bool`) – The optional `promoted` argument sets whether the namespace is
+    marked as being promoted or not. Promoted namespaces result in the namespace being
+    serialized into the XML before any attributes on their associated element.
 
 The `Namespace` class provides the following methods:
 

{maxml-1.0.3 → maxml-1.0.5}/source/maxml.egg-info/requires.txt

@@ -1,8 +1,8 @@
 classicist==1.0.*
-enumerific==1.0.*
+enumerific==1.1.*
 
 [development]
-black==24.10.*
+black==26.1.*
 pytest==8.3.*
 pytest-codeblocks==0.17.0
 

{maxml-1.0.3 → maxml-1.0.5}/tests/test_element.py

@@ -461,3 +461,99 @@ def test_maxml_special_tostring(data: callable):
     assert isinstance(compare, str)
 
     assert string == compare
+
+
+def test_maxml_namespace_promotion(data: callable):
+    """Check promotion of registered namespaces works as expected"""
+
+    # Register a class level namespace
+    maxml.Element.register_namespace(
+        prefix="xy", uri="http://namespace.example.org/xy", promoted=True
+    )
+
+    # Create a new top-level element
+    element = maxml.Element(name="xy:test")
+
+    # Ensure that the Element object's type is as expected
+    assert isinstance(element, maxml.Element)
+
+    # Ensure that the Element object's namespace type is as expected
+    assert isinstance(element.namespace, maxml.Namespace)
+    assert element.namespace.prefix == "xy"
+    assert element.namespace.uri == "http://namespace.example.org/xy"
+    assert element.namespace.promoted is True
+
+    # Set an element attribute
+    element.set("xy:id", "1")
+
+    # Serialise the element to a string
+    string: str = element.tostring(pretty=True)
+
+    assert isinstance(string, str)
+
+    # Confirm that the promoted namespace was serialised before the attributes
+    compare: str = """<xy:test xmlns:xy="http://namespace.example.org/xy" xy:id="1"/>"""
+
+    assert string == compare
+
+    # Now mark the namespace as not being promoted to re-test the serialisation below
+    element.namespace.promoted = False
+
+    # Ensure that the promoted status has changed
+    assert element.namespace.promoted is False
+
+    # Serialise the element to a string
+    string: str = element.tostring(pretty=True)
+
+    assert isinstance(string, str)
+
+    # Confirm that the non-promoted namespace was serialised after the attributes
+    compare: str = """<xy:test xy:id="1" xmlns:xy="http://namespace.example.org/xy"/>"""
+
+    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.3/source/maxml/version.txt

@@ -1 +0,0 @@
-1.0.3