Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gatkin/declxml
Declarative XML processing for Python
https://github.com/gatkin/declxml
python python27 python3 xml xml-parser xml-processing xml-serializer
Last synced: 9 days ago
JSON representation
Declarative XML processing for Python
- Host: GitHub
- URL: https://github.com/gatkin/declxml
- Owner: gatkin
- License: mit
- Created: 2017-08-26T13:18:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-11-19T18:59:03.000Z (about 4 years ago)
- Last Synced: 2025-01-18T09:44:56.034Z (15 days ago)
- Topics: python, python27, python3, xml, xml-parser, xml-processing, xml-serializer
- Language: Python
- Homepage: https://declxml.readthedocs.io/en/latest/
- Size: 232 KB
- Stars: 37
- Watchers: 6
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# declxml - Declarative XML Processing
[](https://badge.fury.io/py/declxml)
[](https://pypi.org/project/declxml/)
[](https://gregscottatkin.visualstudio.com/declxml/_build/latest?definitionId=1)
[](https://codecov.io/gh/gatkin/declxml)
[](https://declxml.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/gatkin/declxml/blob/master/LICENSE)
XML processing made easy. No more writing and maintaining dozens or hundreds of lines of imperative serialization and parsing logic. With declxml, you declaratively define the structure of your XML document and let declxml handle the rest.
## Installation
Install using either pip
```bash
pip install declxml
```
or [Pipenv](https://docs.pipenv.org/)
```bash
pipenv install declxml
```
## Documentation
For detailed documentation, see the project's [documentation page](http://declxml.readthedocs.io/).
## Usage
Given some XML to process
```xml
Robert A. Heinlein
1907
Starship Troopers
1959
Stranger in a Strange Land
1961
```
Create a declxml processor that defines the structure of the document
```python
>>> import declxml as xml
>>> author_processor = xml.dictionary('author', [
... xml.string('name'),
... xml.integer('birth-year'),
... xml.array(xml.dictionary('book', [
... xml.string('title'),
... xml.integer('published')
... ]), alias='books')
... ])
```
Then use that processor to parse the XML data
```python
>>> from pprint import pprint
>>> author_xml = """
...
... Robert A. Heinlein
... 1907
...
... Starship Troopers
... 1959
...
...
... Stranger in a Strange Land
... 1961
...
...
... """
>>> pprint(xml.parse_from_string(author_processor, author_xml))
{'birth-year': 1907,
'books': [{'published': 1959, 'title': 'Starship Troopers'},
{'published': 1961, 'title': 'Stranger in a Strange Land'}],
'name': 'Robert A. Heinlein'}
```
The same processor can also be used to serialize data to XML
```python
>>> author = {
... 'birth-year': 1920,
... 'name': 'Issac Asimov',
... 'books': [
... {
... 'title': 'I, Robot',
... 'published': 1950
... },
... {
... 'title': 'Foundation',
... 'published': 1951
... }
... ]
... }
>>> print(xml.serialize_to_string(author_processor, author, indent=' '))
Issac Asimov
1920
I, Robot
1950
Foundation
1951
```
Want to work with objects instead of dictionaries? You can do that with declxml too
```python
>>> class Author:
...
... def __init__(self):
... self.name = None
... self.birth_year = None
... self.books = []
...
... def __repr__(self):
... return 'Author(name=\'{}\', birth_year={}, books={})'.format(
... self.name, self.birth_year, self.books)
>>> class Book:
...
... def __init__(self):
... self.title = None
... self.published = None
...
... def __repr__(self):
... return 'Book(title=\'{}\', published={})'.format(self.title, self.published)
...
>>> author_processor = xml.user_object('author', Author, [
... xml.string('name'),
... xml.integer('birth-year', alias='birth_year'),
... xml.array(xml.user_object('book', Book, [
... xml.string('title'),
... xml.integer('published')
... ]), alias='books')
... ])
>>> xml.parse_from_string(author_processor, author_xml)
Author(name='Robert A. Heinlein', birth_year=1907, books=[Book(title='Starship Troopers', published=1959), Book(title='Stranger in a Strange Land', published=1961)])
```
What about namedtuples, you say? Those are extremely useful, and declxml lets you work with them as well
```python
>>> from collections import namedtuple
>>> Author = namedtuple('Author', ['name', 'birth_year', 'books'])
>>> Book = namedtuple('Book', ['title', 'published'])
>>> author_processor = xml.named_tuple('author', Author, [
... xml.string('name'),
... xml.integer('birth-year', alias='birth_year'),
... xml.array(xml.named_tuple('book', Book, [
... xml.string('title'),
... xml.integer('published')
... ]), alias='books')
... ])
>>> xml.parse_from_string(author_processor, author_xml)
Author(name='Robert A. Heinlein', birth_year=1907, books=[Book(title='Starship Troopers', published=1959), Book(title='Stranger in a Strange Land', published=1961)])
```