最全總結 | 聊聊 Python 辦公自動化之 Word(上)

AirPython發表於2020-11-12

image

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() 方法新增一個段落,返回值為一個段落物件

image

該物件同樣可以使用 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,也可以使用上面的方法自定義一個表格樣式,插入表格的同時設定進去即可

4. 最後

本篇文章就 Word 寫入資料的常規操作進行了一次全面梳理,更多功能包含:讀取、修改、查詢、刪除等實戰內容後面會持續輸出

要獲取全部原始碼,關注公眾號「 AirPython 」,後臺回覆「 word 」即可獲得全部原始碼

如果你覺得文章還不錯,請大家 點贊、分享、留言下,因為這將是我持續輸出更多優質文章的最強動力!

推薦閱讀

最全總結 | 聊聊 Python 辦公自動化之 Excel(上)

最全總結 | 聊聊 Python 辦公自動化之 Excel(中)

最全總結 | 聊聊 Python 辦公自動化之 Excel(下)

相關文章