完全流式XML解析器

时间:2018-10-25 12:20:17

标签: python xml soap python-requests lxml

我正在尝试使用GetAttachmentrequestslxml使用Exchange base64io Web服务。该服务在SOAP XML HTTP响应中返回base64编码的文件。文件内容包含在单个XML元素的一行中。 GetAttachment只是一个例子,但问题更普遍。

我想将解码后的文件内容直接流式传输到磁盘,而不必在任何时候将附件的全部内容存储在内存中,因为附件可能是几百MB。

我尝试过这样的事情:

r = requests.post('https://example.com/EWS/Exchange.asmx', data=..., stream=True)
with open('foo.txt', 'wb') as f:
    for action, elem in lxml.etree.iterparse(GzipFile(fileobj=r.raw)):
    if elem.tag == 't:Content':
        b64_encoder = Base64IO(BytesIO(elem.text))
        f.write(b64_encoder.read())

,但是lxml仍将附件的副本存储为elem.text。有什么办法可以创建一个完全流式XML解析器,该解析器也可以直接从输入流中流式传输元素的内容?

1 个答案:

答案 0 :(得分:7)

在这种情况下,请勿使用iterparseiterparse()方法只能发出元素的开始和结束事件,因此,当找到结束XML标签时,会向您提供元素中的任何 text

请使用SAX parser interface。这是XML解析库的通用标准,用于将解析的数据传递给内容处理程序。 ContentHandler.characters() callback以块为单位传递字符数据(假设实现的XML库实际上利用了这种可能性)。这是ElementTree API的一个较低级别的API,Python标准库已经捆绑了Expat解析器来驱动它。

因此流程变为:

  • 将传入的请求流包装在GzipFile中,以方便解压缩。或者,最好设置response.raw.decode_content = True并根据服务器设置的内容编码对请求库进行解压缩。
  • GzipFile实例或原始流传递给使用.parse() method创建的解析器的xml.sax.make_parser()。然后,解析器继续从流中分块读取数据。通过使用make_parser(),您首先可以启用诸如名称空间处理之类的功能(如果Exchange决定更改用于每个名称空间的短前缀,这可以确保您的代码不会中断)。
  • 使用XML数据块调用内容处理程序characters()方法;检查正确的元素启动事件,以便知道何时需要base64数据。您可以一次在chunks of (a multiple of) 4 characters中解码该base64数据,然后将其写入文件。我不会在这里使用base64io,只做自己的分块。

一个简单的内容处理程序可以是:

from xml.sax import handler
from base64 import b64decode

class AttachmentContentHandler(handler.ContentHandler):
    types_ns = 'http://schemas.microsoft.com/exchange/services/2006/types'

    def __init__(self, filename):
        self.filename = filename

    def startDocument(self):
        self._buffer = None
        self._file = None

    def startElementNS(self, name, *args):
        if name == (self.types_ns, 'Content'):
            # we can expect base64 data next
            self._file = open(self.filename, 'wb')
            self._buffer = []

    def endElementNS(self, name, *args):
        if name == (self.types_ns, 'Content'):
            # all attachment data received, close the file
            try:
                if self._buffer:
                    raise ValueError("Incomplete Base64 data")
            finally:
                self._file.close()
                self._file = self._buffer = None

    def characters(self, data):
        if self._buffer is None:
            return
        self._buffer.append(data)
        self._decode_buffer()

    def _decode_buffer(self):
        remainder = ''
        for data in self._buffer:
            available = len(remainder) + len(data)
            overflow = available % 4
            if remainder:
                data = (remainder + data)
                remainder = ''
            if overflow:
                remainder, data = data[-overflow:], data[:-overflow]
            if data:
                self._file.write(b64decode(data))
        self._buffer = [remainder] if remainder else []

,您将像这样使用它:

import requests
from xml.sax import make_parser, handler

parser = make_parser()
parser.setFeature(handler.feature_namespaces, True)
parser.setContentHandler(AttachmentContentHandler('foo.txt'))

r = requests.post('https://example.com/EWS/Exchange.asmx', data=..., stream=True)
r.raw.decode_content = True  # if content-encoding is used, decompress as we read
parser.parse(r.raw)

这会将输入的XML解析为最大64KB(默认为IncrementalParser buffer size),因此附件数据最多可解码为48KB的原始数据块。

我可能会扩展内容处理程序以获取目标目录,然后查找<t:Name>元素以提取文件名,然后使用该元素将数据提取为找到的每个附件的正确文件名。您还需要验证自己是否正在处理GetAttachmentResponse文档,并处理错误响应。