pydantic-xml extension

pydantic-xml is a pydantic extension providing model fields xml binding and xml serialization / deserialization. It is closely integrated with pydantic which means it supports most of its features.

Features

pydantic v1 / v2 support
flexable attributes, elements and text binding
python collection types support (Dict, TypedDict, List, Set, Tuple, …)
Union type support
pydantic generic models support
pydantic computed fields support
lxml xml parser support
xml.etree.ElementTree standard library xml parser support

What is not supported?

Getting started

The following model fields binding:

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

defines the XML document:

<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>

See documentation for more details.

Metadata

Release files for pydantic-xml 2.14.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pydantic-xml 2.14.1
File	Size	Uploaded
pydantic_xml-2.14.1.tar.gz	26.0 kB	Nov 28, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for pydantic-xml 2.14.1
File	Interpreter	ABI	Platform	Reset
pydantic_xml-2.14.1-py3-none-any.whl 40.6 kB Nov 28, 2024	Python 3	none	any	Details

Total release size: 66.6 kB

Release files / pydantic_xml-2.14.1.tar.gz

Download URL	pydantic_xml-2.14.1.tar.gz
Size	26.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`75969a2a5bb361588e1a07b045875ac7b168eb9a937e0aff483ca31a02f2b7e2`
BLAKE2b-256 checksum How to use checksums	`5fc99b03c5c804cbc18afa3e1f025b92ff4103065022071c4c5c6c86668b4159`
Upload date	Nov 28, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure`

Release files / pydantic_xml-2.14.1-py3-none-any.whl

Download URL	pydantic_xml-2.14.1-py3-none-any.whl
Size	40.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7d794a6c7db7b0aef521fa3ccf589b19ed3df63bb1aeac5017583ff28763d973`
BLAKE2b-256 checksum How to use checksums	`5d1ff919e1c4f4f85308b7cb385ecc01ddd7ab077b8e12555cecf6075547e29e`
Upload date	Nov 28, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure`