Skip to content

skinkie/xsdata

 
 

Repository files navigation

Naive XML Bindings for python

https://readthedocs.org/projects/xsdata/badge https://www.codefactor.io/repository/github/tefra/xsdata/badge

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
>>> # 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 ✨✨✨

Features

  • Generate code from:
    • 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: 23.6 (2023-06-24)

  • Fixed conflicting enum values leading to wrong default values (#806)
  • Added support for custom decorators and base classes (#793)
  • Added parser config to load external dtd to resolve entities (#797)
  • Added requests sessions on the wsdl client transport (#798)
  • Added support subscriptable types and UnionType (#801)
  • Added option to restrict models package for auto-locator (#809)
  • Updated context to only cache supported classes (#796)
  • Removed tox requirement (#800)
  • Converted to pyproject.toml (#802)

About

Naive XML & JSON Bindings for python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Jinja 0.4%