Skip to content

Naive XML Bindings for python

image image image image image image image

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.

The code generator supports XML schemas, DTD, 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
>>> from tests.fixtures.primer import PurchaseOrder
>>> from xsdata.formats.dataclass.parsers import XmlParser
>>> parser = XmlParser()
>>> order = parser.parse("tests/fixtures/primer/sample.xml", 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 ✨✨✨


Code Generator

  • XML Schemas 1.0 & 1.1
  • WSDL 1.1 definitions with SOAP 1.1 bindings
  • DTD external definitions
  • 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
  • PyCode 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: 24.3.1 (2024-03-10)


  • Unnest class with circular reference (#974)

Changelog: 24.4 (2024-04-01)


  • Add xml and lxml tree serializers (#975)
  • Capture namespace prefixes in user dicts (#978)
  • Add cli option to generate wrapper fields (#982)
  • Support wrapper fields in JSON data bindings (#982)
  • Use abstract suffixes to resolve class name conflicts (#985)
  • Add the version number in the cli cache key (#990)
  • Use for attrs with only special characters (#993)
  • Add src code excerpts on ruff errors (#996)
  • Detect circular imports and raise appropriate error (#999)
  • Add support for Python 3.13 (#1001)
  • Add cli debug messages with performance stats


  • Use deepcopy to clone codegen models (#980)
  • Generate type hints for compound fields with token elements (#997)
  • Protect prohibited attrs from turning into lists (#998)
  • Convert child attr to list when parent is list (#998)

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