untangle

library1.2.1pypypi✓ verified 84d ago

untangle is a tiny Python library for parsing XML documents, converting them into easy-to-use Python objects. It simplifies accessing data in XML files using dot notation for elements and dictionary-like access for attributes. The current version is 1.2.1, released in July 2022, and it has an infrequent release cadence.

serialization data

pip install untangle

package ↗

INSTALL

IMPORT

SIG · UNTANGLE

untangle

serializationpythonv1.2.1

Install

1.7s avg

Import

130ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.2.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.136s · 18MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 1.7s · import 0.124s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

parse

✓ from untangle import parse

✗ import untangle

Element

✓ from untangle import Element

Handler

✓ from untangle import Handler

This quickstart demonstrates how to parse an XML string and access elements, attributes (using dictionary-like syntax), and text content (cdata) using dot notation. Note that sibling elements with the same tag are automatically grouped into a list.

import untangle xml_data = """<?xml version="1.0"?> <data> <user id="123" status="active"> <name>Alice</name> <email>alice@example.com</email> </user> <user id="456" status="inactive"> <name>Bob</name> <email>bob@example.com</email> </user> </data>""" # Parse the XML string doc = untangle.parse(xml_data) # Accessing the root element (data) print(f"Root element tag: {doc.data._tag}") # Accessing the first user element and its attributes/cdata first_user = doc.data.user[0] print(f"First user ID: {first_user['id']}") print(f"First user Status: {first_user['status']}") print(f"First user Name: {first_user.name.cdata}") print(f"First user Email: {first_user.email.cdata}") # Iterating through users for user in doc.data.user: print(f"User (ID: {user['id']}): {user.name.cdata} <{user.email.cdata}>")

Debug

Known issues

breakingVersions 1.2.0 and earlier are vulnerable to XML External Entity (XXE) injection and recursive entity references (Denial of Service). This could allow remote unauthenticated attackers to read local files or cause a DoS condition on the server.

fix

Upgrade to untangle version 1.2.1 or higher. This version includes patches to prevent these SAX vulnerabilities.

affects: <= 1.2.0

breakingStarting with version 1.2.1, `untangle` dropped official support for Python versions 3.4-3.6 and PyPy.

fix

Ensure your Python environment is 3.7 or newer. If you must use an older Python version (3.4-3.6), you will need to stick to `untangle` versions <= 1.1.1, but be aware of potential security vulnerabilities in those older releases.

affects: < 1.2.1 (for compatibility with newer Python)

gotchaXML element and attribute names containing hyphens (`-`), periods (`.`), or colons (`:`) are automatically converted to underscores (`_`) for attribute-style access in the Python object. For example, an XML tag `<foo-bar/>` will be accessed as `obj.foo_bar`.

fix

Be mindful of this transformation when constructing your access paths. Test your expected access patterns carefully to avoid `AttributeError`.

affects: All versions

gotchaThe text content within an XML tag (CDATA) is not accessed directly as the element's value but through a special `.cdata` attribute on the element object (e.g., `element.name.cdata`).

fix

Always append `.cdata` to the element object when you intend to retrieve its inner text content.

affects: All versions

gotchaIf an XML document contains multiple sibling elements with the same tag name, `untangle` automatically groups them into a Python list. If there's only one, it's accessed directly as an object.

fix

When dealing with elements that might appear multiple times, always be prepared to handle a list (e.g., `for item in parent.item:`). If you expect a single element, direct access (`parent.item`) works, but if the XML structure can vary, consider defensive coding (e.g., checking `isinstance(parent.item, list)` or using `parent.item[0]` if you only want the first).

affects: All versions

Upgrade

Version history

1.2.1latest on PyPI · released Jul 2, 2022

Audit

Dependencies

pythonrequiredRequires Python 3.7 or newer for version 1.2.1+.

Agent activity

19 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://pypi.org/project/untangle/ ↗