Merge pull request #122 from dapper91/dev

- raw element missing tail bug fixed. See #118.

Author: dapper91

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.2.3 (2023-09-20)
+------------------
+
+- raw element missing tail bug fixed. See https://github.com/dapper91/pydantic-xml/issues/118.
+
+
 2.2.2 (2023-09-15)
 ------------------
 

pydantic_xml/element/element.py

@@ -221,16 +221,18 @@ class XmlElement(XmlElementReader, XmlElementWriter, Generic[NativeElement]):
     NativeElementInner = TypeVar('NativeElementInner')
 
     class State(Generic[NativeElementInner]):
-        __slots__ = ('text', 'attrib', 'elements', 'next_element_idx')
+        __slots__ = ('text', 'tail', 'attrib', 'elements', 'next_element_idx')
 
         def __init__(
                 self,
                 text: Optional[str],
+                tail: Optional[str],
                 attrib: Optional[Dict[str, str]],
                 elements: List['XmlElement[XmlElement.NativeElementInner]'],
                 next_element_idx: int,
         ):
             self.text = text
+            self.tail = tail
             self.attrib = attrib
             self.elements = elements
             self.next_element_idx = next_element_idx
@@ -259,6 +261,7 @@ def __init__(
             self,
             tag: str,
             text: Optional[str] = None,
+            tail: Optional[str] = None,
             attributes: Optional[Dict[str, str]] = None,
             elements: Optional[List['XmlElement[NativeElement]']] = None,
             nsmap: Optional[NsMap] = None,
@@ -267,6 +270,7 @@ def __init__(
         self._nsmap = nsmap
         self._state = XmlElement.State(
             text=text,
+            tail=tail,
             attrib=dict(attributes) if attributes is not None else None,
             elements=elements or [],
             next_element_idx=0,
@@ -280,6 +284,7 @@ def create_snapshot(self) -> 'XmlElement[NativeElement]':
         element = self.__class__(
             tag=self._tag,
             text=self._state.text,
+            tail=self._state.tail,
             attributes=dict(self._state.attrib) if self._state.attrib is not None else None,
             elements=[element.create_snapshot() for element in self._state.elements],
             nsmap=dict(self._nsmap) if self._nsmap is not None else None,
@@ -292,12 +297,13 @@ def apply_snapshot(self, snapshot: 'XmlElement[NativeElement]') -> None:
         self._tag = snapshot._tag
         self._nsmap = snapshot._nsmap
         self._state.text = snapshot._state.text
+        self._state.tail = snapshot._state.tail
         self._state.attrib = snapshot._state.attrib
         self._state.elements = snapshot._state.elements
         self._state.next_element_idx = snapshot._state.next_element_idx
 
     def is_empty(self) -> bool:
-        if not self._state.text and not self._state.attrib and len(self._state.elements) == 0:
+        if not self._state.text and not self._state.tail and not self._state.attrib and len(self._state.elements) == 0:
             return True
         else:
             return False
@@ -379,6 +385,9 @@ def get_unbound(self, path: Tuple[str, ...] = ()) -> List[Tuple[Tuple[str, ...],
         if self._state.text and (text := self._state.text.strip()):
             result.append((path, text))
 
+        if self._state.tail and (tail := self._state.tail.strip()):
+            result.append((path, tail))
+
         if attrs := self._state.attrib:
             for name, value in attrs.items():
                 result.append((path + (f'@{name}',), value))

pydantic_xml/element/native/lxml.py

@@ -20,6 +20,7 @@ def from_native(cls, element: ElementT) -> 'XmlElement':
         return cls(
             tag=element.tag,
             text=element.text,
+            tail=element.tail,
             attributes={
                 force_str(name): force_str(value)  # transformation is safe since lxml bytes values are ASCII compatible
                 for name, value in element.attrib.items()
@@ -39,6 +40,7 @@ def to_native(self) -> ElementT:
             nsmap={ns or None: uri for ns, uri in self._nsmap.items()} if self._nsmap else None,  # type: ignore[misc]
         )
         element.text = self._state.text
+        element.tail = self._state.tail
         element.extend([element.to_native() for element in self._state.elements])
 
         return element

pydantic_xml/element/native/std.py

@@ -19,6 +19,7 @@ def from_native(cls, element: ElementT) -> 'XmlElement':
         return cls(
             tag=element.tag,
             text=element.text,
+            tail=element.tail,
             attributes=dict(element.attrib),
             elements=[
                 XmlElement.from_native(sub_element)
@@ -30,6 +31,7 @@ def from_native(cls, element: ElementT) -> 'XmlElement':
     def to_native(self) -> ElementT:
         element = etree.Element(self._tag, attrib=self._state.attrib or {})
         element.text = self._state.text
+        element.tail = self._state.tail
         element.extend([element.to_native() for element in self._state.elements])
 
         return element

pyproject.toml

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

tests/test_raw.py

@@ -14,9 +14,7 @@ class TestModel(BaseXmlModel, tag='model', arbitrary_types_allowed=True):
     xml = '''
     <model>
         <element1 attr1="1">text</element1>
-        <element2>
-            <sub-element1 />
-        </element2>
+        <element2><sub-element1 />tail</element2>
     </model>
     '''
 
@@ -29,12 +27,15 @@ class TestModel(BaseXmlModel, tag='model', arbitrary_types_allowed=True):
     sub_elements = list(actual_obj.element2)
     assert len(sub_elements) == 1
     assert sub_elements[0].tag == 'sub-element1'
+    assert sub_elements[0].tail == 'tail'
 
     element1 = etree.Element('element1', attr1='1')
     element1.text = 'text'
 
     element2 = etree.Element('element2')
-    element2.append(etree.Element('sub-element1'))
+    sub_element = etree.Element('sub-element1')
+    sub_element.tail = 'tail'
+    element2.append(sub_element)
 
     actual_obj = TestModel(element1=element1, element2=element2)
     actual_xml = actual_obj.to_xml()