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

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

2023-05-16 385
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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
|
2月前
|
数据采集 Python
Python实用记录(七):通过retinaface对CASIA-WebFace人脸数据集进行清洗，并把错误图路径放入txt文档
使用RetinaFace模型对CASIA-WebFace人脸数据集进行清洗，并将无法检测到人脸的图片路径记录到txt文档中。
zzy的aly
48 1
zzy的aly
|
2月前
|
Python
Python实用记录(六):如何打开txt文档并删除指定绝对路径下图片
这篇文章介绍了如何使用Python打开txt文档，删除文档中指定路径的图片，并提供了一段示例代码来展示这一过程。
zzy的aly
36 1
zzy的aly
|
2月前
|
数据处理 Python
Python实用记录(十):获取excel数据并通过列表的形式保存为txt文档、xlsx文档、csv文档
这篇文章介绍了如何使用Python读取Excel文件中的数据，处理后将其保存为txt、xlsx和csv格式的文件。
zzy的aly
110 3
Python实用记录(十):获取excel数据并通过列表的形式保存为txt文档、xlsx文档、csv文档
zzy的aly
|
2月前
|
计算机视觉 Python
Python实用记录(九):将不同的图绘制在一起、将不同txt文档中的数据绘制多条折线图
这篇文章介绍了如何使用Python的OpenCV库将多张图片合并为一张图片显示，以及如何使用matplotlib库从不同txt文档中读取数据并绘制多条折线图。
zzy的aly
50 3
Python实用记录(九):将不同的图绘制在一起、将不同txt文档中的数据绘制多条折线图
众所周知
|
1月前
|
JSON 测试技术 持续交付
自动化测试与脚本编写：Python实践指南
自动化测试与脚本编写：Python实践指南
众所周知
41 1
AIweker
|
2月前
|
人工智能 开发者 Python
python读取word文档 | AI应用开发
在RAG系统中，构建知识库时需读取多种外部文档，其中Word文档较为常见。本文介绍如何使用`python-docx`库读取Word文档（.docx格式）中的标题、段落、表格和图片等内容。首先通过`pip install python-docx`安装库，然后利用提供的接口提取所需信息。尽管该库功能强大，但在识别标题样式时需自定义逻辑，并且仅提供图片的URI而非直接加载。示例代码展示了读取文本、识别标题、读取表格及获取图片URI的方法。【10月更文挑战第2天】
AIweker
104 2
qa浪涛
|
2月前
|
存储 Python
Python中的多进程通信实践指南
Python中的多进程通信实践指南
qa浪涛
32 0
bruce_xiaowei
|
2月前
|
IDE 开发工具 Python
Python自动化操作word--批量替换word文档中的文字
Python自动化操作word--批量替换word文档中的文字
bruce_xiaowei
192 0
一行玩python
|
Python
学会Python自动制作Word，将看到一个5天4位数的赚钱机会
周二推了一篇Python编辑ppt的文章，行哥告诉读者学会重复处理PPT接单兼职更加高效。因为Python是一种生产工具，掌握生产工具后就应该拿去尝试赚钱。
一行玩python
259 0
学会Python自动制作Word，将看到一个5天4位数的赚钱机会
游客qf4jmczx4xu2y
|
21天前
|
人工智能 数据可视化 数据挖掘
探索Python编程：从基础到高级
在这篇文章中，我们将一起深入探索Python编程的世界。无论你是初学者还是有经验的程序员，都可以从中获得新的知识和技能。我们将从Python的基础语法开始，然后逐步过渡到更复杂的主题，如面向对象编程、异常处理和模块使用。最后，我们将通过一些实际的代码示例，来展示如何应用这些知识解决实际问题。让我们一起开启Python编程的旅程吧！
游客qf4jmczx4xu2y
49 5

热门文章

最新文章

  • 1
    使用Python实现智能食品库存管理的深度学习模型
  • 2
    Python实现常用办公文件格式转换
  • 3
    猫狗宠物识别系统Python+TensorFlow+人工智能+深度学习+卷积网络算法
  • 4
    pyenv 管理多个 Python 版本(1)
  • 5
    Python编程数据结构的深入理解
  • 6
    Python的标准库
  • 7
    利用Python内置函数实现的冒泡排序算法
  • 8
    使用Python实现智能食品消费习惯分析的深度学习模型
  • 9
    使用Python实现深度学习模型的分布式训练
  • 10
    在 Python 中，如何将日期时间类型转换为字符串？
  • 1
    Python学习的自我理解和想法（10）
    29
  • 2
    探索企业文件管理软件：Python中的哈希表算法应用
    22
  • 3
    文件管理系统中基于 Python 语言的二叉树查找算法探秘
    33
  • 4
    分布式Python计算服务MaxFrame使用心得
    25
  • 5
    [python 技巧] 快速掌握Streamlit: python快速原型开发工具
    93
  • 6
    如何在vim里直接运行python程序
    12
  • 7
    10个必备Python调试技巧：从pdb到单元测试的开发效率提升指南
    43
  • 8
    探索局域网电脑监控软件：Python算法与数据结构的巧妙结合
    42
  • 9
    Python列表
    27
  • 10
    云产品评测：MaxFrame — 分布式Python计算服务的最佳实践与体验
    30

    • 相关课程

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

    • 相关电子书

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

    • 相关实验场景

    更多
  • 用Python画圣诞树
  • 语言入门-1：环境构建
  • Python选择及循环结构
  • 云端Python及基本操作
  • Python网络通信程序典型应用
  • 实验手册指导文档

    • 推荐镜像

    更多
  • python-release
  • nodejs-release
  • debian-cd
    • 下一篇
    DataWorks售前咨询