Naive XML Bindings for python

xsData is a complete data binding library for python allowing developers to access and use XML and JSON documents as simple objects rather than using DOM.

It ships with a code generator for XML schemas, WSDL definitions, XML & JSON documents. It produces simple dataclasses with type hints and simple binding metadata.

The included XML and JSON parser/serializer are highly optimized and adaptable, with multiple handlers and configuration properties.

xsData is constantly tested against the W3C XML Schema 1.1 test suite.

Getting started

$ # Install all dependencies
$ pip install xsdata[cli,lxml,soap]
$ # Generate models
$ xsdata tests/fixtures/primer/order.xsd --package tests.fixtures.primer
>>> # Parse XML
>>> from pathlib import Path
>>> from tests.fixtures.primer import PurchaseOrder
>>> from xsdata.formats.dataclass.parsers import XmlParser
>>> xml_string = Path("tests/fixtures/primer/sample.xml").read_text()
>>> parser = XmlParser()
>>> order = parser.from_string(xml_string, PurchaseOrder)
>>> order.bill_to
Usaddress(name='Robert Smith', street='8 Oak Avenue', city='Old Town', state='PA', zip=Decimal('95819'), country='US')

Check the documentation for more ✨✨✨


  • Generate code from:

    • XML Schemas 1.0 & 1.1

    • WSDL 1.1 definitions with SOAP 1.1 bindings

    • Directly from XML and JSON Documents

    • Extensive configuration to customize output

    • Pluggable code writer for custom output formats

  • Default Output:

    • Pure python dataclasses with metadata

    • Type hints with support for forward references and unions

    • Enumerations and inner classes

    • Support namespace qualified elements and attributes

  • Data Binding:

    • XML and JSON parser, serializer

    • Handlers and Writers based on lxml and native xml python

    • Support wildcard elements and attributes

    • Support xinclude statements and unknown properties

    • Customize behaviour through config

Changelog: 21.7 (2021-07-01)

  • Fixed docstrings backslash escaping #518

  • Fixed analyzer flattening bare types #541

  • Fixed multiple issues with compound fields and override fields #533

  • Fixed missing derived elements types during xml parsing #541

  • Added structure style: clusters for smaller packages #509

  • Added configuration to generate relative imports #519

  • Added configuration to toggle all dataclasses features #529

  • Added binding support for tuple typing annotations (frozen dataclasses) #529

  • Added support to bind data directly from xml/lxml Element and ElementTree #531 #546

  • Updated analyzer to avoid same name for outer-inner classes #511

  • Updated cli to fail early if config file is invalid #514

  • Updated cli to remove setuptools from runtime dependencies #515

  • Updated analyzer to relax override field validations completely #516

  • Updated analyzer to sort classes before class name conflict resolution #517

  • Updated JSON parser to attempt binding against subclasses #527

  • Updated analyzer to guard against multiple substitution group runs #538

  • Updated code generation to use case sensitive reserved words #545

Why naive?

The W3C XML Schema is too complicated but with good reason. It needs to support any api design. On the other hand when you consume xml you don’t necessarily care about any of that. This is where xsData comes in, to simplify things by making a lot of assumptions like the following one that started everything:

All xs:schema elements are classes everything else is either noise or class properties