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 <https://github.com/tefra/xsdata-w3c-tests>`_.

Getting started
---------------

.. code:: console

    $ # Install all dependencies
    $ pip install xsdata[cli,lxml,soap]

.. code:: console

    $ # Generate models
    $ xsdata tests/fixtures/primer/order.xsd --package tests.fixtures.primer

.. code:: python

    >>> # 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 <https://xsdata.readthedocs.io>`_ 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: 24.1 (2023-01-04)
----------------------------
- Fixed XmlParser to ignore xsi attrs when fail on unknown attributes is enabled (`#846 <https://github.com/tefra/xsdata/pull/846>`_)
- Fixed parsing mandatory byte elements with no value (`#873 <https://github.com/tefra/xsdata/pull/873>`_)
- Fixed issue in json binding with union fields (`#864 <https://github.com/tefra/xsdata/pull/864>`_)
- Fixed PycodeSerializer to escape unicode characters in string values (`#877 <https://github.com/tefra/xsdata/pull/877>`_)
- Fixed compound field choices with forward references (`#886 <https://github.com/tefra/xsdata/pull/886>`_)
- Fixed google style docstrings to add missing colon  (`#884 <https://github.com/tefra/xsdata/pull/884>`_)
- Fixed deprecation warnings for datetime.datetime.utcnow()
- Fixed XmlSerializer to ignore empty non-nillable/required tokens (`#902 <https://github.com/tefra/xsdata/pull/902>`_)
- Fixed issue with invalid variable names when using originalCase naming convention (`#881 <https://github.com/tefra/xsdata/pull/881>`_)
- Added type hints for compound fields (`#858 <https://github.com/tefra/xsdata/pull/858>`_, `#885 <https://github.com/tefra/xsdata/pull/885>`_)
- Added http header when loading remote resources (`#867 <https://github.com/tefra/xsdata/pull/867>`_)
- Added warning when converting parent field to a list (`#871 <https://github.com/tefra/xsdata/pull/871>`_)
- Added ruff to format generated code (`#892 <https://github.com/tefra/xsdata/pull/892>`_)
- Added option to use substitution group names for compound field name (`#905 <https://github.com/tefra/xsdata/pull/905>`_)
- Updated base64 decoding to enable validation (`#875 <https://github.com/tefra/xsdata/pull/875>`_)
- Updated generator to render prohibited parent fields with restriction extensions (`#908 <https://github.com/tefra/xsdata/pull/908>`_)
- Updated generator so plugins can easily override templates
