xsdata24.12
Published
Python XML Binding
pip install xsdata
Package Downloads
Authors
Project URLs
Requires Python
>=3.9
Dependencies
- typing-extensions
>=4.7.0 - click
>=5.0; extra == "cli" - click-default-group
>=1.2; extra == "cli" - docformatter
>=1.7.2; extra == "cli" - jinja2
>=2.10; extra == "cli" - toposort
>=1.5; extra == "cli" - ruff
>=0.3.0; extra == "cli" - mkdocs
; extra == "docs" - mkdocs-gen-files
; extra == "docs" - mkdocs-literate-nav
; extra == "docs" - mkdocs-material
; extra == "docs" - mkdocs-minify-plugin
; extra == "docs" - mkdocstrings
[python]; extra == "docs" - markdown-exec
[ansi]; extra == "docs" - pymdownx-superfence-filter-lines
; extra == "docs" - lxml
>=4.5.0; extra == "lxml" - requests
; extra == "soap" - pre-commit
; extra == "test" - pytest
; extra == "test" - pytest-benchmark
; extra == "test" - pytest-cov
; extra == "test"
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 xsdata[cli,lxml,soap]
$ # Generate models
$ xsdata generate 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 ✨✨✨
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: 24.12 (2024-12-22)
Fixes
-
Set the default value of prohibited fields to None (#1098)
-
Set body and fault as optional in output soap classes (#1099)
-
Resolve a conflict with type location when an element and a complex type have the same name (#1107)
Features
-
Allow Xml Parser subclasses to override how the root class is located (#1090)
-
Include common soap encoding schema (#1100)
Deprecations
- Remove subscritable types config option
- Remove Type,Tuple,List,Dict from stop words
- Deprecate xsdata
shorthand, use xsdata generate instead