Streams

A stream is an object that can be passed as an argument to Parser. It represents the raw XML data to be parsed.

File-like objects

Files open in binary mode, io.BytesIO, etc.

<root>Hello, world!</root>

>>> @xml_handle_element("root")
... def handler(node):
...     yield node.text

>>> with open("hello.xml", "rb") as stream:
...     Parser(stream).return_from(handler)
'Hello, world!'

Bytes-like objects

Any object supporting the buffer protocol: bytes, bytearray, memoryview, etc.

>>> @xml_handle_element("root")
... def handler(node):
...     yield node.text

>>> stream = b"<root>Hello, world!</root>"

>>> Parser(stream).return_from(handler)
'Hello, world!'

Iterables

Any iterable whose items are streams: lists, generators, etc.

>>> @xml_handle_element("root")
... def handler(node):
...     yield node.text

>>> def generate_stream():
...     yield b"<root>"
...     yield b"Hello, world!"
...     yield b"</root>"

>>> stream = generate_stream()

>>> Parser(stream).return_from(handler)
'Hello, world!'

More examples:

• HTTP streaming with Requests
• Infinite stream