Merge pull request #136 from dapper91/dev

- bool type encoding format changed from 'True' to 'true'. 
- None type encoding format changed from 'None' to ''.

Author: dapper91

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+2.3.0 (2023-10-22)
+------------------
+
+- bool type encoding format changed from 'True' to 'true'. See https://github.com/dapper91/pydantic-xml/issues/126.
+- None type encoding format changed from 'None' to ''.
+
+
 2.2.4 (2023-10-06)
 ------------------
 

docs/source/pages/misc.rst

@@ -46,10 +46,8 @@ None type encoding
 __________________
 
 Since xml format doesn't support ``null`` type natively it is not obvious how to encode ``None`` fields
-(ignore it, encode it as an empty string or mark it as ``xsi:nil``) the library doesn't implement
-``None`` type encoding by default.
-
-You can define your own encoding format:
+(ignore it, encode it as an empty string or mark it as ``xsi:nil``). The library encodes ``None`` typed fields
+as empty strings by default but you can define your own encoding format:
 
 .. literalinclude:: ../../../examples/snippets/py3.9/serialization.py
   :language: python

pydantic_xml/serializers/factories/primitive.py

@@ -4,7 +4,7 @@
 
 from pydantic_xml import errors
 from pydantic_xml.element import XmlElementReader, XmlElementWriter
-from pydantic_xml.serializers.serializer import SearchMode, Serializer
+from pydantic_xml.serializers.serializer import SearchMode, Serializer, encode_primitive
 from pydantic_xml.typedefs import EntityLocation, NsMap
 from pydantic_xml.utils import QName, merge_nsmaps
 
@@ -44,7 +44,7 @@ def serialize(
         if value is None and skip_empty:
             return element
 
-        element.set_text(str(encoded))
+        element.set_text(encode_primitive(encoded))
         return element
 
     def deserialize(
@@ -90,7 +90,7 @@ def serialize(
         if value is None and skip_empty:
             return element
 
-        element.set_attribute(self._attr_name, str(encoded))
+        element.set_attribute(self._attr_name, encode_primitive(encoded))
 
         return element
 

pydantic_xml/serializers/serializer.py

@@ -15,6 +15,15 @@
 from . import factories
 
 
+def encode_primitive(value: Any) -> str:
+    if value is None:
+        return ''
+    elif isinstance(value, bool):
+        return str(value).lower()
+    else:
+        return str(value)
+
+
 class SchemaTypeFamily(IntEnum):
     META = 0
     PRIMITIVE = 1

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydantic-xml"
-version = "2.2.4"
+version = "2.3.0"
 description = "pydantic xml extension"
 authors = ["Dmitry Pershin <dapper1291@gmail.com>"]
 license = "Unlicense"

tests/test_encoder.py

@@ -39,7 +39,7 @@ class TestModel(BaseXmlModel, tag='model'):
     <model>
         <field1>1</field1>
         <field2>1.1</field2>
-        <field3>True</field3>
+        <field3>true</field3>
         <field4>3.14</field4>
         <field5>2023-02-04T12:01:02</field5>
         <field6>2023-02-04</field6>

tests/test_generics.py

@@ -28,7 +28,7 @@ class GenericModel(BaseXmlModel, Generic[GenericType1, GenericType2], tag='model
     assert_xml_equal(actual_xml, xml1)
 
     xml2 = '''
-    <model1 attr1="True" attr2="string"/>
+    <model1 attr1="true" attr2="string"/>
     '''
 
     TestModel = GenericModel[bool, str]

tests/test_misc.py

@@ -75,7 +75,7 @@ class TestModel(BaseXmlModel, tag='model'):
     xml = '''
     <model>
         <submodel></submodel>
-        <element1>None</element1>
+        <element1></element1>
     </model>
     '''
 
@@ -104,7 +104,7 @@ class TestModel(BaseXmlModel, tag='model'):
 
     xml = '''
     <model>
-        <submodel attr1="None">None<element1>None</element1></submodel>
+        <submodel attr1=""><element1></element1></submodel>
     </model>
     '''