某天我收到一个需求：希望能够用python对word文档进行一些处理，比如更换一些文字以及添加批注。
简单搜索后，我发现python-docx是一个处理docx文档的常用python库，因此我打算用它来进行进一步开发。
官方文档提供了一个简单的示例
from docx import Document
document = Document()
document.add_heading('Document Title', 0)
p = document.add_paragraph('A plain paragraph having some ')
p.add_run('bold').bold = True
p.add_run(' and some ')
p.add_run('italic.').italic = True
document.add_heading('Heading, level 1', level=1)
document.add_paragraph('Intense quote', style='Intense Quote')
document.add_paragraph(
'first item in unordered list', style='List Bullet'
)
document.add_paragraph(
'first item in ordered list', style='List Number'
)
document.save('demo.docx')
python-docx将文档抽象为document对象、paragraph对象以及run对象，提供了围绕这些对象进行简单处理的API
然而在文档中并没有出现关于批注操作的部分，我在搜寻一些文章后发现了在某个issue中提及了添加批注相关信息，然而还是没有得到具体的解决办法
docx文档底层是由XML文件组成的
其实Office当中其他文件后缀带X的文件也是由XML组成的，如xlsx、pptx等
我们可以将一个xx.docx文件的后缀名改为.rar然后将其手动解压，可以得到下面这些文件
image.png
在诸多文件当中主要用到的是document.xml文件，这里保存了文档的内容
打开一份document.xml文件，抛开header、footer、table以及其他特殊项，去掉样式等修饰项，一份朴素的docx文档主要可以分为三个部分：paragraph、run、text
<w:body>
<w:p>
<w:r>
<w:t>Test</w:t>
</w:r>
</w:p>
</w:body>
paragraph即段落，就是我们在word当中看到的一段。text即文本，就是真实的内容。run比较抽象，我们可以将其理解为片段，即语句的切分。
为了更好地理解run是什么，打开一篇word文档定位其中一句话
从诞生至今，50多年里基于数字光纤通信技术的光传送网构建起了全球通信的骨架。
让我们看看这篇文档解压之后的document.xml文件中对应的部分
<w:r w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>从诞生至今，</w:t>
</w:r>
<w:r w:rsidR="00350898" w:rsidRPr="00FD4CC6">
<w:rPr>...省略</w:rPr>
<w:t>50</w:t>
</w:r>
<w:r w:rsidR="00350898" w:rsidRPr="00FD4CC6">
<w:rPr>...省略</w:rPr>
<w:t>多年里</w:t>
</w:r>
<w:r w:rsidR="009C6184" w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>基于</w:t>
</w:r>
<w:r w:rsidR="00BB357F" w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>数字</w:t>
</w:r>
<w:r w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>光纤通信技术</w:t>
</w:r>
<w:r w:rsidR="009C6184" w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>的</w:t>
</w:r>
<w:r w:rsidR="009C6184" w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>光传送网</w:t>
</w:r>
<w:r w:rsidR="00475C4A" w:rsidRPr="00957159">
<w:rPr>...省略</w:rPr>
<w:t>构建起了全球通信的骨架。</w:t>
</w:r>
OK，我们可以看到原本完整的一句话在word中被拆分成了许多个<w:r>标签，这就是run，word切分run的规则很多，有的根据标点符号，有的根据中文分词，句子中如果存在不同样式的字词也会单独切分出来，因此我们很难预估一句话究竟会被分成几个片段。
在issue中搜索comment关键字发现在一个merge request上已经给出了添加批注的解决方案，可以通过paragraph对象上的add_comment方法给一个段落添加批注
d = docx.Document()
p = d.add_paragraph(‘paragraph ‘)
c = p.add_comment(‘comment’)
但这还是不符合我的需求，我的目标是精准添加到某个词或者短语上
打开这个贡献者的源码进行研究
其实就是在P标签内插入comment标签引用，同时添加comment标签到xx文件
同理我们可以在r标签内插入comment标签引用，同时添加comment标签到xx文件，这样就能实现给特定词添加批注的需求了
网友评论