https://github.com/matthewandretaylor/xmlpydict
Parse xml to python dictionaries
https://github.com/matthewandretaylor/xmlpydict
dictionary parser python3 xml
Last synced: 4 months ago
JSON representation
Parse xml to python dictionaries
- Host: GitHub
- URL: https://github.com/matthewandretaylor/xmlpydict
- Owner: MatthewAndreTaylor
- License: mit
- Created: 2023-06-14T04:22:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-06T02:51:12.000Z (4 months ago)
- Last Synced: 2026-03-06T07:33:14.130Z (4 months ago)
- Topics: dictionary, parser, python3, xml
- Language: Python
- Homepage: https://pypi.org/project/xmlpydict
- Size: 70.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xmlpydict 📑
[](https://github.com/MatthewAndreTaylor/xml-to-pydict/actions/workflows/tests.yml)
[](https://github.com/MatthewAndreTaylor/xml-to-pydict)
[](https://pypi.org/project/xmlpydict/)
## Requirements
- `python 3.8+`
## Installation
To install xmlpydict, using pip:
```bash
pip install xmlpydict
```
## Quickstart
```py
>>> from xmlpydict import parse
>>> parse("")
{'package': {'xmlpydict': {'@language': 'python'}}}
>>> parse("Hello!")
{'person': {'@name': 'Matthew', '#text': 'Hello!'}}
```
## Goals
Create a consistent parsing strategy between XML and Python dictionaries using the specification found [here](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html). `xmlpydict` focuses on speed; see the benchmarks below.
### xmlpydict supports the following
[CDataSection](https://www.w3.org/TR/xml/#sec-cdata-sect): CDATA Sections are stored as {'#text': CData}.
[Comments](https://www.w3.org/TR/xml/#sec-comments): Comments are tokenized for corectness, but have no effect in what is returned.
[Element Tags](https://www.w3.org/TR/xml/#sec-starttags): Allows for duplicate attributes, however only the latest defined will be taken.
[Characters](https://www.w3.org/TR/xml/#charsets): Similar to CDATA text is stored as {'#text': Char} , however this text is stripped.
```py
# Empty tags are containers
>>> from xmlpydict import parse
>>> parse("")
{'a': None}
>>> parse("")
{'a': None}
>>> parse("").get('href')
None
```
### Attribute prefixing
```py
# Change prefix from default "@" with keyword argument attr_prefix
>>> from xmlpydict import parse
>>> parse('
', attr_prefix="$")
{"p": {"$width": "10", "$height": "5"}}
```
### Exceptions
```py
# Grammar and structure of the xml_content is checked while parsing
>>> from xmlpydict import parse
>>> parse(" a>")
xml.parsers.expat.ExpatError: not well-formed (invalid token): line 1, column 5
```
### Unsupported
Prolog / Enforcing Document Type Definition and Element Type Declarations
Entity Referencing
Namespaces