快速生成定制化的Word文档：Python实践指南

1.1. 前言

众所周知，安服工程师又叫做Word工程师，在打工或者批量SRC的时候，假如产出许多，又需求一个一个的写陈述的情况下会十分的折磨人，因而查了一些相关的材料，发现运用python的docxtpl库批量写陈述作用很不错，记载一下。

1.2. 介绍

docxtpl 是一个用于生成 Microsoft Word 文档的模板引擎库，它结合了 docx 模块和 Jinja2 模板引擎，运用户可以运用 Microsoft Word 模板文件并在其中填充动态数据。它供给了一种方便的方法来生成个性化的 Word 文档，并支持条件句子、循环句子和变量等操控结构，以满意不同的文档生成需求。

官方GitHub地址：github.com/elapouya/py…

官方文档地址：docxtpl.readthedocs.io/en/latest/

简单来说：便是创建一个类似Jinja2语法的模板文档，然后往里边动态填充内容就可以了

安装：

pip3 install docxtpl

1.3. 根底运用

from docxtpl import DocxTemplate
doc = DocxTemplate("test.docx")
context = {'whoami': "d4m1ts"}
doc.render(context)
doc.save("generated_doc.docx")

其中，test.docx内容如下：

生成后的成果如下：

1.4. 案例介绍

1.4.1. 需求假设

写一份不考虑漂亮的漏扫陈述，需求有计算成果图和缝隙概况，每个缝隙包含缝隙名、缝隙地址、缝隙等级、缝隙损害、复现进程、修正主张六个部分。

1.4.2. 模板文档预备

编写的模板文档如下，运用到了常见的if、for、赋值等，保存为template.docx，后续只需求向里边填充数据即可。

1.4.3. 数据结构分析

传入数据需求一串json字符串，因而咱们根据模板文档梳理好json结构，然后传入即可。

梳理好的数据结构如下：

{
  "饼图": "111",
  "柱状图": "222",
  "缝隙简报": [
    {
      "缝隙名": "测验缝隙名1",
      "缝隙等级": "高危"
    }
  ],
  "缝隙概况": [
    {
      "缝隙名": "测验缝隙名1",
      "缝隙地址": "http://blog.gm7.org/",
      "缝隙等级": "高危",
      "缝隙损害": "损害XXX",
      "复现进程": "先xxx，再xxx，最终xxx",
      "修正主张": "更新到最新版别即可"
    }
  ]
}

编写代码测验一下可行性：

from docxtpl import DocxTemplate
doc = DocxTemplate("template.docx")
context = {
      "饼图": "111",
      "柱状图": "222",
      "缝隙简报": [
        {
          "缝隙名": "测验缝隙名1",
          "缝隙等级": "高危"
        },
        {
          "缝隙名": "测验缝隙名2",
          "缝隙等级": "严峻"
        },
        {
          "缝隙名": "测验缝隙名2",
          "缝隙等级": "中危"
        }
      ],
      "缝隙概况": [
        {
          "缝隙名": "测验缝隙名1",
          "缝隙地址": "http://blog.gm7.org/",
          "缝隙等级": "高危",
          "缝隙损害": "损害XXX",
          "复现进程": "先xxx，再xxx，最终xxx",
          "修正主张": "更新到最新版别即可"
        },
        {
          "缝隙名": "测验缝隙名2",
          "缝隙地址": "http://bblog.gm7.org/",
          "缝隙等级": "严峻",
          "缝隙损害": "损害XXX",
          "复现进程": "先xxx，再xxx，最终xxx",
          "修正主张": "更新到最新版别即可"
        },
        {
          "缝隙名": "测验缝隙名3",
          "缝隙地址": "http://cblog.gm7.org/",
          "缝隙等级": "中危",
          "缝隙损害": "损害XXX",
          "复现进程": "先xxx，再xxx，最终xxx",
          "修正主张": "更新到最新版别即可"
        }
      ]
    }
doc.render(context)
doc.save("generated_doc.docx")

很好，达到了预期的作用。

1.4.4. 加入图表

在上面的进程中，内容几乎是没问题了，可是图表还是没有展现出来。生成图表咱们运用plotly这个库，并将生成内容写入ByteIO。

相关代码如下：

import plotly.graph_objects as go
from io import BytesIO
def generatePieChart(title: str, labels: list, values: list, colors: list):
    """
    生成饼图
    https:///post/6911701157647745031#heading-3
    https:///post/6950460207860449317#heading-5
    :param title: 饼图标题
    :param labels: 饼图标签
    :param values:  饼图数据
    :param colors:  饼图每块的色彩
    :return:
    """
    # 根底饼图
    fig = go.Figure(data=[go.Pie(
        labels=labels,
        values=values,
        hole=.4,  # 中心环巨细
        insidetextorientation="horizontal"
    )])
    # 更新色彩
    fig.update_traces(
        textposition='inside',  # 文本显示方位
        hoverinfo='label+percent',  # 悬停信息
        textinfo='label+percent', # 饼图中显示的信息
        textfont_size=15,
        marker=dict(colors=colors)
    )
    # 更新标题
    fig.update_layout(
        title={   # 设置整个标题的称号和方位
            "text": title,
            "y": 0.96,  # y轴数值
            "x": 0.5,  # x轴数值
            "xanchor": "center",  # x、y轴相对方位
            "yanchor": "top"
        }
    )
    image_io = BytesIO()
    fig.write_image(image_io, format="png")
    return image_io
def generateBarChart(title: str, x: list, y: list):
    """
    生成柱状图
    https://cloud.tencent.com/developer/article/1817208
    https://blog.csdn.net/qq_25443541/article/details/115999537
    https://blog.csdn.net/weixin_45826022/article/details/122912484
    :param title: 标题
    :param x: 柱状图标签
    :param y:  柱状图数据
    :return:
    """
    # x轴长度最为18
    b = x
    x = []
    for i in b:
        if len(i) >= 18:
            x.append(f"{i[:15]}...")
        else:
            x.append(i)
    # 根底柱状图
    fig = go.Figure(data=[go.Bar(
        x=x,
        y=y,
        text=y,
        textposition="outside",
        marker=dict(color=["#3498DB"] * len(y)),
        width=0.3
    )])
    # 更新标题
    fig.update_layout(
        title={  # 设置整个标题的称号和方位
            "text": title,
            "y": 0.96,  # y轴数值
            "x": 0.5,  # x轴数值
            "xanchor": "center",  # x、y轴相对方位
            "yanchor": "top"
        },
        xaxis_tickangle=-45,  # 歪斜45度
        plot_bgcolor='rgba(0,0,0,0)'  # 布景透明
    )
    fig.update_xaxes(
        showgrid=False
    )
    fig.update_yaxes(
        zeroline=True,
        zerolinecolor="#17202A",
        zerolinewidth=1,
        showgrid=True,
        gridcolor="#17202A",
        showline=True
    )
    image_io = BytesIO()
    fig.write_image(image_io, format="png")
    return image_io

1.4.5. 最终成果

要刺进图片内容，代码语法如下：

myimage = InlineImage(tpl, image_descriptor='test_files/python_logo.png', width=Mm(20), height=Mm(10))

完整代码如下：

from docxtpl import DocxTemplate, InlineImage
from docx.shared import Mm
import plotly.graph_objects as go
from io import BytesIO
def generatePieChart(title: str, labels: list, values: list, colors: list):
    """
    生成饼图
    https:///post/6911701157647745031#heading-3
    https:///post/6950460207860449317#heading-5
    :param title: 饼图标题
    :param labels: 饼图标签
    :param values:  饼图数据
    :param colors:  饼图每块的色彩
    :return:
    """
    # 根底饼图
    fig = go.Figure(data=[go.Pie(
        labels=labels,
        values=values,
        hole=.4,  # 中心环巨细
        insidetextorientation="horizontal"
    )])
    # 更新色彩
    fig.update_traces(
        textposition='inside',  # 文本显示方位
        hoverinfo='label+percent',  # 悬停信息
        textinfo='label+percent',  # 饼图中显示的信息
        textfont_size=15,
        marker=dict(colors=colors)
    )
    # 更新标题
    fig.update_layout(
        title={  # 设置整个标题的称号和方位
            "text": title,
            "y": 0.96,  # y轴数值
            "x": 0.5,  # x轴数值
            "xanchor": "center",  # x、y轴相对方位
            "yanchor": "top"
        }
    )
    image_io = BytesIO()
    fig.write_image(image_io, format="png")
    return image_io
def generateBarChart(title: str, x: list, y: list):
    """
    生成柱状图
    https://cloud.tencent.com/developer/article/1817208
    https://blog.csdn.net/qq_25443541/article/details/115999537
    https://blog.csdn.net/weixin_45826022/article/details/122912484
    :param title: 标题
    :param x: 柱状图标签
    :param y:  柱状图数据
    :return:
    """
    # x轴长度最为18
    b = x
    x = []
    for i in b:
        if len(i) >= 18:
            x.append(f"{i[:15]}...")
        else:
            x.append(i)
    # 根底柱状图
    fig = go.Figure(data=[go.Bar(
        x=x,
        y=y,
        text=y,
        textposition="outside",
        marker=dict(color=["#3498DB"] * len(y)),
        width=0.3
    )])
    # 更新标题
    fig.update_layout(
        title={  # 设置整个标题的称号和方位
            "text": title,
            "y": 0.96,  # y轴数值
            "x": 0.5,  # x轴数值
            "xanchor": "center",  # x、y轴相对方位
            "yanchor": "top"
        },
        xaxis_tickangle=-45,  # 歪斜45度
        plot_bgcolor='rgba(0,0,0,0)'  # 布景透明
    )
    fig.update_xaxes(
        showgrid=False
    )
    fig.update_yaxes(
        zeroline=True,
        zerolinecolor="#17202A",
        zerolinewidth=1,
        showgrid=True,
        gridcolor="#17202A",
        showline=True
    )
    image_io = BytesIO()
    fig.write_image(image_io, format="png")
    return image_io
doc = DocxTemplate("template.docx")
context = {
    "饼图": InlineImage(doc, image_descriptor=generatePieChart(
        title="缝隙数量",
        labels=["严峻", "高危", "中危", "低危"],
        values=[1, 1, 1, 0],
        colors=["#8B0000", "red", "orange", "aqua"]
    ), width=Mm(130)),
    "柱状图": InlineImage(doc, image_descriptor=generateBarChart(
        title="缝隙类型",
        x=["测验缝隙名1", "测验缝隙名2", "测验缝隙名3"],
        y=[1, 1, 1]
    ), width=Mm(130)),
    "缝隙简报": [
        {
            "缝隙名": "测验缝隙名1",
            "缝隙等级": "高危"
        },
        {
            "缝隙名": "测验缝隙名2",
            "缝隙等级": "严峻"
        },
        {
            "缝隙名": "测验缝隙名2",
            "缝隙等级": "中危"
        }
    ],
    "缝隙概况": [
        {
            "缝隙名": "测验缝隙名1",
            "缝隙地址": "http://blog.gm7.org/",
            "缝隙等级": "高危",
            "缝隙损害": "损害XXX",
            "复现进程": "先xxx，再xxx，最终xxx",
            "修正主张": "更新到最新版别即可"
        },
        {
            "缝隙名": "测验缝隙名2",
            "缝隙地址": "http://bblog.gm7.org/",
            "缝隙等级": "严峻",
            "缝隙损害": "损害XXX",
            "复现进程": "先xxx，再xxx，最终xxx",
            "修正主张": "更新到最新版别即可"
        },
        {
            "缝隙名": "测验缝隙名3",
            "缝隙地址": "http://cblog.gm7.org/",
            "缝隙等级": "中危",
            "缝隙损害": "损害XXX",
            "复现进程": "先xxx，再xxx，最终xxx",
            "修正主张": "更新到最新版别即可"
        }
    ]
}
doc.render(context)
doc.save("generated_doc.docx")

成果如下：