eLvErDe / xsdata

Naive XML Bindings for python

Naive XML Bindings for python

---

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

It ships with a code generator for XML schemas, WSDL definitions and XML documents. It produces simple dataclasses with type hints and 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/order.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 ✨✨✨

Features

• Generate code from:
  • XML Schemas 1.0 & 1.1
  • WSDL 1.1 definitions with SOAP 1.1 bindings
  • Directly from XML 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.4 (2021-04-02)

• Split requirements to extras cli, soap and lxml #419
• Fixed parser conflict when an attribute and element field have the same qualified name
• Added cli auto detection for source types, removed cli flag --wsdl
• Added cli support to generate code from raw xml documents
• Added cli entry point to allow pluggable output formats #429
• Added cli short flags for all options and flags
• Added handler to set effective choice groups #433
• Moved plantUML output format to a standalone plugin
• Updated xml parser to allow unions of primitive and class types
• Updated XmlDateTime parser to catch invalid cases with extra leading zeros
• Updated QName converter to validate uri/ncname when parsing string representations
• Updated JsonParser to allow parsing from filename string
• Updated cli option --compound-fields to a boolean flag