iXML is an iterative event-driven XML parser with a standard Python iterator interface.
From PyPI (stable):
pip install ixml
From Github (unstable):
pip install git+git://github.com/YAmikep/ixml.git#egg=ixml
iXML currently requires the lxml library because there is no fallback backend based on the standard library yet.
ixml.parse(data)
: iterator returning parsing events.ixml.items(data, path, builder_klass=DictObjectBuilder)
: iterator returning Python objects found under a specified path.
Notes:
data
must be a file like object.- The Python objects yielded by
ixml.items
are constructed from the parsing events by anObjectBuilder
(DictObjectBuilder
by default). Please make your own if you wish as long as it implements theObjectBuilder
interface (seeixml.builders.interface
). - Top-level
ixml
module tries to automatically find and import a suitable parsing backend. You can also explicitly import a required backend fromixml.backends
.
All examples will be using this XML document:
>>> XML = '''<?xml version="1.0" encoding="utf-8"?>
<cities>
<city name="Paris">
<country>France</country>
<language>French</language>
<attractions>
<monument>Eiffel Tower</monument>
<monument>Triumphal Arch</monument>
<museum>Louvre Museum</museum>
<museum>Quai Branly Museum</museum>
</attractions>
</city>
<city name="Dallas">
<country>USA</country>
<language>English</language>
<attractions>
<monument>Bank America Plaza</monument>
<monument>Dallas Theatre Center</monument>
<museum>Dallas Museum of Art</museum>
<museum>Old Red Museum</museum>
</attractions>
</city>
</cities>'''
- ixml.parse
Using the parse
function, you can react on individual events:
>>> import ixml
>>> from StringIO import StringIO
# The parse function takes a file like object
>>> data = StringIO(XML)
# Extract only the languages and the countries
>>> languages, countries = set(), set()
>>> for path, event, value in ixml.parse(data):
... if path == 'cities.city.language':
... languages.add(value)
... elif path == 'cities.city.country':
... countries.add(value)
>>> print languages, countries
set(['French', 'English']) set(['USA', 'France'])
Below are all the parsing events from parse
:
('cities', u'start', None)
('cities.city', u'start', None)
('cities.city.@name', 'data', 'Paris')
('cities.city.country', 'data', 'France')
('cities.city.language', 'data', 'French')
('cities.city.attractions', u'start', None)
('cities.city.attractions.monument', 'data', 'Eiffel Tower')
('cities.city.attractions.monument', 'data', 'Triumphal Arch')
('cities.city.attractions.museum', 'data', 'Louvre Museum')
('cities.city.attractions.museum', 'data', 'Quai Branly Museum')
('cities.city.attractions', u'end', None)
('cities.city', u'end', None)
('cities.city', u'start', None)
('cities.city.@name', 'data', 'Dallas')
('cities.city.country', 'data', 'USA')
('cities.city.language', 'data', 'English')
('cities.city.attractions', u'start', None)
('cities.city.attractions.monument', 'data', 'Bank America Plaza')
('cities.city.attractions.monument', 'data', 'Dallas Theatre Center')
('cities.city.attractions.museum', 'data', 'Dallas Museum of Art')
('cities.city.attractions.museum', 'data', 'Old Red Museum')
('cities.city.attractions', u'end', None)
('cities.city', u'end', None)
('cities', u'end', None)
- ixml.items
Another usage is having iXML yields native Python objects for a specific path with items
:
>>> import ixml
>>> from StringIO import StringIO
# The items function takes a file like object
>>> data = StringIO(XML)
>>> for city in ixml.items(data, 'cities.city'):
... do_something_with(city)
Below are the two "city" Python objects created. They are constructed as a dict by default.
You can change this behavior by providing another builder class to the items
function.
{
'country': 'France',
'@name': 'Paris',
'language': 'French',
'attractions': {
'museum': ['Louvre Museum', 'Quai Branly Museum'],
'monument': ['Eiffel Tower', 'Triumphal Arch']
}
}
{
'country': 'USA',
'@name': 'Dallas',
'language': 'English',
'attractions': {
'museum': ['Dallas Museum of Art', 'Old Red Museum'],
'monument': ['Bank America Plaza', 'Dallas Theatre Center']
}
}
Parsing events contain the XML tree context (path), an event and a value:
(path, event, value)
- The tree context (or path)
It is a simplified path format that:
- uses dots to define different levels
- uses namespace prefixes in the tag name
- ignores default namespaces (handled automatically behind the scene)
- uses @ for attributes
Examples:
- rss.channel.item
- rss.channel.item.@myAttr
- rss.channel.ns1:item.title
- The events
- "start" and "end" for containers:
<rss> # => ('rss', 'start', None)
<...>
</rss> # => ('rss', 'end', None)
- "data" for leaves and attributes:
<rss>
<title myAttr="Test">Some text</title> # => ('rss.title', 'data', 'Some text'), ('rss.title.@myAttr', 'data', 'Test')
</rss>
- The value
If there is a value, it will always be a string, None otherwise. There is currently no automatic conversion feature (to int, etc).
iXML can provide several implementation of the parsing by using backends located in ixml/backends:
lxmliterparse
: wrapper around the well known iterparse LXML function.
You can import a specific backend and use it in the same way as the top level library:
>>> import ixml.backends.lxmliterparse as ixml
>>> for path, event, value in ixml.parse(...):
... # ...
Importing the top level library as import ixml
tries to import all backends in order.
iXML currently requires the lxml library because there is no fallback backend based on the standard library yet.
The items
function uses an ObjectBuilder to build an object while parsing the data.
The events are passed into the event
function of the builder that accepts three parameters: path, event type and value.
The object being built is available at any time from the value
attribute.
You can make your own builder as long as it implements the ObjectBuilder interface (see ixml/builders/interface).
Clone and install testing dependencies:
$ python setup.py develop
$ pip install -r requirements_tests.txt
Ensure tests pass:
$ ./scripts/runtests.sh
Or using tox:
$ tox
ixml's People
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.