Sheet

read(range, only_visible=False, skip=0, max=1000)

方法描述

从Excel读取数据，数字的返回均为float，例如：excel中的单元格值为1，则读出的值为1.0

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

only_visible<bool>只读可见

skip<int>跳过多少行后开始读

max<int>读列或者范围时，行数不能超过max的范围

调用样例- rpa.app.wps.excel.Sheet.read-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

cell_value = sheet.read('A1')
row_value = sheet.read('1')
column_value = sheet.read('A')
range_value = sheet.read('A1:C3')

excel.close()

write(range, value, start_row=1, start_col='A', max=1000)

方法描述

向Excel写入数据

参数说明

range<str>支持行、列、单元格、范围写入，写入范围时仅填写起始单元格即可。例：'A'为列 '1'为行 'A1'为单元格

value<list>当range为列/行的时候传入一维数组,写入单元格则传入str/int/float ,写入范围的时候传入二维数组

start_row<int>写入列时表示从哪一行开始写，此参数仅当写入列时有效

start_col<str>写入行时表示从哪一列开始写，此参数仅当写入行时有效，可传入'1'|'A'|'a'

max<int>写入列时不能超过max的范围

调用样例- rpa.app.wps.excel.Sheet.write-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

row_value = ["行数据1","RPA测试"]
cell_value = "RPA单元格值"
column_value = ["列数据1","RPA测试"]
range_value = [["区域数据1","区域数据2"] , ["区域数据3","区域数据4"]]

sheet.write('1' , row_value )
sheet.write('C' , column_value )
sheet.write('A2' , cell_value )
sheet.write('A4' , range_value )

excel.close()

copy(range)

方法描述

复制范围内的数据

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

调用样例- rpa.app.wps.excel.Sheet.copy-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.copy('1' )
sheet.copy('C' )
sheet.copy('A2' )
sheet.copy('A4:B5' )

paste(range, paste_type='数值', retry=3)

方法描述

向范围内粘贴数据

参数说明

range<str>粘贴目标位置，支持的格式包含行、列、粘贴范围的起始单元格，'A'为列 '1'为行 'A1'为单元格

paste_type<str>数据类型

可选项：

• all : 全部

• formula : 公式

• value : 数值

• format : 格式

• annotation : 批注

• verification : 验证

• sourceUnit : 所有使用源主题的单元

• exceptBorder : 边框除外

• colWidth : 列宽

• FormulasNumber : 公式和数字格式

• valueNumber : 值和数字格式

• mergeCondition : 所有合并条件格式

retry<int>重试次数

调用样例- rpa.app.wps.excel.Sheet.paste-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.copy('1' )
sheet.paste('2')

sheet.copy('C' )
sheet.paste('D')

sheet.copy('A2' )
sheet.paste('B2')

sheet.copy('A4:B5' )
sheet.paste('C4' )

row_count()

方法描述

获得指定sheet的行数

返回值说明

返回行数<str>

调用样例- rpa.app.wps.excel.Sheet.row_count-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

count = sheet.row_count()

col_count()

方法描述

获得指定sheet的列数

返回值说明

返回列数<str>

调用样例- rpa.app.wps.excel.Sheet.col_count-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

count = sheet.col_count()

sort(sort_fields, range=None, match_case=False, sort_method='pinyin', contains_header=False)

方法描述

排序

参数说明

sort_fields<list>排序字段数组 sort_fields = [(<列名>,<排序类型>,<升降序>)]

• Excel列名，如A，B，AA等

• 排序类型：

  • value：按照单元格值

  • cell_color：按照单元格颜色

  • font_color：按照单元格字体颜色

• 升降序：

  • asc：升序

  • desc：降序

range<str>查找范围：如'A1:C5', 如果为空则查找整个Sheet（默认整个Sheet）

match_case<bool>是否区分大小写

• False：默认值， 则执行不区分大小写的排序。

• True：则执行区分大小写的排序。

sort_method<str>排序方法

可选项：

• pinyin：默认值。 按字符的汉语拼音顺序排序

• stroke：按每个字符中的笔划数量排序

contains_header<bool>是否不包含标题

• False：默认值， （应）对整个范围进行排序。

• True：（不应）对整个范围进行排序。

调用样例- rpa.app.wps.excel.Sheet.sort-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
# 将A列的值进行降序
sort_fields1 = [('A','value','desc')]
sheet.sort(sort_fields)
# 将B列的单元格颜色进行升序
sort_fields2 = [('B','cell_color','asc')]
sheet.sort(sort_fields2)
# 将C列的字体颜色进行升序
sort_fields3 = [('C','font_color','asc')]
sheet.sort(sort_fields3)

filter(col, array, delete=False)

方法描述

对列进行筛选

参数说明

col<str>列号

array<list>筛选值数组

delete<bool>筛选后是否删除，在3.4.3及以后版本无效

调用样例- rpa.app.wps.excel.Sheet.filter-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
# 普通筛选
filter_value = ['rpa_test1','rpa_test2']
# 高级筛选,支持通配符 ？代表单个字符 * 代表任意多个字符
filter_value = ['rpa_test？']

sheet.filter('A',filter_value)

remove_filter()

方法描述

移除筛选

调用样例- rpa.app.wps.excel.Sheet.remove_filter-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()
filter_value = ['rpa_test1','rpa_test2']

sheet.filter('A',filter_value)
sheet.remove_filter()

merge_cell(range, each_row=False)

方法描述

合并单元格

参数说明

range<str>需要合并的范围，必须为 A1:B2的格式

each_row<bool>是否行内合并

调用样例- rpa.app.wps.excel.Sheet.merge_cell-

# 注意事项：使用前需确认已安装WPS相关软件
# 此方法通过each_row参数指定合并形式，默认为False，将把指定区域合并为一个完整的单元格
# 若指定each_row = True，则将把指定区域按行合并，每一行作为一个单元格
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.merge_cell('A1:B2',each_row=True)

insert(range, insertDirection=None)

方法描述

插入功能

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

insertDirection<str>插入方向

可选项：

• down : 下移

• right : 右移

调用样例- rpa.app.wps.excel.Sheet.insert-

# 注意事项：使用前需确认已安装WPS相关软件
# 此方法通过insertDirection参数指定插入后相邻值的移动方向，支持下移和右移
# 代码调用样例如下，会向A1单元格插入一个空的单元格，原有数据默认下移：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.insert('A1')

delete(range, insertDirection=None)

方法描述

删除功能

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

insertDirection<str>插入方向

可选项：

• up : 上移

• left : 左移

调用样例- rpa.app.wps.excel.Sheet.delete-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下，会删除A1单元格，原有数据默认上移：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.delete('A1')

remove_duplicated_cols(range, cols)

方法描述

列去重功能

参数说明

range<str>'A'为列 'A1:B2'为范围

cols<list>去重列号的列表

调用样例- rpa.app.wps.excel.Sheet.remove_duplicated_cols-

# 注意事项：使用前需确认已安装WPS相关软件
# 去重列字段不能超过去重范围，如去重范围为A1:C3，则去重列字段只能从A,B,C三个中选取任意个
# 代码调用样例如下，此例中指定了在A1:C9区域进行去重操作，一行数据上三个值均相等时，才视为重复值：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.remove_duplicated_cols('A1:C9',['A,B,C'])

find(text, range=None, count=0)

方法描述

查询

参数说明

text<str>要查询的内容

range<str>查找范围：如'A1:C5', 如果为空则查找整个Sheet（默认整个Sheet）

count<int>0表示查找所有匹配项（默认为0）

返回值说明

返回值：二维数组，每行都是一个返回结果，第一列是行号，第二列是列号，第三列是匹配的单元格值; 返回0表示未找到任何匹配项<list>

调用样例- rpa.app.wps.excel.Sheet.find-

# 注意事项：使用前需确认已安装WPS相关软件
# 可通过制定count参数来设定匹配项数量，默认为0，即返回所有匹配结果，设为1则按从左到右，从上到下的顺序返回第一个匹配的单元格
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

result = sheet.find('AA',count=1)

add_picture(file, col, row, width=None, height=None)

方法描述

向指定位置插入图片

参数说明

file<str>插入图片的路径

col<str>左上角单元格的列号

row<str>左上角单元格的行号

width<float>图片的宽度

height<float>图片的高度

调用样例- rpa.app.wps.excel.Sheet.add_picture-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

pic_path = r'D:\2_测试文件归档\OCR文字识别.png'
sheet.add_picture(pic_path,'C','2')

get_row_height(row)

方法描述

获得指定行高度

参数说明

row<str>行号

返回值说明

返回行高<str>

调用样例- rpa.app.wps.excel.Sheet.get_row_height-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

row_height = sheet.get_row_height('1')

set_row_height(row, height)

方法描述

设置指定行高度

参数说明

row<str>行号

height<str>行高

调用样例- rpa.app.wps.excel.Sheet.set_row_height-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_row_height('1','20')

get_col_width(col)

方法描述

获得指定列宽度

参数说明

col<str>列号

返回值说明

返回列宽<str>

调用样例- rpa.app.wps.excel.Sheet.get_col_width-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

col_width = sheet.get_col_width('A')

set_col_width(col, width)

方法描述

设置指定列宽度

参数说明

col<str>列号

width<str>列宽

调用样例- rpa.app.wps.excel.Sheet.set_col_width-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_col_width('A','20')

get_formula(range)

方法描述

获取指定范围的公式

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

返回值说明

返回指定范围的公式<str>

调用样例- rpa.app.wps.excel.Sheet.get_formula-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

formula = sheet.get_formula("A1")

set_formula(range, formula)

方法描述

设置指定范围的公式

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

formula<str>公式

调用样例- rpa.app.wps.excel.Sheet.set_formula-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

formula = "=TODAY()"
sheet.set_formula("E2:F3",formula)

get_style(range, style, color_format='RGB')

方法描述

获取指定范围的样式

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

style<str>样式

可选项：

• fontsize : 字体大小

• fontcolor : 字体颜色

• fontname : 字体名称

• bgcolor : 背景色

color_format<str>颜色类型，当style为fontcolor/bgcolor时有效，可传入'HEX'|'RGB'

调用样例- rpa.app.wps.excel.Sheet.get_style-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

style = sheet.get_style("A1:B2","fontsize")

set_style(range, style, value, color_format='RGB')

方法描述

设置指定范围的样式

参数说明

range<str>'A'为列 '1'为行 'A1'为单元格 'A1:B2'为范围

style<str>样式

可选项：

• fontsize : 字体大小

• fontcolor : 字体颜色

• fontname : 字体名称

• bgcolor : 背景色

value<str>设置该属性的值，如果style为fontcolor/bgcolor，则value可以为'#FFFFFF'或者'255,255,255'

format<str>颜色类型，如果style为fontcolor/bgcolor，需设置format为'HEX'或者'RGB'

调用样例- rpa.app.wps.excel.Sheet.set_style-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.set_style("A3","bgcolor","#FF0000","HEX")

get_comment(range)

方法描述

获取单元格的注释

参数说明

range<str>'A1'为单元格

返回值说明

返回单元格的注释，当单元格没有注释时，返回None<str>

调用样例- rpa.app.wps.excel.Sheet.get_comment-

# 注意事项：使用前需确认已安装WPS相关软件
# 当目标单元格本身并无注释时，此方法将返回None
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

comment = sheet.get_comment("A1")

set_comment(range, comment)

方法描述

往单元格插入注释

参数说明

range<str>'A1'为单元格

comment<str>注释

调用样例- rpa.app.wps.excel.Sheet.set_comment-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

comment = "RPA测试"
sheet.set_comment("A1",comment)

replace(text, replacement, range=None, match_case=False)

方法描述

替换

参数说明

text<str>要替换的内容

replacement<str>替换成的内容

range<str>查找范围：如'A1:C5', 如果为空则查找整个Sheet（默认整个Sheet）

match_case<bool>是否大小写匹配

调用样例- rpa.app.wps.excel.Sheet.replace-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

sheet.replace("test","RPA_TEST")

to_pdf(file)

方法描述

转化成pdf

参数说明

file<str>保存的pdf路径

调用样例- rpa.app.wps.excel.Sheet.to_pdf-

# 注意事项：使用前需确认已安装WPS相关软件
# 代码调用样例如下：
excel_file_path = r"D:\2_测试文件归档\测试Excel.xlsx"
excel = rpa.app.wps.excel.open(excel_file_path,visible=True)
sheet = excel.get_sheet()

path = r"D:\2_测试文件归档\sheet转pdf.pdf"
sheet.to_pdf(path)