最全总结 | 聊聊 Python 办公自动化之 Word（上）

1. 前言

日常自动化办公中，使用 Python 真的能做到事半功倍！

在上一个系列中，我们对 Python 操作 Excel 进行了一次全面总结

最全总结 | 聊聊 Python 办公自动化之 Excel（上）

最全总结 | 聊聊 Python 办公自动化之 Excel（中）

最全总结 | 聊聊 Python 办公自动化之 Excel（下）

从本篇文章开始，我们继续聊聊另外一种常见的文档格式：Word

2. 准备

Python 操作 Word 最常见的依赖库是：python-docx

所以，在开始操作之前，我们需要在虚拟环境下安装这个依赖库

# 安装依赖
pip3 install python-docx

3. 写入实战

我们需要了解一个 Word 文档的页面结构

它们分别是：

文档 - Document
章节 - Section
段落 - Paragraph
文字块 - Run

经常操作的数据类型包含：段落、标题、列表、图片、表格、样式

首先，使用 Document 创建一个文档对象，相当于创建一个空白文档

from docx import Document

# 1、新建一个空白文档
doc = Document()

然后，就可以往文档中写入数据了

使用文档对象的 add_heading(text,level) 方法可以写入标题

其中，第 1 个参数为标题内容，第 2 个参数代表标题的级别

比如：分别写入一级标题、二级标题、三级标题

# 2、新增内容
# 2.1 标题
# 分别写入一个一级标题，一个二级标题，一个三级标题
doc.add_heading('一级标题', 0)
doc.add_heading('二级标题', 1)
doc.add_heading('三级标题', 2)

段落 Paragraph 包含 3 类，分别是：

普通段落
自定义样式的段落
引用段落

默认情况下，使用文档对象的 add_paragraph(text,style) 方法来添加一个段落

普通段落：假如第二个参数 style 没有传入，则代表添加一个普通的段落

引用段落：对于引用段落，只需要指定段落样式为 Intense Quote 即可

# 2.2.1 新增普通段落
doc.add_paragraph("我是一个普通段落。")

# 2.2.3 新增一个引用段落
# 只需要指定样式为：Intense Quote
doc.add_paragraph('--我是一个引用段落--', style='Intense Quote')

自定义样式的段落：这里有 2 种实现方式

分别是：

创建一个空的段落对象，增加文字块 Run 的时候，同时指定字体样式
使用文档对象创建一个新的样式（或已经存在的样式），然后添加段落的时候，设置到第二个参数中

考虑到样式的样式的复用性，第 2 种方式可能更实用

对应的方法是：

document.styles.add_style(style_name,type)

以第 2 种实现方式为例，新增一个自定义样式的段落，设置段落的字体名称、大小、颜色、是否加粗、对齐方式等

PS：第 1 种实现方式，文末源码会提供

该方法第 2 个参数用来指定样式类型，包含 3 种

分别对应关系如下：

1：段落样式
2：字符样式
3：表格样式

def create_style(document, style_name, style_type, font_size=-1, font_color=None, font_name=None, align=None):
    """
    创建一个样式
    :param align:
    :param document:
    :param style_name: 样式名称
    :param style_type: 样式类型，1：段落样式, 2：字符样式, 3：表格样式
    :param font_name:
    :param font_color:
    :param font_size:
    :return:
    """
    if font_color is None:
        font_color = []

    # 注意：必须要判断样式是否存在，否则重新添加会报错
    style_names = [style.name for style in document.styles]
    if style_name in style_names:
        # print('样式已经存在，不需要重新添加！')
        return

    font_style = document.styles.add_style(style_name, style_type)

    # 字体大小
    if font_size != -1:
        font_style.font.size = Pt(font_size)

    # 字体颜色
    # 比如：[0xff,0x00,0x00]
    if font_color and len(font_color) == 3:
        font_style.font.color.rgb = RGBColor(font_color[0], font_color[1], font_color[2])

    # 对齐方式
    # 注意：段落、表格才有对齐方式
    if style_type != 2 and align:
        font_style.paragraph_format.alignment = align
        # font_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
        # font_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.LEFT
        # font_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.RIGHT

    # 中文字体名称
    if font_name:
        font_style.font.name = font_name
        font_style._element.rPr.rFonts.set(qn('w:eastAsia'), font_name)

    return font_style

需要注意的是，新添加的样式的时候，必须先判断样式名称是否存在，否则会报错

最后，添加段落的时候，将上面创建的样式传入到第 2 个参数中即可

使用 add_paragraph() 方法添加一个段落，返回值为一个段落对象

该对象同样可以使用 add_run(text,style) 方法，在段落后追加文字块 Run 并指定样式

# 1/段落样式
style_paragraph = create_style(document=doc, style_name="style2", style_type=1, font_size=30,
                               font_color=[0xff, 0x00, 0x00])
# 2/字符样式
style_string = create_style(document=doc, style_name="style3", style_type=2, font_size=15,
                            font_color=[0x00, 0xff, 0x00])
# 3/表格样式
# 对齐方式为：居中
style_table = create_style(document=doc, style_name="style4", style_type=3, font_size=25,
                           font_color=[0x00, 0x00, 0xff], align=WD_PARAGRAPH_ALIGNMENT.CENTER)

current_paragraph = doc.add_paragraph("我是一个自带样式的段落（方式二）！！！", style_paragraph)
# 字符样式

current_paragraph.add_run("【段落2中的部分字符】", style_string)

Word 文档中，有序列表和无序列表也比较常用

事实上，和添加段落类似，添加列表同样是使用文档对象的 add_paragraph() 方法，指定不同的样式 style 来添加

其中，

有序列表：List Number
无序列表：List Bullet

def add_list(document, data, isorder):
    """
    将列表数据添加到无序列表/有序列表中
    :param document: 文档对象
    :param data: 列表数据
    :param isorder: 是否有序列表
    :return:
    """
    # 无序列表
    if not isorder:
        for item in data:
            document.add_paragraph(item, style='List Bullet')
    else:
        # 有序列表
        for item in data:
            document.add_paragraph(item, style='List Number')

# 2.3 列表
# 2.3.1 无序列表
add_list(doc, ["无序-Item1", "无序-Item2", "无序-Item3"], False)

# 2.3.2 有序列表
add_list(doc, ["有序-Item1", "有序-Item2", "有序-Item3"], True)

接下来，我们看看如何在文档中插入图片

使用方法：

add_picture(image,widht,height)

其中，

第 1 个参数代表图片路径或者图片流（网络图片）
第 2、3 个参数用于设置图片的宽、高

需要注意的是，如果没有显式指定宽高，则以图片原生尺寸展示；如果仅设置了其中一个，则会按照设置的一个做等比缩放显示

写入本地图片很简单

def add_local_image(doc, image_path, width=None, height=None):
    """
    增加本地图片到Word文档中
    :param doc:
    :param image_path:
    :param width:
    :param height:
    :return:
    """
    doc.add_picture(image_path, width=None if width is None else Inches(width),
                    height=None if height is None else Inches(height))

# 2.4.1 插入本地图片
add_local_image(doc, './1.png', width=2)

对于网络图片，我们需要先通过网络图片地址，获取图片字节流，传入到第一个参数中即可

import ssl
from io import BytesIO

def get_image_data_from_network(url):
    """
    获取网络图片字节流
    :param url: 图片地址
    :return:
    """
    ssl._create_default_https_context = ssl._create_unverified_context
    # 获取网络图片的字节流
    image_data = BytesIO(urlopen(url).read())
    return image_data

def add_network_image(doc, image_url, width=None, height=None):
    """
    增加本地图片到Word文档中
    :param doc:
    :param image_url:
    :param width:
    :param height:
    :return:
    """
    # 获取图片流
    image_data = get_image_data_from_network(image_url)
    doc.add_picture(image_data, width=None if width is None else Inches(width),
                    height=None if height is None else Inches(height))

# 2.4.2 插入网络图片
url = '图片URL地址'
add_network_image(doc, url, width=3)

最后，我们看看如何在文档中插入表格

使用方法：

add_table(row_num,column_num,style=None)

返回值：表格对象 <class 'docx.table.Table'>

其中，

第 1 个参数：表格的行数目
第 2 个参数：表格的列数目
第 3 个参数：表格的样式

使用行/列索引，可以获取表格中某一行/列所有的单元格对象组成的列表

# 添加一个table表格
table = doc.add_table(***)

# 通过行/列索引，获取某一行/列的所有单元格对象
# 第一行所有单元格对象列表
head_cells = table.rows[0].cells

另外，表格对象使用 add_row()、add_column() 方法可以追加一行/列

以指定表头、表数据，插入一张表为例

def add_table(doc, head_datas, datas, style=None):
    """
    新增一个表格
    :param doc:
    :param head_datas: 表头
    :param datas: 数据
    :param style:
    :return:
    """
    # 新增一个表格
    # 表格所有样式大全：https://blog.csdn.net/ibiao/article/details/78595295
    # 默认样式为：Table Grid
    table = doc.add_table(rows=1, cols=len(head_datas), style=("Table Grid" if style is None else style))

    # 第一行所有单元格对象列表
    head_cells = table.rows[0].cells

    # 写入数据到表头中
    for index, head_item in enumerate(head_datas):
        head_cells[index].text = head_item

    # 遍历数据并写入数据
    for data in datas:
        # 单独添加一行或者列：add_row、add_column
        row_cells = table.add_row().cells
        for index, cell in enumerate(row_cells):
            cell.text = str(data[index])
# 2.5 表格
head_datas = ["姓名", "年龄", "地区"]
datas = (
  ('张三', 18, '深圳'),
  ('李四', 28, '北京'),
  ('王五', 33, '上海'),
  ('孙六', 42, '广州')
 )

# 新增一个表格，并指定样式
# add_table(doc, head_datas, datas, style_table)
add_table(doc, head_datas, datas)

需要指出的是，表格默认采用的样式是 Table Grid，也可以使用上面的方法自定义一个表格样式，插入表格的同时设置进去即可