关于Python-docx操作excel的一些记录

背景

最近在做客户端性能测试的提效工作,会把当前版本的性能数据与上个版本的性能数据进行对比,然后把对比结论以及数据,放到docx文档上,自动生成一个性能报告,就学习了相关Python-docx的相关操作,记录如下。

基本介绍

python-docx 是用于创建可修改 微软 Word 的一个 python 库,提供全套的 Word 操作,是最常用的 Word 工具。可以对文档进行更改,包含段落、分页符、表格、图片、标题、样式等几乎所有的word文档中能常用的功能都包含了。只能解析docx文件,解析不了doc文件。python-docx将整个文章看做是一个Document对象,其基本结构如下:

  • 每个Document包含许多个代表“段落”的Paragraph对象,存放在document.paragraphs
  • 每个Paragraph都有许多个代表"行内元素"的Run对象,存放在paragraph.runs

基本的一些使用

from docx import Document as Doc
from docx.document import Document
import os

doc: Document = Doc()

word_path = os.getcwd()
doc.save(os.path.join(word_path, 'demo.docx'))

上面代码,我们引入python-docx 最核心的对象Document,它对应的就是一个word文件,可以通过这个对象来操作word里的一切内容。

  • 标题
doc.add_heading(text="一级标题", level=1)
doc.add_heading(text="二级标题", level=2)

text参数制定标题的文字,level制定标题的级别,一级标题还是二级标题,如果level等于0,标题就会当做文档的title,level支持1-9个级别。

  • 段落
doc.add_paragraph("测试段落一")
paragraph = doc.add_paragraph()  
paragraph.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
run = paragraph.add_run("测试段落二")
run.bold = True
run.font.name = u'宋体'

添加段落有两种方式,如上:使用doc.add_paragraph("测试段落一")直接添加,另一种通过add_run来添加,同时可以操作文字的各种属性,比如粗体、字体、颜色等等

本文重点操作表格

创建

table = doc.add_table(2, 3, style="Table Grid")

调用add_table方法,并传入行数和列数,即可完成一个表格的创建,如下图:

image-20211208131032858

添加表头

['场景', '版本', '内存', 'CPU', '卡顿数', 'GPU']假设我们的表头内容存放再这样一个列表中

columns = ['场景', '版本', '内存', 'CPU', '卡顿数', 'GPU']
table = doc.add_table(1, len(columns), style="Table Grid")
for i in range(len(columns)):
    row = table.rows[0]
    row.cells[i].text = columns[i]

根据表头的长度来确定表格有多少列,目前我们还不知道有多少行,就只需要添加一行就可以。

table.rows可以获取所有行,row.cells可以行内所有的单元格,然后通过给text属性赋值就可以完成单元格内容的填充。效果如下:

image-20211208132348667

表头的内容我们一般都需要加个背景色,让整体排版更好看一下

columns = ['场景', '版本', '内存', 'CPU', '卡顿数', 'GPU']
table = doc.add_table(1, len(columns), style="Table Grid")
for i in range(len(columns)):
    row = table.rows[0]
    row.cells[i].text = columns[i]
    shading = parse_xml(r'<w:shd {} w:fill="{bgColor}"/>'.format(nsdecls('w'), bgColor='129563'))
    row.cells[i]._tc.get_or_add_tcPr().append(shading)

通过xml来定义一个背景色,然后再通过调用get_or_add_tcPr,这样添加北京色就成功了。

image-20211208132642229

温馨提示:

shading = parse_xml(r'<w:shd {} w:fill="{bgColor}"/>'.format(nsdecls('w'), bgColor='129563'))

这里是先解析出一个shading,如果每个单元格都添加这一个shading,那么只有最后一个单元格能有背景色。所以这里需要每添加一次,都要重新解析一次。

合并单元格

举个栗子,比如我们添加了四行,想把每行的第一列进行合并,代码如下:

a = table.add_row()
b = table.add_row()
c = table.add_row()
d = table.add_row()
d.cells[0].merge(a.cells[0])

实际的效果如下图。这里用到了_Cell单元格对象的merge方法,实现单元格的合并,这里的0,就是第一个单元格的索引。

image-20211210132433046

给单元格字体添加颜色

给单元格文字添加颜色,和操作段落文字的原理是一样的,都是用run操作。代码如下:

data = ['B站feed滑动', '6.54.0', 330, 14.5, 212, 12.5]
for i in range(len(columns)):
    run = a.cells[i].paragraphs[0].add_run(str(data[i]))
    run.font.color.rgb = RGBColor(255, 69, 0) # 这是红色的RGB

效果如下:

image-20211210133445788

友情提示:

注意这里给单元格添加内容时,必须字符串的形式,不然会报错

设置页面纸张大小

python-docx生成的文档默认是A4的,当你想改成A3或者其他大小的时候,可以看看这里

document.sections[0].page_height = Cm(42)  # 设置A3纸的高度
document.sections[0].page_width = Cm(29.7)  # 设置A3纸的宽

老铁,你要点我

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容