使用 odfpy 进行 Python 操作 OpenDocument（ODF）1.2 文件

odfpy 是一个用于读写 OpenDocument v1.2 文件的库，其主要目标是防止程序员创建无效的文件。如果程序员添加了无效元素、语法未知的属性，忘记添加必需的属性，或向不允许的元素添加文本，odfpy 会提供有效的防护措施。它本质上是建立在 XML 格式之上的抽象层，为以编程方式与 OpenDocument 文件（ODF 文件）中的 XML 元素进行交互提供了便捷的方法。

除了提供 API，odfpy 还包括一些实用脚本，如 csv2off（用逗号分隔的值创建 OpenDocument 电子表格）、mailodf（将 ODF 文件作为 HTML 存档发送电子邮件）等。此外，odfpy 还支持从 CSV 创建电子表格、将 ODF 转换为 XHTML 或 MHT 存档文件等功能。

安装

pip install odfpy

创建文档：

通过实例化 OpenDocumentChart、OpenDocumentDrawing、OpenDocumentImage、OpenDocumentPresentation、OpenDocumentSpreadsheet 或 OpenDocumentText 类之一，可以轻松启动文档。这些类提供了一系列方法，如 save()、write()、addPicture() 等，用于构建和保存文档内容。

示例

<code>from odf.opendocument import OpenDocumentText</code><code>from odf.style import Style, TextProperties</code><code>from odf.text import H, P, Span</code><code><br></code><code>textdoc = OpenDocumentText()</code><code><br></code><code><em># Styles</em></code><code>s = textdoc.styles</code><code>h1style = Style(name="Heading 1", family="paragraph")</code><code>h1style.addElement(TextProperties(attributes={'fontsize':"24pt",'fontweight':"bold" }))</code><code>s.addElement(h1style)</code><code><br></code><code><em># An automatic style</em></code><code>boldstyle = Style(name="Bold", family="text")</code><code>boldprop = TextProperties(fontweight="bold")</code><code>boldstyle.addElement(boldprop)</code><code>textdoc.automaticstyles.addElement(boldstyle)</code><code><br></code><code><em># Text</em></code><code>h=H(outlinelevel=1, stylename=h1style, text="My first text")</code><code>textdoc.text.addElement(h)</code><code>p = P(text="Hello world. ")</code><code>boldpart = Span(stylename=boldstyle, text="This part is bold. ")</code><code>p.addElement(boldpart)</code><code>p.addText("This is after bold.")</code><code>textdoc.text.addElement(p)</code><code><br></code><code>textdoc.save("myfirstdocument.odt")</code>

操作文档：

以编程方式操作 ODF 文件时，了解要更改的元素很重要。可以使用样式名称操作样式，但对于其他类型的元素，例如绘图元素或表单元素，则需要额外的属性。可以通过循环遍历文档元素来注释和更改 ODF 文件中的元素。

<code>from odf.opendocument import load</code><code>from odf import text, draw</code><code><br></code><code>infile = 'My-file.odt'</code><code>outfile = 'My-file{}.odt'.format(2)</code><code><br></code><code>doc = load(infile)</code><code>for item in doc.getElementsByType(draw.TextBox):</code><code> print(item.getAttribute('id'))</code><code> for child in item.childNodes:</code><code> print("\tchild:\t{}".format(child))</code><code><br></code><code>for item in doc.getElementsByType(draw.TextBox):</code><code> for child in item.getElementsByType(text.Span):</code><code> print("Text-span:\t{}".format(child))</code><code> if str(child) == "magic string":</code><code> child.setAttribute('id','some-id')</code><code><br></code><code>doc.save(outfile)</code>

示例：将一个文本替换为另外一个文本

<code>from odf import opendocument, text, teletype</code><code><br></code><code><br></code><code>document = opendocument.load('test.odt')</code><code><br></code><code>for element in document.getElementsByType(text.Span):</code><code> extracted_text = teletype.extractText(element)</code><code><br></code><code> if extracted_text.find('Replace this') != -1:</code><code> extracted_text = extracted_text.replace('Replace this', 'to this')</code><code><br></code><code> new_element = text.Span()</code><code> new_element.setAttribute('stylename', element.getAttribute('stylename'))</code><code> new_element.addText(extracted_text)</code><code><br></code><code> element.parentNode.insertBefore(new_element, element)</code><code> element.parentNode.removeChild(element)</code><code><br></code><code>document.save('result.odt')</code>

<code>参考文档：项目github：https:<em>//github.com/eea/odfpy</em></code>