maxml 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

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/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/version.txt

@@ -1 +1 @@
-1.0.3
+1.0.5

{maxml-1.0.3.dist-info → maxml-1.0.5.dist-info}/METADATA

@@ -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.5.dist-info/RECORD

@@ -0,0 +1,12 @@
+maxml/__init__.py,sha256=9wLSTIlZTXinpBr9ABp_PUWhfxubtNM89Iac2VCNet8,150
+maxml/version.txt,sha256=nXE_EpedYoeSULwKIDXj71cxWsQlHoUBnSHHXtcmlyA,5
+maxml/element/__init__.py,sha256=fE8S25ijZORtZMql0w58KONgoybWkkfXynCFNxEPUb4,26394
+maxml/enumerations/__init__.py,sha256=N15XKtEZp2cFwqq_1GXyODqoOE--z9WukZGt_rFur2E,1153
+maxml/exceptions/__init__.py,sha256=qMI3bIXJe6zDXzRnxdW3v6wbxSYfd1oK-9lnxvZzzjQ,38
+maxml/logging/__init__.py,sha256=AMpvZEQH9GIBe8609sMwb2T64rovpkRRCc9rs2kHy8g,52
+maxml/namespace/__init__.py,sha256=EJs0gJClL2Kz0ECtGr8hQzrXOtGxi3RIbLzAoXIufno,4091
+maxml-1.0.5.dist-info/METADATA,sha256=dPUqqC104G7xgyz0jdGGbxx4bszCVVgE-tj1BkPicGw,17165
+maxml-1.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+maxml-1.0.5.dist-info/top_level.txt,sha256=ZFK3SmCc04Dzhl9QkO_hVBAEiHwCNrwn8X_PINWE9C4,6
+maxml-1.0.5.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+maxml-1.0.5.dist-info/RECORD,,

{maxml-1.0.3.dist-info → maxml-1.0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

maxml-1.0.3.dist-info/RECORD

@@ -1,12 +0,0 @@
-maxml/__init__.py,sha256=9wLSTIlZTXinpBr9ABp_PUWhfxubtNM89Iac2VCNet8,150
-maxml/version.txt,sha256=INLLCW0atBpBQCRtEvB79rjLdD_UgSK3JTLAPUTFwUo,5
-maxml/element/__init__.py,sha256=39X5ncEAT7kdFa9jz-1MVG02O5HaoxcHuFuNUNYswXY,26198
-maxml/enumerations/__init__.py,sha256=N15XKtEZp2cFwqq_1GXyODqoOE--z9WukZGt_rFur2E,1153
-maxml/exceptions/__init__.py,sha256=qMI3bIXJe6zDXzRnxdW3v6wbxSYfd1oK-9lnxvZzzjQ,38
-maxml/logging/__init__.py,sha256=AMpvZEQH9GIBe8609sMwb2T64rovpkRRCc9rs2kHy8g,52
-maxml/namespace/__init__.py,sha256=iZqHWuGi09KtMTr7wHiyTQLXB2TFljUir8wZGLi2b60,3882
-maxml-1.0.3.dist-info/METADATA,sha256=ekfPSZaa565dou1yy4wwqC4fWu264JxFlwqYra-AXpo,16193
-maxml-1.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maxml-1.0.3.dist-info/top_level.txt,sha256=ZFK3SmCc04Dzhl9QkO_hVBAEiHwCNrwn8X_PINWE9C4,6
-maxml-1.0.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-maxml-1.0.3.dist-info/RECORD,,