Skip to main content

A sloppy XML parser for Python designed to be used with LLMs

Project description

A sloppy XML parser for Python designed to handle malformed XML gracefully.

License Python Version Tests

Sloppy XML is a single-file XML parser library that prioritizes resilience over strict XML compliance. In fact it tries not to be XML compliant at all. It's specifically designed to handle malformed XML commonly generated by LLMs, automated systems, and other sources where perfect XML structure cannot be guaranteed.

The parser provides both streaming and tree-building capabilities with robust error recovery mechanisms, making it ideal for parsing XML from unreliable sources while maintaining reasonable performance.

Note: this library was 100% AI generated with Claude Code and used experimentally for some evals I'm doing. I will try to fix it up as good as possible as I ran into issues, but I cannot vouch for the quality of it.

Goals

  • Graceful Error Recovery: Handle malformed XML without crashing
  • Dual API: Both streaming events and ElementTree construction
  • Zero Dependencies: Single file with only standard library dependencies
  • LLM-Friendly: Specifically designed for XML generated by language models
  • Detailed Diagnostics: Rich error reporting with line/column information

Quick Example

import sloppy_xml

# Streaming API - handle malformed XML gracefully
xml_content = '''
<root>
    <item name="test" broken-attr=>
        Some text with <unclosed-tag>
        <!-- Malformed comment --
    </item>
</root>
'''

# Stream parsing with error recovery
for event in sloppy_xml.stream_parse(xml_content):
    if isinstance(event, sloppy_xml.StartElement):
        print(f"Start: {event.name}, attrs: {event.attrs}")
    elif isinstance(event, sloppy_xml.EndElement):
        print(f"End: {event.name}")
    elif isinstance(event, sloppy_xml.Text):
        print(f"Text: {repr(event.content)}")
    elif isinstance(event, sloppy_xml.ParseError):
        print(f"Error recovered: {event.message} at {event.line}:{event.column}")

# Tree parsing - get an ElementTree despite malformed input
root = sloppy_xml.tree_parse(xml_content)
print(f"Parsed tree with root: {root.tag}")

Event Types

The streaming parser emits these event types:

  • StartElement - Opening tags with attributes and position info
  • EndElement - Closing tags (including auto-closed mismatched tags)
  • Text - Text content with CDATA detection
  • Comment - XML comments
  • ProcessingInstruction - Processing instructions like <?xml?>
  • EntityRef - Entity references with automatic resolution
  • ParseError - Recoverable parsing errors with diagnostic information

Error Recovery Features

  • Tag Stack Management: Automatically closes mismatched opening tags
  • Malformed Attribute Handling: Recovers from broken attribute syntax
  • Entity Resolution: Handles standard HTML entities and numeric references
  • CDATA Fallback: Treats malformed CDATA as regular text
  • Comment Recovery: Handles unclosed comments gracefully
  • State Recovery: Returns parser to valid state after errors

API Functions

Streaming API

sloppy_xml.stream_parse(xml_input)

Returns an iterator of events for streaming XML processing.

Tree API

sloppy_xml.tree_parse(xml_input)

Returns an xml.etree.ElementTree.Element root node.

Installation

uv add sloppy-xml-py

Development

This project uses uv for dependency management:

# Setup
uv sync

# Run tests
uv run pytest

# Format code
uv run ruff format

# Check code quality
uv run ruff check

# Build package
uv build

Similar Projects

  • xml.etree.ElementTree (stdlib) - Strict XML parsing, no error recovery
  • lxml - Fast XML parsing with some error tolerance
  • BeautifulSoup - HTML/XML parsing with tag soup handling

Sloppy XML fills the gap for applications that need structured XML parsing with aggressive error recovery, particularly for machine-generated content.

Sponsor

If you like the project and find it useful you can become a sponsor.

License and Links

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

sloppy_xml-0.3.0.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

sloppy_xml-0.3.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file sloppy_xml-0.3.0.tar.gz.

File metadata

  • Download URL: sloppy_xml-0.3.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sloppy_xml-0.3.0.tar.gz
Algorithm Hash digest
SHA256 dd479962ddd861a5881e1b48214b46c7a20dcb46c9fda98810e876b3023f737a
MD5 17e4009c630c8330c65fc60e654699ef
BLAKE2b-256 0cf6c30750c578aa6fe190057a602e8d9858d6e701008d30ff19c16daafa4c10

See more details on using hashes here.

Provenance

The following attestation bundles were made for sloppy_xml-0.3.0.tar.gz:

Publisher: release.yml on mitsuhiko/sloppy-xml-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sloppy_xml-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: sloppy_xml-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sloppy_xml-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b27398cf2bc1e9e262ab77aaf5c93ffa8ce3e4065604fe033900f30e5b9168c1
MD5 9cdca712cba8e0186ea4f05bf245bf47
BLAKE2b-256 8895f125e3e7b0c7c0cfabdd41970e46c1a41ad7ead9bf560cc02c9b090f0759

See more details on using hashes here.

Provenance

The following attestation bundles were made for sloppy_xml-0.3.0-py3-none-any.whl:

Publisher: release.yml on mitsuhiko/sloppy-xml-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page