如何使用 Python-Docx 将自定义 XML 添加到元素？

Question

我一直在尝试为我的表格获取文本换行，这在 python-docx 中没有实现。

到目前为止一切顺利，我已经隔离出 MS Word 添加<w:tblpPr w:leftFromText="180" w:rightFromText="180" w:vertAnchor="text" w:tblpY="1"/>作为孩子到表属性元素，所以我只需要将它注入到 python-docx 中的表中。

我真的很接近。 因为我能够在库中找到元素 class 来添加一个孩子。 但是，我的问题在于 w: 命名空间，因为它不允许我构建一个带有“:”字符的 Element 标记。 我尝试了两种方法，都失败了。

tblPrElement = Element('w:tblpPr ', {'w:leftFromText': '180', 'w:rightFromText': '180', 'w:vertAnchor': 'text', 'w:tblpY': '1' })

tblPrElement = parse_xml('<w:tblpPr w:leftFromText="180" w:rightFromText="180" w:vertAnchor="text" w:tblpY="1"/>')

如果我尝试省略 w: ...

document = Document()
table = document.add_table(rows=1, cols=3)
tblPrElement = parse_xml('<tblpPr leftFromText="180" rightFromText="180" vertAnchor="text" tblpY="1"/>')
table._tblPr.append(tblPrElement)

...然后生成文档，但 ms word 无法打开它，因为 xml 看起来像这样：

Answer 1

python-docx 有一个用于创建元素的qn方法。

def qn(tag):
    """
    Stands for "qualified name", a utility function to turn a namespace
    prefixed tag name into a Clark-notation qualified tag name for lxml. For
    example, ``qn('p:cSld')`` returns ``'{http://schemas.../main}cSld'``.
    """

它允许您键入带有命名空间前缀的 XML。

from docx.oxml.ns import qn

def set_text_wrap_around_table(table):
    tbl_properties_element = Element(qn('w:tblpPr'),
                           {
                              qn('w:leftFromText'): '180',
                              qn('w:rightFromText'): '180',
                              qn('w:vertAnchor'): 'text',
                              qn('w:tblpY'): '1'
                           })
    table._tblPr.append(tbl_properties_element)

如果您要创建的元素已经在 python-docx 中定义了 class，您可以使用docx.oxml.OxmlElement创建它，例如，您可以创建段落运行元素 class，如下所示：

from docx.oxml import OxmlElement

run_element = OxmlElement('w:r')

这具有将其可能的子项定义为属性等的额外好处。

Answer 2

如果要使用 lxml 到 append 和 XML 使用元素，则必须在创建元素时提供 python-docx 的命名空间 map（ docx.oxml.nsmap ）。

在标签名称中插入命名空间的语法是{namespacevalue}tagname 。

例如， <{http://schemas.openxmlformats.org/wordprocessingml/2006/main}tblpPr/>

下面是根据您的需要使用字符串格式插入命名空间值的示例。

tblPrElement = Element('{{{w}}}tblpPr'.format(w=nsmap['w']),
                           {'{{{w}}}leftFromText'.format(w=nsmap['w']): '180',
                            '{{{w}}}rightFromText'.format(w=nsmap['w']): '180',
                            '{{{w}}}vertAnchor'.format(w=nsmap['w']): 'text',
                            '{{{w}}}tblpY'.format(w=nsmap['w']): '1'},
                           nsmap)

请注意，它在w周围使用三重{ ，因为除了{w}用于插入命名空间值之外，我们还需要在最终字符串中的值周围使用{ }并转义 string.format 需要连续两个{{ }} 。

Answer 3

考虑 lxml 的QName()作为功能版本以避免字符串格式化：

from lxml import etree
...


def set_text_wrap_around_table(table): 
     tblPrElement = etree.Element(
         etree.QName(nsmap["w"], "tblpPr"),
         {
              etree.QName(nsmap["w"], "leftFromText"): '180', 
              etree.QName(nsmap["w"], "rightFromText"): '180', 
              etree.QName(nsmap["w"], "vertAnchor"): 'text', 
              etree.QName(nsmap["w"], "tblpY"): '1'
         },
         nsmap
     )

     table._tblPr.append(tblPrElement)