docx4j-xsdata

This is the docx4j-python fork of xsdata (MIT). It is the same library, published as the distribution docx4j-xsdata with the import package docx4j_xsdata and the console script docx4j-xsdata, so that it can be installed alongside upstream xsdata in one environment. Code generated by this fork imports its runtime types from docx4j_xsdata.

• What differs from upstream, release by release: docs/fork/CHANGES.md
• How the fork tracks upstream tags: docs/fork/REBASING.md
• Upstream project, documentation and issue tracker: https://github.com/tefra/xsdata
• The rename is entirely script-generated by tools/rename.py; no part of it is hand-edited.

Upstream's MIT licence and copyright (Christodoulos Tsoulloftas) are unchanged and are kept in LICENSE; the MIT text requires no additional notice for the fork's changes. Modifications in this fork are copyright (c) 2026 Plutext Pty Ltd and are released under the same MIT licence.

The rest of this README is upstream's.

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.

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 docx4j-xsdata[cli,lxml,soap]

$ # Generate models
$ docx4j-xsdata generate tests/fixtures/primer/order.xsd --package tests.fixtures.primer

>>> from tests.fixtures.primer import PurchaseOrder
>>> from docx4j_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 ✨✨✨

Features

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: 26.2 (2026-02-15)

Fixes

• Fix elements in same choice different branches incorrectly merged as list (#1206)

Features

• Infer XML required property from typing annotations (#1208)
• Generate required metadata only for attributes without default values (#1208)