Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arve0/objectifiedetree
Dot notation for python's ElementTrees
https://github.com/arve0/objectifiedetree
Last synced: 8 days ago
JSON representation
Dot notation for python's ElementTrees
- Host: GitHub
- URL: https://github.com/arve0/objectifiedetree
- Owner: arve0
- License: other
- Created: 2015-05-18T10:00:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-04T18:23:23.000Z (over 6 years ago)
- Last Synced: 2024-11-11T13:09:02.849Z (9 days ago)
- Language: Python
- Size: 148 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# objectifiedetree
[![build-status-image]][travis]
[![pypi-version]][pypi]
[![wheel]][pypi]
## Overview
Wouldn't it be nice to use dot notation for ElementTrees? This package allows for:
```python
tree = ET.fromstring('')
a = tree.a
b = a.b
b.attrib['c'] == "asdf" # True
```
`tree.a` will be a [`Element`](https://docs.python.org/3.4/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element) with the extra [`__getattr__`](https://github.com/arve0/objectifiedetree/blob/master/objectifiedetree/__init__.py#L11-12) method. This means that you can use the element as you would do normally, but names in your XML that crases with python's methods or attributes must be accessed through `tree.find(xpath)`.
This package uses the python implementation of etree, which makes it slower than etree found in CPython. An alternative would be to monkey-patch the built-in with [forbiddenfruit](https://github.com/clarete/forbiddenfruit), but I haven't looked into this.
`objectifiedetree` has copied the python implementation of etree from [CPython 3.4 Lib/xml/etree](https://github.com/python/cpython/tree/master/Lib/xml/etree) and will probably only work with Python 3.4.
## Installation
Install using `pip`...
```bash
pip install objectifiedetree
```
## Example
```python
from objectifiedetree import *
tree = ET.parse('/path/to/file.xml')
# dot notation :-)
el = tree.xpath.to.your.element
# use normal etree attributes
print(el.attrib)
# access name crashes
attrib_el = el.find('./attrib')
```
## Development
Install dependencies and link development version of objectifiedetree to pip:
```bash
git clone https://github.com/arve0/objectifiedetree
cd objectifiedetree
pip install -r requirements.txt # install dependencies and objectifiedetree-package
```
### Testing
```bash
tox
```
### Build documentation locally
To build the documentation:
```bash
pip install -r docs/requirements.txt
make docs
```
[build-status-image]: https://secure.travis-ci.org/arve0/objectifiedetree.png?branch=master
[travis]: http://travis-ci.org/arve0/objectifiedetree?branch=master
[pypi-version]: https://pypip.in/version/objectifiedetree/badge.svg
[pypi]: https://pypi.python.org/pypi/objectifiedetree
[wheel]: https://pypip.in/wheel/objectifiedetree/badge.svg