Skip to main content

Python XML Binding

Project description

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

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/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 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: 21.5 (2021-05-07)

  • Added output structure style single-package #469

  • Added support for marshalling array of objects for json #448

  • Added support to generate code from raw json documents #445

  • Added docstring style Blank to avoid generating them #460

  • Added validations for non supported type hints

  • Added support for python 3.10

  • Generate package __all__ lists #459

  • Generate factory for xs:list enumeration default values #471

  • Avoid generating prohibited elements with maxOccurs==0 #478

  • Avoid generating identical overriding fields #466

  • Fixed flattening base classes if they are also subclasses #473

  • Fixed unchecked class name conflict resolution #457

  • Refactored context components to improve binding performance #476

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-21.5.tar.gz (256.3 kB view details)

Uploaded Source

Built Distribution

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

xsdata-21.5-py3-none-any.whl (147.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xsdata-21.5.tar.gz
  • Upload date:
  • Size: 256.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.3+

File hashes

Hashes for xsdata-21.5.tar.gz
Algorithm Hash digest
SHA256 926cd20f2e1e84b3ae980f5ca26d11166550dbe72326740da474485a8879be4b
MD5 780c2f485dec4516c418a7e351bec958
BLAKE2b-256 c79e5236c3113da0d226ba5f26a6dc93a191c491a1364e948f23435049bb46a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xsdata-21.5-py3-none-any.whl
  • Upload date:
  • Size: 147.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.3+

File hashes

Hashes for xsdata-21.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e9c700fba6a3e829a0d5c24f0e5e7c04ffa5595cbc64c87ab00ff3e249b2fe6f
MD5 0530b47fbf182af5f7ba6505289e3c47
BLAKE2b-256 908a9e669eeafe5dc79045212ccad3378d2bcb61fc560b78cca0a3a3708006fa

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