更新时间:2020-03-23 16:45
要使用wps模块,需要import wps
。
wps模块是用来向用户提供一系列操作Word的SDK,让用户通过简单的参数和方法调用来实现一些复杂的操作。
方法名:
open(file, visible=False,dispatch=’wps’)
方法描述:
该方法会启动一个Word进程并打开文档,可以通过visible来控制这个Word进程是可见。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
file
: 文件路径 visible
: 是否可见 dispatch
: 使用office或wps打开 返回值说明:
返回一个类型的对象。
示例:
doc = wps.word.open(r'C:\xxx.docx',dispatch='wps')
方法名:
create(visible=False,dispatch=’wps’)
方法描述:
该方法会启动一个Word进程并新建一个文档,可以通过visible来控制这个Word进程是可见。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
返回一个类型的对象。
示例:
doc = wps.word.create(visible=True,dispatch='wps')
Word
: 负责为用户提供Word相关的一些操作。
当Word
实例不再被使用时,建议close()它,否则会不断产生残留的Word进程。
方法名:
save(self,*,file=None)
方法描述:
该方法用于保存对Word的修改,如果是另存为或者新创建的Word,需要传入文件路径。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc = wps.word.create(visible=False,dispatch="wps")
doc.save(file=r"C:\xxxx\wps测1.doc")
方法名:
close(self)
方法描述:
该方法关闭Word文档并释放进程。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
无
返回值说明:
无
示例:
doc.close()
方法名:
write(self,text,*, size=8, family=”微软雅黑”, color=1)
方法描述:
该方法向Word内写入内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc",visible=True)
doc.write("11222",size=10,family="微软雅黑",color=5)
方法名:
read(self)
方法描述:
该方法读取word内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
无
返回值说明:
返回读取到的内容。
示例:
print(doc.read())
方法名:
search(self,key, from_pos=”start”, index=1, relative=”left”)
方法描述:
该方法在可视化情况下,可以看到查找关键字并移动光标到关键字的左边或者右边。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
key
: 查找的关键字 from_pos
: 从哪开始查找 开头或者当前 只能填start
|current
index
: 第几个匹配 默认1 relative
:光标在关键字左边还是右边 只能填left
|right
返回值说明:
无
示例:
doc.search("xxx")
方法名:
cursor_move(self,step_count, direction=”right”)
方法描述:
该方法移动光标,朝某一个方向移动一定的步数,默认向右。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc.cursor_move(3)
方法名:
add_picture(self,file)
方法描述:
向Word中插入图片,处理完调用save(self)保存。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc.add_picture(r"C:\aaa.jpg")
doc.save()
doc.close()
方法名:
to_pdf(self,file)
方法描述:
将Word转成pdf文件。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
doc.to_pdf(r"C:\xxxx\test.pdf")
doc.close()
方法名:
get_table(self,index)
方法描述:
根据索引获取表格,索引从0开始。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
index
: 表格索引 返回值说明:
返回对象。
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
doc.save()
doc.close()
Table
: 负责为用户提供Word中表格相关的一些操作。
方法名:
row_count(self)
方法描述:
获取表格的行数,
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
index
: 表格索引 返回值说明:
返回值为行数。
示例:
print(wps.word.Table.row_count())
方法名:
col_count(self)
方法描述:
获取表格的列数
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
index
: 表格索引 返回值说明:
返回值为列数
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
print(table.row_count())
doc.close()
方法名:
add_row(self)
方法描述:
增加一个空行。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
无
返回值说明:
无
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
table.add_row()
doc.close()
方法名:
add_col(self)
方法描述:
增加一个空列。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
无
返回值说明:
无
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
table.add_row()
doc.close()
方法名:
read(self, row, col)
方法描述:
获取指定单元格内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
row
: 行的索引 col
: 列的索引 返回值说明:
返回读取到的内容。
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
print(table.read(1,1))
doc.close()
方法名:
write(row, col, text, ,size=8, family=”微软雅黑”, color=1)
*方法描述:
向指定单元格写入内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
doc = wps.word.open(file=r"C:\xxxx\wps测1.doc")
table = doc.get_table(0)
table.write(1,1,"333")
doc.save()
doc.close()
方法名:
open(file,*, visible=False, readonly=False, password=None, write_password=None,dispatch=’wps’)
方法描述:
该方法会启动一个Excel进程并打开文档,可以通过visible来控制这个Excel进程是可见。、
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
file
: 文件路径 visible
: 是否可见 readonly
: 只读 password
: 文件密码 write_password
: 设置密码 dispatch
: 使用office或wps打开 返回值说明:
返回一个类型的对象。
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
方法名:
create(,visible=False,,dispatch=’wps’)
*方法描述:
该方法会启动一个Excel进程并新建一个文档,可以通过visible来控制这个Excel进程是可见。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
返回一个类型的对象。
示例:
wb = wps.excel.create(dispatch='wps')
wb.save(file=r"C:\xxxx\test.xlsx")
wb.close()
Excel
: 负责为用户提供Excel相关的一些操作。
当Excel
实例不再被使用时,建议close()它,否则会不断产生残留的Excel进程。
方法名:
save(self, , file=None)
*方法描述:
该方法用于保存对Excel的修改,如果是另存为或者新创建的Excel,需要传入文件路径。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
wb.save(file="C:\xxxx\test.xlsx")
方法名:
close(self, , save=True)
*方法描述:
关闭Excel文档并释放进程。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
save
: 默认保存 返回值说明:
无
示例:
wb.close()
方法名:
sheets(self)
方法描述:
返回该Excel内所有sheet的集合
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
无
返回值说明:
这是一个实例的集合
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
wb.sheets()
方法名:
get_sheet(self,sheet_name=None)
方法描述:
根据sheet的名称sheet_name
获取指定sheet,如果不传则返回当前激活的sheet。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:<br />
返回值说明:
返回一个的实例
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet("sheet1")
方法名:
add_sheet(self,sheet_name, location, *,relative=”before”)
方法描述:
在location
的sheet前或者后插入新的sheet。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
返回一个的实例
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
wb.add_sheet("sheetxxx","sheet1")
wb.save()
wb.close()
方法名:
remove_sheet(self, sheet_name)
方法描述:
根据sheet的名称sheet_name
删除指定的sheet。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
wb.remove_sheet("sheet1")
wb.save()
wb.close()
方法名:
rename_sheet(self, old_sheet_name, new_sheet_name)
方法描述:
重命名sheet。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
wb.rename_sheet("sheet1","sheet4")
wb.save()
wb.close()
方法名:
run_macro(self, macro_name, , file=None)
*方法描述:
运行宏
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxx\test.xlsx")
ws = wb.get_sheet()
ws.run_macro("模块1",file=r"c:\xxx\模块1.bas")
Sheet
负责为用户提供Sheet相关的一些操作。
方法名:
read(self,range,, only_visible=False, skip=0, max=1000)
*方法描述:
从该sheet中读取内容。可以读取列的内容,读取行的内容,读取单元格的内容,读取一个范围的内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
range
: ‘A’为列 ‘1’为行 ‘A1’为单元格 ‘A1:B2’为范围 only_visible
: 只读可见 skip
: 跳过多少行后开始读 max
: 读列或者范围时不能超过max的范围 返回值说明:
返回读取到的内容。
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
#读取单元格A1
print(ws.read("A1"))
#读取第一行
print(ws.read("1"))
#读取A列,跳过1行,从第2行开始读,只读可见的,最多读10条,返回元祖。
print(ws.read("A",skip=1,max=10,only_visible=True))
#读取A1:C3的范围,返回二维元祖,内层元祖代表一行的数据
print(ws.read("A1:C3"))
wb.close()
方法名:
write(self,range, value,,start_row=’1’,skip=0, max=1000)
*方法描述:
向该sheet中写入数据。可以向单元格写入内容,可以向行写入内容,可以向列写入内容。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
range
: ‘A’为列 ‘1’为行 ‘A1’为单元格 value
: 当range为列/行的时候传入一维数组,为单元格则传入str start_row
: 写入列时表示从哪一行开始写 skip
: 跳过多少行后开始写 max
: 写入列时不能超过max的范围 返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
#写入单元格A1,内容为sss
ws.write("A1","sss")
#写入第1行,数据为[1,2,3]
ws.write("1",[1,2,3])
#写入A列,从第2行开始写,内容为[3,4,5,6,7]
ws.write("A",[3,4,5,6,7],start_row=2)
#写入一个范围,传入二维元祖
ws.write("A10:B12",((1,2),(3,4),(5,6)))
wb.save()
wb.close()
方法名:
copy(self,range)
方法描述:
复制范围内的数据,一般搭配paste
使用。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
#复制单元格
ws.copy("A1")
#复制第1行
ws.copy("1")
#复制第A列
ws.copy("A")
#复制A1:C3范围
ws.copy("A1:c3")
方法名:
paste(self,col, row,*, paste_type=’数值’, retry=3)
方法描述:
粘贴范围内的数据,一般搭配copy
使用。重试次数用于设置粘贴失败时尝试粘贴的最大次数。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
col
: 起始列号 row
: 起始行号 type
: 全部
公式
数值
格式
批注
验证
所有使用源主题的单元
边框除外
列宽
公式和数字格式
值和数字格式
所有合并条件格式
retry
: 重试次数 返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
ws.copy("A10:B12")
ws.paste("A","13",paste_type="全部")
wb.save()
wb.close()
方法名:
row_count(self)
方法描述:
获得该sheet的行数。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
返回行数
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
ws.row_count()
wb.close()
方法名:
col_count(self)
方法描述:
获得该sheet的列数。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
返回列数。
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
ws.row_count()
wb.close()
方法名:
sort(self, sort_fields, *, range=None, match_case=False, sort_method=’pinyin’, contains_header=False)
方法描述:
对指定范围进行排序。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
range
:查找范围: 如’A1:C5’, 如果为空则查找整个Sheet(默认整个Sheet) sort_fileds
: 排序字段数组 sort_fields = [(‘A’, ‘value’, ‘desc’), (‘B’, ‘cell_color’, ‘asc’)] match_case
: 是否区分大小写 sort_method
: 排序方法 字母、笔划 contains_header
: 是否包含标题 返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx")
ws = wb.get_sheet()
ws.sort(sort_fields=[("A","value","desc"),('B', 'cellColor', 'asc')])
wb.save()
wb.close()
方法名:
filter(self, col, array, *, delete=False)
方法描述:
对列进行筛选。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
#在A列筛选等于1或者2的值
wb = wps.excel.open(r"C:\xxxx\test.xlsx",visible=True)
ws = wb.get_sheet()
# 列表里面是字符串
ws.filter("A",["1","2"])
方法名:
remove_filter(self)
方法描述:
移除筛选。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.remove_filter()
方法名:
merge_cell(self, range, *,each_row=False)
方法描述:
合并单元格。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
wb = wps.excel.open(r"C:\xxxx\test.xlsx",visible=True)
ws = wb.get_sheet()
ws.merge_cell("A1:B2",each_row=True)
方法名:
insert(range, insertDirection=None)
方法描述:
插入功能。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
# 插入单元格
ws.insert("A1")
# 插入列
ws.insert("A")
# 插入列
ws.insert(1)
# 插入范围
ws.insert("A1:B2")
方法名:
delete(self,range, *,insertDirection=None)
方法描述:
删除功能。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.delete("A1")
ws.delete("A")
ws.delete(1)
ws.delete("A1:B2")
方法名:
remove_duplicate(self,range, cols)
方法描述:
列去重功能。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.remove_duplicate("A1:D13",[1,2])
方法名:
find(self,text, *, range=None, count=0)
方法描述:
查找指定内容功能。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
text
: 查找的内容 range
: 查找范围: 如’A1:C5’, 如果为空则查找整个Sheet(默认整个Sheet) count
: 0表示查找所有匹配项(默认为0) 返回值说明:
查找的结果
示例:
print(ws.find("1"))
方法名:
replace(self, text, replacement, *, range=None, match_case=False)
方法描述:
替换指定内容功能。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
text
: 查找的内容 replacement
: 替换成的内容 range
: 查找范围: 如’A1:C5’, 如果为空则查找整个Sheet(默认整个Sheet) match_case
: 是否大小写匹配 返回值说明:
无
示例:
ws.replace("AAA","ddd")
方法名:
add_picture(self,file, col, row, *,width=None, height=None)
方法描述:
向指定位置插入图片。不设置宽高按原图大小插入,设置宽高中的一个会按比例缩放,都设置有可能会导致图片变形。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.add_picture(r"C:\aaa.jpg","A","2")
方法名:
get_row_height(self,row)
方法描述:
获得指定行高度。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
获得的行高
示例:
print(ws.get_row_height("1"))
方法名:
set_row_height(self, row, height)
方法描述:
设置指定行高度。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.set_row_height("1","20")
方法名:
get_col_width(self,col)
方法描述:
获得指定列宽度。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
获得的列宽
示例:
print(ws.get_col_width("A"))
方法名:
set_col_width(self,col, width)
方法描述:
设置指定列宽度。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.set_col_width("A","40")
方法名:
get_formula(self,range)
方法描述:
获取指定范围的公式。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
获得的结果
示例:
# 返回单元格公式
print(ws.get_formula("A1"))
# 元祖套元祖
print(ws.get_formula("1"))
# 返回二维元祖(('公式内容',), ('公式内容',))
print(ws.get_formula("A"))
# 返回二维元祖(('公式内容','公式内容'), ('公式内容','公式内容'))
print(ws.get_formula("A1:C2"))
方法名:
set_formula(self,range, formula)
方法描述:
设置指定范围的公式。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
ws.set_formula("B4","=SUM(B1:B3)")
方法名:
get_style(self,range, style)
方法描述:
获取指定范围的样式。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
获得的样式
示例:
print(ws.get_style("A1","fontname"))
方法名:
set_style(self,range, style, value, color_format=None)
方法描述:
设置指定范围的样式。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
range
: ‘A’为列 ‘1’位行 ‘A1’为单元格 ‘A1:B2’为范围 style
: fontsize
fontcolor
fontname
bgcolor
value
: 设置该属性的值,如果style为fontcolor
/bgcolor
,则value可以为’#FFFFFF’或者’255,255,255’ format
: 颜色类型,如果style为fontcolor
/bgcolor
,需设置format为’HEX’或者’RGB’ 返回值说明:
无
示例:
ws.set_style("A1","fontname","黑体")
方法名:
get_comment(self,range)
方法描述:
获取指定范围的注释。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
获得的注释
示例:
print(ws.get_comment("A1"))
方法名:
set_comment(self,range, comment)
方法描述:
往指定范围插入注释。
版本信息:
该方法适用于从3.3.0及以上版本。
参数说明:
返回值说明:
无
示例:
sheet.set_comment("A1","xxx")
在文档使用中是否遇到以下问题
更多建议
匿名提交