Getting Text and Attributes from Child Element

[allRisc]

It would be nice in some situations to have the ability to get the text value of a child element in one model field and get a dictionary of the element's attributes in another model field such as below:

class Range(BaseXmlModel, ns="ipxact", tag="range", nsmap=NSMAP):

    left: int = element("left")
    right: int = element("right")
    left_attribs: Dict[str, str] = element(tag="left", default_factory=dict)
    right_attribs: Dict[str, str] = element(tag="right", default_factory=dict)

with an XML Example of:

<range>
    <left minimum="0">0</left>
    <right minimum="8">15</right>
</range>

Currently this results in left_attribs and right_attribs being empty dictionaries.

[cmutel]

You need to create submodels for such cases:

from pydantic_xml import BaseXmlModel, attr, element


class Side(BaseXmlModel):
    value: int
    minimum: str = attr(name="minimum")


class Range(BaseXmlModel, tag="range"):
    left: Side = element(tag="left")
    right: Side = element(tag="right")

xml = b"""<range>
    <left minimum="0">0</left>
    <right minimum="8">15</right>
</range>"""

Range.from_xml(xml).model_dump()
>>> {'left': {'value': 0, 'minimum': '0'}, 'right': {'value': 15, 'minimum': '8'}}

[dapper91]

@cmutel Hi,

You may use wrapped field to do that:

from pydantic_xml import BaseXmlModel, wrapped

class Range(BaseXmlModel, ns="ipxact", tag="range", nsmap=NSMAP):
    left: int = wrapped("left")
    left_attribs: Dict[str, str] = wrapped(path="left", default_factory=dict)
    right: int = wrapped("right")
    right_attribs: Dict[str, str] = wrapped(path="right", default_factory=dict)