Skip to main content

Python XML Binding

Project description

https://github.com/tefra/xsdata/raw/master/docs/_static/logo.svg

Naive XML Bindings for python

https://github.com/tefra/xsdata/workflows/tests/badge.svg https://readthedocs.org/projects/xsdata/badge https://codecov.io/gh/tefra/xsdata/branch/master/graph/badge.svg https://img.shields.io/github/languages/top/tefra/xsdata.svg https://www.codefactor.io/repository/github/tefra/xsdata/badge https://img.shields.io/pypi/pyversions/xsdata.svg https://img.shields.io/pypi/v/xsdata.svg

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

Features

  • 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: 22.4 (2022-04-10)

  • Added config option to unnest classes

  • Added new class meta option global_type, to hide classes from discovery

  • Removed min/max length restrictions for enum type fields

  • Allow builtin xml types to be fully extended #672

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xsdata-22.4.tar.gz (272.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xsdata-22.4-py3-none-any.whl (167.6 kB view details)

Uploaded Python 3

File details

Details for the file xsdata-22.4.tar.gz.

File metadata

  • Download URL: xsdata-22.4.tar.gz
  • Upload date:
  • Size: 272.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.11+

File hashes

Hashes for xsdata-22.4.tar.gz
Algorithm Hash digest
SHA256 f66bee5bda86069707c31e474392def30c07a4ec2907ecaa43bdff40cd5bb085
MD5 af55404bb9a4ea19ba510135acd91daa
BLAKE2b-256 c3b3c7340b22a5e274bfbd8ae60ea4f79f7ca912fcbe0dc4e3d49773a79821bb

See more details on using hashes here.

File details

Details for the file xsdata-22.4-py3-none-any.whl.

File metadata

  • Download URL: xsdata-22.4-py3-none-any.whl
  • Upload date:
  • Size: 167.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.11+

File hashes

Hashes for xsdata-22.4-py3-none-any.whl
Algorithm Hash digest
SHA256 be8837e0e9c3e9866add6f9856571b23f353142e80a129224af33317de38a525
MD5 00cc7ebf52384dfa90561eb01e9ab2d9
BLAKE2b-256 d898a00874a57610fed3a9c1a5bc3b055179ff3993a2c107b02019ddcdd231f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page