如何查看python-docx包生成的XML

时间:2019-05-29 09:18:23

标签: python xml docx python-docx

出于单元测试的目的,我想检查为Word段落生成的XML是否与解析HTML段落时所期望的一致。

如何提取XML本身而不是写入文件,解压缩文件并重新读取其中包含的word / document.xml文件?

例如

from docx import Document
import bs4

def add_parsed_html_to_paragraph(p, s):
    soup = bs4.BeautifulSoup(s)
    para = soup.find('p')
    for e in para.children:
        if type(e) == bs4.element.NavigableString:
            r = p.add_run(str(e))
        else:
            r = p.add_run(e.text)
        if e.name == 'sub':
            r.font.subscript = True
        elif e.name == 'sup':
            r.font.superscript = True


title = 'A formula: H<sub>2</sub>O.'

document = Document()
p = document.add_paragraph()
add_parsed_html_to_paragraph(p, title)

# ... Now I want to check p or document for the correct XML

1 个答案:

答案 0 :(得分:3)

oxml中,每个所谓的python-docx元素对象都具有一个.xml属性,正是这种使用情况。用于内部单元测试。

您所需要做的就是访问用于XML元素的内部变量,通常可以通过单击文档中该对象旁边的[source]链接来访问该变量,例如:https://python-docx.readthedocs.io/en/latest/api/text.html#paragraph-objects

单击该链接,您可以找到一个段落,底层XML元素在._p上可用。通常,它是不带名称空间前缀的元素的标记名,尽管有时是通用的._element。如果您需要猜测的话,后一种是一个不错的尝试。

因此使用它非常简单:

>>> paragraph._p.xml
<w:p>
  <w:pPr>
    <w:jc w:val="right"/>
  </w:pPr>
  <w:r>
    <w:t>Right-aligned</w:t>
  </w:r>
</w:p>

在单元测试实用程序中,有一种名为CXML(紧凑型XML)的配套领域特定语言(DSL),它使您可以轻松处理命名空间,否则会很麻烦。看起来像这样:

expected_xml = cxml.xml('w:p(w:pPr/w:jc{w:val=right},w:r/w:t"Right-aligned")')

您可以在整个单元测试中查看示例,例如:https://github.com/python-openxml/python-docx/blob/master/tests/text/test_paragraph.py#L113,并在此处使用“ python-docx”标签询问更具体的问题。