Skip to main content

A lightweight pythonic standard compliant streaming xml writer

Project description

streamingxmlwriter

License: LGPL-3 https://travis-ci.org/acsone/streamingxmlwriter.svg?branch=master https://coveralls.io/repos/acsone/streamingxmlwriter/badge.svg?branch=master&service=github

A lightweight pythonic standard compliant streaming xml writer.

from io import BytesIO

import streamingxmlwriter

stream = BytesIO()
with streamingxmlwriter.from_stream(stream) as writer:
    writer.start_namespace('myns', 'http://mynamespace.org/')
    with writer.element('myns:root', {'att1': '1'}):
        with writer.element('myns:child1'):
            writer.characters('text content')
        writer.comment(' a comment ')
        with writer.element('myns:child2'):
            writer.characters('text content')
        # shortcut for elements containing a single text node
        writer.text_element('myns:child3', 'text content', {'att2': '2'})

For more API examples, look at the documentation of the StreamingXMLWriter class in core.py.

Under the hood it generates SAX events to the standard xml.sax.saxutils.XMLGenerator. It also provides a from_sax_handler constructor so it can also be used to emit sax events for other purposes than outputing to an io stream.

Python 2 (2.7+) and python 3 (3.3+) are supported.

Supported XML features are:

  • elements
  • attributes
  • text
  • processing instructions
  • comments
  • selectable encoding
  • namespaces for elements and attributes, with or without prefix

Unsupported XML features (yet):

  • DOCTYPE declaration
  • entities
  • CDATA sections

Credits

Author

  • Stéphane Bidoul (ACSONE)

Maintainer

ACSONE SA/NV

This module is maintained by ACSONE SA/NV.

Project details


Release history Release notifications

This version
History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
streamingxmlwriter-1.0.0-py2.py3-none-any.whl (4.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Feb 17, 2016
streamingxmlwriter-1.0.0.tar.gz (7.1 kB) Copy SHA256 hash SHA256 Source None Feb 17, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page