AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

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

2023-05-16 366
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 1.1. 前言 众所周知， 安服工程师 又叫做 Word工程师 ，在打工或者批量SRC的时候，如果产出很多，又需要一个一个的写报告的情况下会非常的折磨人，因此查了一些相关的资料，发现使用python的 docxtpl 库批量写报告效果很不错，记录一下。 1.2. 介绍 docxtpl 是一个用于生成 Microsoft Word 文档的模板引擎库，它结合了 docx

1.1. 前言

众所周知，安服工程师又叫做Word工程师，在打工或者批量SRC的时候，如果产出很多，又需要一个一个的写报告的情况下会非常的折磨人，因此查了一些相关的资料，发现使用python的docxtpl库批量写报告效果很不错，记录一下。

1.2. 介绍

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

官方GitHub地址：https://github.com/elapouya/python-docx-template

官方文档地址：https://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内容如下：

test.docx

生成后的结果如下：

gen

1.4. 案例介绍

1.4.1. 需求假设

写一份不考虑美观的漏扫报告，需要有统计结果图和漏洞详情，每个漏洞包括漏洞名、漏洞地址、漏洞等级、漏洞危害、复现过程、修复建议六个部分。

1.4.2. 模板文档准备

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

template

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")

很好，达到了预期的效果。

res

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://juejin.cn/post/6911701157647745031#heading-3
    https://juejin.cn/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://juejin.cn/post/6911701157647745031#heading-3
    https://juejin.cn/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")

结果如下：

result

文章标签：
Python
搜索推荐
安全
数据格式
JSON
关键词：
Python实践指南
Python文档
Python Word
word Python
word文档Python
initsec
目录
相关文章
zzy的aly
|
27天前
|
数据采集 Python
Python实用记录(七):通过retinaface对CASIA-WebFace人脸数据集进行清洗，并把错误图路径放入txt文档
使用RetinaFace模型对CASIA-WebFace人脸数据集进行清洗，并将无法检测到人脸的图片路径记录到txt文档中。
zzy的aly
36 1
zzy的aly
|
27天前
|
Python
Python实用记录(六):如何打开txt文档并删除指定绝对路径下图片
这篇文章介绍了如何使用Python打开txt文档，删除文档中指定路径的图片，并提供了一段示例代码来展示这一过程。
zzy的aly
26 1
zzy的aly
|
26天前
|
数据处理 Python
Python实用记录(十):获取excel数据并通过列表的形式保存为txt文档、xlsx文档、csv文档
这篇文章介绍了如何使用Python读取Excel文件中的数据，处理后将其保存为txt、xlsx和csv格式的文件。
zzy的aly
44 3
Python实用记录(十):获取excel数据并通过列表的形式保存为txt文档、xlsx文档、csv文档
zzy的aly
|
26天前
|
计算机视觉 Python
Python实用记录(九):将不同的图绘制在一起、将不同txt文档中的数据绘制多条折线图
这篇文章介绍了如何使用Python的OpenCV库将多张图片合并为一张图片显示，以及如何使用matplotlib库从不同txt文档中读取数据并绘制多条折线图。
zzy的aly
41 3
Python实用记录(九):将不同的图绘制在一起、将不同txt文档中的数据绘制多条折线图
众所周知
|
10天前
|
JSON 测试技术 持续交付
自动化测试与脚本编写：Python实践指南
自动化测试与脚本编写：Python实践指南
众所周知
16 1
AIweker
|
29天前
|
人工智能 开发者 Python
python读取word文档 | AI应用开发
在RAG系统中，构建知识库时需读取多种外部文档，其中Word文档较为常见。本文介绍如何使用`python-docx`库读取Word文档（.docx格式）中的标题、段落、表格和图片等内容。首先通过`pip install python-docx`安装库，然后利用提供的接口提取所需信息。尽管该库功能强大，但在识别标题样式时需自定义逻辑，并且仅提供图片的URI而非直接加载。示例代码展示了读取文本、识别标题、读取表格及获取图片URI的方法。【10月更文挑战第2天】
AIweker
70 2
qa浪涛
|
26天前
|
存储 Python
Python中的多进程通信实践指南
Python中的多进程通信实践指南
qa浪涛
14 0
bruce刘晓伟-18435
|
1月前
|
IDE 开发工具 Python
Python自动化操作word--批量替换word文档中的文字
Python自动化操作word--批量替换word文档中的文字
bruce刘晓伟-18435
72 0
游客sjjs6jgz4gp7m1
|
9天前
|
设计模式 开发者 Python
Python编程中的设计模式：工厂方法模式###
本文深入浅出地探讨了Python编程中的一种重要设计模式——工厂方法模式。通过具体案例和代码示例，我们将了解工厂方法模式的定义、应用场景、实现步骤以及其优势与潜在缺点。无论你是Python新手还是有经验的开发者，都能从本文中获得关于如何在实际项目中有效应用工厂方法模式的启发。 ###
游客sjjs6jgz4gp7m1
85 61
土木林森
|
2天前
|
存储 人工智能 数据挖掘
从零起步，揭秘Python编程如何带你从新手村迈向高手殿堂
【10月更文挑战第32天】Python，诞生于1991年的高级编程语言，以其简洁明了的语法成为众多程序员的入门首选。从基础的变量类型、控制流到列表、字典等数据结构，再到函数定义与调用及面向对象编程，Python提供了丰富的功能和强大的库支持，适用于Web开发、数据分析、人工智能等多个领域。学习Python不仅是掌握一门语言，更是加入一个充满活力的技术社区，开启探索未知世界的旅程。
土木林森
11 5

热门文章

最新文章

  • 1
    关于python3.9安装Airtest跑脚本“jinja2”报错的问题说明
  • 2
    [Spark][Python]Mapping Single Rows to Multiple Pairs
  • 3
    Python---map/reduce
  • 4
    python3.4自带的pip怎样修改默认源
  • 5
    Python 技术篇-mac下安装、卸载pip方法
  • 6
    Python--字典
  • 7
    Python实现冒泡排序
  • 8
    python set(集合)
  • 9
    还在用Alpine作为你Docker的Python开发基础镜像？其实Ubuntu更好一点
  • 10
    ZhuSuan 是建立在Tensorflow上的贝叶斯深层学习的 python 库
  • 1
    Python中的装饰器：提升代码可读性与复用性
    44
  • 2
    Python明确指定编码
    49
  • 3
    Github 2024-05-07 Python开源项目日报 Top10
    275
  • 4
    Python中的类与对象
    36
  • 5
    python中的异常与模块
    39
  • 6
    Python基础语法
    28
  • 7
    Python深度学习基于Tensorflow（7）视觉处理基础
    63
  • 8
    Python深度学习基于Tensorflow（6）神经网络基础
    54
  • 9
    Python深度学习基于Tensorflow（5）机器学习基础
    47
  • 10
    Python深度学习基于Tensorflow（4）Tensorflow 数据处理和数据可视化
    64

    • 相关课程

    更多
  • Python Web开发基础
  • Python爬虫实战
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 相关实验场景

    更多
  • Python新手入门
  • Python入门
  • Python选择及循环结构
  • Python新手入门（Anolis OS）
  • 实验手册指导文档
  • Python网络通信程序典型应用

    • 推荐镜像

    更多
  • python-release
  • nodejs-release
  • golang
    • 下一篇
    DataWorks智能数据建模全面公测开始啦！