pydantic-xml

https://pydantic-xml.readthedocs.io/

Admin

pydantic-xml is a pydantic extension providing model fields XML binding and XML serialization /...

Tokens:552

Snippets:5

Trust Score:9.6

Update:3 months ago

Show doc for...

Tokens:

Raw

### Example XML Structure for pydantic-xml Model

Source: https://pydantic-xml.readthedocs.io

This XML structure corresponds to the 'Company' and 'Product' models defined using pydantic-xml. It demonstrates how attributes and element text are used to represent the data.

```xml
<Company trade-name="SpaceX">
    <website>https://www.spacex.com</website>
    <product status="running" launched="2013">Several launch vehicles</product>
    <product status="running" launched="2019">Starlink</product>
    <product status="development">Starship</product>
</Company>
```

--------------------------------

### Define XML Model Fields with pydantic-xml

Source: https://pydantic-xml.readthedocs.io

Use pydantic-xml's field decorators to bind model fields to XML attributes, elements, or text. This example shows how to extract data from XML attributes ('status', 'launched', 'trade-name'), element text ('website', 'title'), and nested elements ('products').

```python
class Product(BaseXmlModel):
    status: Literal['running', 'development'] = attr()  # extracted from the 'status' attribute
    launched: Optional[int] = attr(default=None)  # extracted from the 'launched' attribute
    title: str  # extracted from the element text


class Company(BaseXmlModel):
    trade_name: str = attr(name='trade-name')  # extracted from the 'trade-name' attribute
    website: HttpUrl = element()  # extracted from the 'website' element text
    products: List[Product] = element(tag='product', default=[])  # extracted from the 'Company' element's children
```

Tokens:

Raw