XML to Python

Generate Python types from XML automatically.

Local Your input is processed locally in your browser. Found a problem? Report an issue

What XML to Python does

XML to Python turns a sample XML document into Python code: one @dataclass per object, with a type for every field inferred from the value in the sample.

XML to Python examples

The built-in sample

Input

<users><user id="1"><name>Ada</name></user><user id="2"><name>Lin</name></user></users>

Output

from dataclasses import dataclass
from typing import Any, List


@dataclass
class Root:
    _id: str
    name: str

This is the input that the Load sample button fills in.

Attributes, repeated elements and empty elements

Input

<order id="7" paid="false"><total>19.5</total><item sku="A1"><qty>2</qty></item><item sku="B2"><qty>1</qty><gift/></item><note/></order>

Output

from dataclasses import dataclass
from typing import Any, List


@dataclass
class Item:
    _sku: str
    qty: str
    gift: str

@dataclass
class Root:
    _id: str
    _paid: str
    total: str
    item: List[Item]
    note: str

In the sample, id, paid and sku are attributes, item repeats, and gift and note are empty elements. Every value is typed as a string, because XML does not carry types.

Each output was produced by running this tool on the input above it.

How it works

The sample is walked recursively and each value is mapped to a Python type:

Sample valuePython type
Stringstr
Whole numberint
Decimal numberfloat
true / falsebool
null, or an empty array’s itemsAny
Array of TList[T]
Objecta new named type

XML has no data types, so every leaf value is generated as the Python string type. Attributes become fields too: the @ prefix becomes an underscore (_id). Repeated elements become lists, and the root element itself is always called Root.

Reading XML into the generated types

The standard library's xml.etree.ElementTree returns elements, not dataclasses. Fill the classes yourself, reading attributes with element.get("id") and child text with element.findtext("total").

Details and limits

  • Nested classes are written before the classes that use them, so the module can be imported as it is.
  • A key that is a Python keyword, such as class, is emitted unchanged and is a syntax error until you rename it.
  • All fields are required positional fields. Give optional ones a default, and keep fields without defaults first.
  • A type is named after the key that holds the object: items gives a type called Items, with no attempt to make it singular. The top-level type is always Root.
  • If two different objects sit under the same key name in different places, two types with the same name are generated. Rename one of them.
  • Objects in an array are merged into one type. A field that only some of them have is still generated as a required field.
  • Input that is not valid XML stops the tool, and the status line shows where the problem is. The XML Validator page lists the usual causes.

Questions

Is my data uploaded when I use XML to Python?

No. The tool runs in your browser, so what you paste or open is processed on your own device and is not sent to a server.

What does XML to Python do?

XML to Python turns a sample XML document into Python code: one @dataclass per object, with a type for every field inferred from the value in the sample.

Are there any limits I should know about?

Nested classes are written before the classes that use them, so the module can be imported as it is. A key that is a Python keyword, such as class, is emitted unchanged and is a syntax error until you rename it.

Is there a size limit?

There is no fixed size limit. Everything happens on your device, so very large inputs depend on its memory and can take longer on a phone than on a computer.

Does it work on phones, and is it free?

Yes. It works in any current browser on Android phones, iPhones, tablets and computers. It is free and needs no account or sign-up.