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.8 (2021-08-03)

  • Deprecated JsonSerializer indent property, use SerializerConfig instead

  • Fixed SchemaMapper assigning wrong namespace for imported unqualified elements

  • Fixed AttributeTypeHandler to maintain occurs between any flattening

  • Fixed missing required field metadata property

  • Fixed nillable fields not being marked as optional

  • Fixed fields ordering during class reduce process (Codegen from xml/json)

  • Added support for xs:defaultOpenContent:appliesToEmpty attribute

  • Added ParserConfig class factory option #549

  • Added SerializerConfig option to ignore optional default attributes #555

  • Added warning on unexpected duplicate types #564

  • Added GeneratorConfig support for kw_only and slots for python >= 3.10

  • Added structure style namespace-clusters #573

  • Updated text fields default value to empty string and marked as required #570

  • Updated fields derived from xs:substitutionGroups to optional

  • Updated fields derived from xs:any to optional

  • Updated AttributeDefaultValueHandler to preserve acceptable default values

  • Updated AttributeDefaultValueHandler to mark as optional any xsi:type attribute

  • Updated xs:alternative handling to resemble xs:choice

  • Updated mixed content handler to group all elements under wildcard

  • Updated ElementMapper to detect nillable types

  • Updated DictMapper to generate list of xs:anySimpleType for empty list nodes

  • Updated the compatibility layer for dataclass style plugins

  • Updated namespaces structure style to convert namespaces similar to jaxb

    • to org.w3.XML.1998.namespace

  • Update binding process for nillable types and fields

    • nillable types can be initialized

    • nillable fields are initialized with None values

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