编程开源技术交流，分享技术与知识

网站首页 > 开源技术 正文

如何用docxtpl自动生成和修改Word文档

wxchong 2024-09-03 02:10:46 开源技术 9 ℃ 0 评论

背景

Python是一门易学易用、代码简洁的编程语言，广泛应用于各个领域，尤其适合用于办公自动化。

通过使用Python实现办公自动化，不仅能够大幅提升工作效率，还能有效减少重复性的任务。Python的应用场景非常广泛，包括操作Word、Excel、PPT，处理文本和文件，自动发送邮件，进行网页自动化操作，定时任务调度，图像处理与识别，自动生成报表，以及整合API和外部系统等。这些功能的集成使用，可以显著提高办公效率。

在Python生态系统中，python-docx、jinja2 和 python-docx-template 等库为我们提供了强大且灵活的工具，使得我们能够以编程的方式轻松创建和修改Word文档，从而进一步优化办公自动化流程。

python-docx

python-docx是一个Python库，用于创建和修改Microsoft Word文档。

它可以用来添加文本、插入图片、创建表格、设置格式和样式等。

这个库特别适合需要自动生成报告或处理文档的应用。

from docx import Document
from docx.shared import Inches

# 创建文档对象
document = Document()

# 添加标题
document.add_heading('文档标题DHub', 0)

# 添加段落，包含粗体和斜体文本
p = document.add_paragraph('这是一个普通段落，包含一些 ')
p.add_run('粗体').bold = True
p.add_run(' 和一些 ')
p.add_run('斜体。').italic = True

# 添加一级标题
document.add_heading('一级标题', level=1)

# 添加引用样式的段落
document.add_paragraph('强烈引用', style='Intense Quote')

# 添加无序列表项
document.add_paragraph('无序列表项', style='List Bullet')

# 添加有序列表项
document.add_paragraph('有序列表项', style='List Number')

# 添加图片，并设置宽度
document.add_picture('./images/monty-truth.png', width=Inches(1.25))

# 添加表格
records = (
    (3, '101', '火腿'),
    (7, '422', '鸡蛋'),
    (4, '631', '火腿、火腿、鸡蛋和火腿')
)

table = document.add_table(rows=1, cols=3)
hdr_cells = table.rows[0].cells
hdr_cells[0].text = '数量'
hdr_cells[1].text = '编号'
hdr_cells[2].text = '描述'
for qty, id, desc in records:
    row_cells = table.add_row().cells
    row_cells[0].text = str(qty)
    row_cells[1].text = id
    row_cells[2].text = desc

# 添加分页符
document.add_page_break()

# 保存文档
document.save('demo.docx')

输出：

python-docx创建文档功能强大，但不适用于修改文档。

jinja2

Jinja2 是一个Python模板引擎，用于生成动态网页内容。

它允许创建包含占位符的模板，这些占位符在渲染时会被实际数据替换。

主要功能：

  1. 动态内容生成：通过模板引擎，可以根据用户输入或其他数据生成HTML、XML等标记内容。
  2. HTML 转义：自动处理特殊字符，防止 XSS 攻击。
  3. 模板继承：可以从基础模板继承并扩展，避免重复代码，提高开发效率。

安装：

pip install jinja2

示例：

假设要创建一个显示购物清单的网页，就可以使用Jinja2来动态生成包含购物项的HTML页面。

app.py：

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/')
def index():
    items = [
        {'name': '苹果', 'quantity': 5},
        {'name': '香蕉', 'quantity': 3},
        {'name': '牛奶', 'quantity': 2}
    ]
    return render_template('shopping_list.html', items=items)

if __name__ == '__main__':
    app.run(debug=True)

templates/shopping_list.html：

<!DOCTYPE html>
<html>
<head>
    <title>购物清单</title>
</head>
<body>
    <h1>我的购物清单</h1>
    <ul>
        {% for item in items %}
        <li>{{ item.name }} - {{ item.quantity }} 个</li>
        {% endfor %}
    </ul>
</body>
</html>

在这个示例中，我们有一个 Flask 路由 /，它将一个购物项列表传递给模板 shopping_list.html。

模板使用 Jinja2 的循环语法 {% for item in items %} 来动态生成每个购物项的列表。

这样，每次访问页面时，都会显示当前的购物清单。

python-docx-template

虽然python-docx在创建文档方面非常强大，但它在修改现有文档时有一定的局限性。

python-docx-template允许用户利用熟悉的 Word 界面创建模板文档，并通过jinja2`的模板语法动态替换和修改内容。

详细文档请参考：python-docx-template

这个包结合了以下两个库：

  • python-docx：用于读取、写入和创建文档
  • jinja2：用于管理模板中的标签

实现原理：

1、使用Microsoft Word创建所需的文档样本，包括图片、目录、页脚、页眉、变量等。

2、在文档中插入类似 Jinja2 的标签，并将文档保存为.docx文件，作为模板文件。

3、使用python-docx-template从模板和相关的上下文变量生成多个Word文档。

Jinja2-like 语法

标签用法

  • 段落: {%p jinja2_tag %}
  • 表格行: {%tr jinja2_tag %}
  • 表格列: {%tc jinja2_tag %}
  • 文本运行: {%r jinja2_tag %}

变量显示

  • 字符串变量: {{ <var> }}
  • 富文本变量: {{r <var> }}

注释

  • 段落注释: {#p 注释 #}
  • 表格行注释: {#tr 注释 #}
  • 表格列注释: {#tc 注释 #}

合并与分隔文本

  • 合并: {%- if condition -%} ... {%- endif -%}
  • 分隔: 使用 ENTER 或 SHIFT+ENTER

转义字符

  • 转义符: {_%, %_} 和 {_{, }_}

表格

  • 横向合并: {% colspan <var> %}
  • 纵向合并: {% hm %} 和 {% vm %}
  • 单元格背景色: {% cellbg <var> %}

富文本

  • 创建: RichText('text', font='font_name')
  • 添加链接: 使用 RichText 并 url_id

图片

  • 插入图片: {{ <var> }}
  • myimage = InlineImage(tpl, 'image_path.png', width=Mm(20), height=Mm(10))

子文档

  • 合并子文档:
  • tpl = DocxTemplate('template.docx')
    sd = tpl.new_subdoc('subdoc.docx')

替换

  • 图片: tpl.replace_pic('dummy.jpg', 'new.jpg')
  • 媒体: tpl.replace_media('dummy_media.jpg', 'new_media.jpg')
  • 嵌入对象: tpl.replace_embedded('dummy.docx', 'new.docx')

获取未声明变量

tpl = DocxTemplate('template.docx')
tpl.render(context_dict)
set_of_variables = tpl.get_undeclared_template_variables()

多次渲染

  • 重置: tpl.reset_replacements()

特殊情况

  • Word 2016: 使用RichText处理空格和制表符

自定义 Jinja 过滤器

import jinja2

def multiply_by(value, by):
    return value * by

jinja_env = jinja2.Environment()
jinja_env.filters['multiply_by'] = multiply_by

一个完整示例

1、在 Word 中编辑模板

2、编写代码

from docxtpl import DocxTemplate, InlineImage
import datetime as dt
from docx2pdf import convert

# 指定输入和输出文件名
input_file = 'docs/invitation.docx'
output_file = 'docs/invitation.pdf'

# 创建文档对象
doc = DocxTemplate("inviteTmpl.docx")

# 创建上下文字典
context = {
    "todayStr": dt.datetime.now().strftime("%Y年%m月%d日"), 
    "recipientName": "亲爱的朋友",  
    "evntDtStr": "2024年08月09日",  
    "venueStr": "洛克大厦",  # 事件地点
    "senderName": "吴建明",  # 发送者名字
}

# 将图片插入到上下文中
context['bannerImg'] = InlineImage(doc, 'images/AIGC.png')

# 将上下文渲染到文档对象中
doc.render(context)

# 将文档对象保存为 Word 文件
doc.save(input_file)

# 将 DOCX 文件转换为 PDF
convert(input_file, output_file)

执行时长约为 3 秒：

3、生成效果如下：

生成word和pdf文件，pdf内容如右下图。2个文件格式完全一致。

小结

通过 python-docx、jinja2 和 python-docx-template，我们可以高效地创建和修改Word文档，并实现动态内容的自动生成。

无论是生成报告、创建网页内容，还是处理复杂的文档模板，这些工具都能为我们的工作提供强大的支持。

Tags：

猜你喜欢

本文暂时没有评论，来添加一个吧(●'◡'●)

欢迎 你 发表评论:

最近发表
标签列表
赣ICP备2023011894号-2