untangle

Documentation

• Converts XML to a Python object.
• Siblings with similar names are grouped into a list.
• Children can be accessed with parent.child, attributes with element['attribute'].
• You can call the parse() method with a filename, an URL or an XML string.
• Substitutes -, . and : with _ <foobar><foo-bar/></foobar> can be accessed with foobar.foo_bar, <foo.bar.baz/> can be accessed with foo_bar_baz and <foo:bar><foo:baz/></foo:bar> can be accessed with foo_bar.foo_baz

Installation

With pip:

pip install untangle

Usage

(See and run examples.py or this blog post: Read XML painlessly for more info)

import untangle

obj = untangle.parse(resource)

resource can be:

• a URL
• a filename (a string or an os.PathLike object such as pathlib.Path)
• an XML string

Running the above code and passing this XML:

<?xml version="1.0"?>
<root>
	<child name="child1"/>
</root>

allows it to be navigated from the untangled object like this:

obj.root.child["name"]  # u'child1'

Development

untangle uses uv for builds and virtualenv management:

$ uv sync

Run tests:

$ uv run pytest

Run linter:

$ uv run ruff check .

Run formatter checks:

$ uv run ruff format --check

Run type hint checks:

$ uv run ty check .

Changelog

see CHANGELOG.md