feat: XmlSerializer skip optional nillable elements

tefra · Jul 28, 2024 · 00d910f · 00d910f
1 parent 6eccffb
commit 00d910f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/docs/models/fields.md b/docs/models/fields.md
@@ -63,12 +63,12 @@ The namespace name of the XML element or attribute.
 ### `nillable`
 
 Specify if the field has to be present in the serialized result even when it doesn't
-have any meaningful content.
+have any meaningful content. If the field is not required the serializer will ignore it.
 
 ```python
 >>> @dataclass
 ... class Root:
-...     first: Optional[str] = field(metadata={"nillable": True}, default=None)
+...     first: Optional[str] = field(metadata={"nillable": True, "required": True}, default=None)
 ...     second: Optional[str] = field(default=None)
 ...
 >>> print(serializer.render(Root()))

diff --git a/tests/fixtures/models.py b/tests/fixtures/models.py
@@ -172,6 +172,8 @@ class SequentialType:
     x4: Optional[int] = field(
         default=None, metadata={"type": "Element", "sequence": 2}
     )
+    x5: Optional[str] = field(default=None, metadata={"type": "Element", "nillable": True})
+    x6: Optional[str] = field(default=None, metadata={"type": "Element", "nillable": True, "required": True})
 
 
 @dataclass

diff --git a/tests/formats/dataclass/serializers/test_mixins.py b/tests/formats/dataclass/serializers/test_mixins.py
@@ -693,6 +693,10 @@ def test_convert_choice_with_derived_dataclass(self):
         expected = [
             ("start", "a"),
             ("attr", "a0", "foo"),
+            ("start", "{xsdata}x6"),
+            ("attr", QNames.XSI_NIL, "true"),
+            ("data", None),
+            ("end", "{xsdata}x6"),
             ("end", "a"),
         ]
 
@@ -814,6 +818,7 @@ def test_next_value(self):
         x2 = next(meta.find_children("x2"))
         x3 = next(meta.find_children("x3"))
         x4 = next(meta.find_children("x4"))
+        x6 = next(meta.find_children("x6"))
 
         actual = self.generator.next_value(obj, meta)
         expected = [
@@ -825,6 +830,7 @@ def test_next_value(self):
             (x1, 4),
             (x3, 9),
             (x4, 10),
+            (x6, None),
         ]
 
         self.assertIsInstance(actual, Generator)

diff --git a/xsdata/formats/dataclass/serializers/mixins.py b/xsdata/formats/dataclass/serializers/mixins.py
@@ -933,7 +933,7 @@ def next_value(cls, obj: Any, meta: XmlMeta) -> Iterator[Tuple[XmlVar, Any]]:
 
             if var.sequence is None:
                 value = getattr(obj, var.name)
-                if value is not None or var.nillable:
+                if value is not None or (var.nillable and var.required):
                     yield var, value
                 index += 1
                 continue