| |
Methods defined here:
- __init__(self)
- Initialize self. See help(type(self)) for accurate signature.
- add_sheet(self, excel_file, position, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param position: 增加sheet页的位置:int类型,如1表示在第1个位置增加
@param sheet_name: sheet页名称
@return:
- clear_excel(self, excel_file, cell, format, sheet_name=0, exc=0)
- @param excel_file: excel路径
@param cell: 要读取的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param format: 清除选项:清除内容,清除格式,同时清除格式与内容
@param sheet_name: sheet名称
@return:
- close_excel_file(self, excel_obj, time_pre=0, time_pro=0, timeout=3000, exc=0)
- :param excel_file: str,excel地址
:param time_pre: 浮点数,运行前延时
:param time_pro: 浮点数,运行后延时
:param timeout: 浮点数,超时时间
:param exc: int,异常处理:0-抛出异常,1-不抛异常
- colum_chenge_row(self, excel_file, sheetname)
- @param excel_file: 带绝对路径的excel
@param sheetname: sheet页名称
@return:
- copy_sheet(self, from_excel_file, from_sheet_name, to_excel_file, to_sheet_name=0, exc=0)
- @param from_excel_file: 源excel文件
@param from_sheet_name: 源sheet页名称
@param to_excel_file: 目标excel文件
@param to_sheet_name: 目标sheet页
@return:
- create_dict(self, excel_file, sheet_name, keys_column, value_column)
- @param excel_file: 带绝对路径的excel
@param sheet_name: sheet页名称
@param keys_column: 作为key的列名,例如"A"或者“1”,不支持多列
@param value_column: 作为value的列,可以一列如“A”或“1”,也可以是多列。如"B:C"或“2:3”
@return:返回一个字典
- create_workbook(self, excel_name, exc=0)
- @param excel_name: 带绝对路径的excel
@return:
- create_worksheet(self, excel_file, sheet_name, exc=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: 要操作的sheet名称
@return:
- del_allrow(self, excel_file, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: 要操作的sheet名称
@return:
- del_column(self, excel_file, col_index, number=1, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param col_index: 起始列列名,数字,例如1表示从第1列开始删除
@param number: 删除多少列,数字,如2表示删除2列
@param sheet_name: 要操作的sheet名称
@return:
- del_row(self, excel_file, row_index, number=1, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param row_index: 起始行行号,数字,例如1表示从第1行开始删除
@param number: 删除多少行,数字,如2表示删除2行
@param sheet_name: 要操作的sheet名称
@return:
- delete_repeat_row(self, excel_file, sheet_name)
- @param excel_file: excel路径
@param sheet_name: sheet名称
@return:
- delete_sheet(self, excel_file, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: sheet页名称
@return:
- excel_conversion(self, excel_file)
- @param excel_file: 带绝对路径的excel
@return:将xlx格式的excel转换为xlsx格式的excel后返回
- export_pdf(self, excel_file, sheet_name, pdf_file, exc=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: sheet页名称
@param pdf_file: 保存的pdf路径
@return:
- filter_data(self, excel_file, sheet_name, cell, column_n=None, flg=None, filter_value=None, exc=0)
- :param list: 待处理的列表
:param column_n: 列名,int类型从0开始
:param flg: 条件:int类型,0:包含
1:不包含
2:大于
3:小于
4:等于
5:不等于
6:大于或等于
7:小于或等于
:param filter_value:筛选过滤值
:return:
- find_cell(self, excel_file, sheet_name, val)
- @param excel_file: 带绝对路径的excel
@param sheet_name: sheet页名称
@param val: 要查找的值
@return: 返回一个list,包含所有符合条件的单元格
- get_attribute(self, excel_file, todo, cell, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel
@param todo: 操作类型,项:获取行数、获取列数、获取单元格背景色
@param cell: 要获取的单元格,语法和excel一致,如”A1“或者”1,1“
@param sheet_name: 要操作的sheet名称
@return: 如果是获取行数返回已使用的最大行数,int类型;如果是获取列数,返回已使用的最大列数,int类型;返回单元格的背景色,rgb格式,如‘FF0000’(没有前面的#)
- get_background_color_cell(self, excel_file, cell, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param cell: 要获取的单元格,语法和excel一致,如”A1“或者”1,1“
@param sheet_name: 要操作的sheet名称
@return: 返回单元格的背景色,rgb格式,如‘FF0000’(没有前面的#)
- get_column(self, excel_file, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: 要操作的sheet名称
@return: 已使用的行数
- get_row(self, excel_file, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: 要操作的sheet名称
@return: 已使用的行数
- get_sheet_name(self, excel_file, types, indexs=None, values=None)
- :param excel_file: excel文件
:param types: 读取方式,int类型:
1:全部
2:指定序号
3:包含指定内容
4:不包含指定内容
:param indexs: 序号,int类型
:param values: 内容,str类型
:return:sheet名称,全部、包含、不包含的读取方式读取返回list,读取指定序号返回str
- hide_clo_row(self, excel_file, sheet_name, todo, start_index, end_index, exc=0)
- @param excel_file: excel路径
@param sheet_name: sheet名称
@param todo: 操作类型,项:隐藏行,取消隐藏行,隐藏列,取消隐藏列
@param start_index: 起始位置,对于行只能是int类型,如1;对于列可以是int类型,也可以是字母,如1或“A”
@param end_index: 结束位置,对于行只能是int类型,如1;对于列可以是int类型,也可以是字母,如1或“A”
@return:
- ins_col(self, excel_file, col_index, number=1, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param col_index: 起始列列名,可以是数字,例如1表示从第1列开始插入,也可以是字母,如”A“表示从A列开始插入
@param number: 插入多少列,数字,如2表示插入2列
@param sheet_name: 要操作的sheet名称
@return:
- ins_row(self, excel_file, row_index, number=1, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param row_index:起始行行号,数字,例如1表示从第1行开始插入
@param number:插入多少行,数字,如2表示插入2行
@param sheet_name:要操作的sheet名称
@return:
- insert_delete(self, todo, excel_file, index, number=1, sheet_name=0, exc=0)
- @param todo: 要做的事:数据项:删除重复行;插入行;插入列;删除行;删除所有行;删除列
@param excel_file:excel路径
@param index:起始行或者起始列,如果写数字则为int类型,如1,不能是‘1’,如果字母则为‘A’,不能是A
@param number:行数或者列数,int类型
@param sheet_name:sheet名称
@return:
- insert_pic(self, excel_file, sheet_name, cell, pic_path, column_width, row_height)
- @param excel_file: 带绝对路径的excel
@param sheet_name: sheet页名称
@param cell: 单元格位置,如“A1”或者“1,1”
@param pic_path: 图片路径
@param column_width: 列宽,int类型,选填,不填写将不改变原列宽,填写后将按照填写的列宽设置列宽
@param row_height: 行高,int类型,选填,不填写将不改变原行高,填写后将按照填写的行高设置行高
@return:
- open_excel_file(self, excel_file, time_pre=0, time_pro=0, timeout=3000, exc=0, data_type=0)
- :param excel_file: str,excel地址
:param time_pre: 浮点数,运行前延时
:param time_pro: 浮点数,运行后延时
:param data_type: int,控制包含公式的单元格是否具有公式(默认)或 Excel 上次读取工作表时存储的值:0-读取值,1-读取公式
:param timeout: 浮点数,超时时间
:param exc: int,异常处理:0-抛出异常,1-不抛异常
:return: tuple,excel对象
- read_cell(self, excel_file, cell, get_fist_blank_row='', get_fist_blank_cloumn='', get_blank_cloumn_row='', sheet_name=0, exc=0, data_type=0)
- @param excel_file: 带绝对路径的excel
@param cell: 要读取的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param get_fist_blank_row: 如果不为空表示要执“行获取第一个空白行”
@param get_fist_blank_cloumn: 如果不为空表示要执“行获取第一个空白列”
@param get_blank_cloumn_row: 如果不为空表示要执“获取列上第一个空白行”,支持int类型和str类型,如1表示第1列,“A”表示第A列,不能写成“1”或者A
@param sheet_name: excel的sheet页名称
@param data_type: int,控制包含公式的单元格是否具有公式(默认)或 Excel 上次读取工作表时存储的值:0-读取值,1-读取公式
@return: 如果是获取内容,一个单元格将返回一个str,否则返回一个list;如果是获取空白行/列,则返回行数或者列数,int类型
- refresh_excel(self, excel_file, exc=0)
- @param excel_file: 带绝对路径的excel
@return:
- rename_sheet(self, excel_file, sheet_name, new_sheet_name, exc=0)
- @param excel_file: 带绝对路径的excel
@param sheet_name: 原sheet页名称
@param new_sheet_name: 新sheet页名称
@return:
- return_df(self, excel_file, sheet_name=0)
- @param excel_file:带绝对路径的excel
@param sheet_name:要操作的sheet名称
@return:将excel内容以dataframe格式返回
- run_excel_macro(self, file_path, macro, exc, *args)
- @param file_path: 带绝对路径的excel名称
@param macro: 宏的名称
@param args:宏的参数
@return:宏的返回值
- save_excel_file(self, excel_obj, time_pre=0, time_pro=0, timeout=3000, exc=0)
- :param excel_file: str,excel地址
:param time_pre: 浮点数,运行前延时
:param time_pro: 浮点数,运行后延时
:param timeout: 浮点数,超时时间
:param exc: int,异常处理:0-抛出异常,1-不抛异常
- search_value(self, excel_file, sheet_name, keyword, cell, isnull=0, val='', exc=0)
- :param excel_file: excel文件地址
:param sheet_name: sheet名称
:param keyword: 查找关键字
:param cell: 查找范围
:param isnull: 高级选项未找到结果,0-返回空值,1—返回指定内容
:param val: 当未找到结果要返回指定内容的具体返回内容
:param exc: 异常处理
:return:
- set_background_color(self, excel_file, column_number, fg_color, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param column_number: 要设置的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param fg_color: 要设置的颜色,rgb格式,如“FF0000”(没有前面的#)
@param sheet_name: 要操作的sheet名称
@return:
- set_background_color_cell(self, excel_file, cell, fg_color, sheet_name=0)
- @param excel_file: 带绝对路径的excel
@param cell: 要获取的单元格,语法和excel一致,如”A1“或者”1,1“
@param fg_color:要设置的颜色,rgb格式,如“FF0000”(没有前面的#)
@param sheet_name:要操作的sheet名称
@return:
- set_column_height(self, excel_file, column_number, height, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel
@param column_number: 要设置的行行号,例如"1"表示第1行,”1:2“表示第1行到第2行
@param height: 高度,int类型
@param sheet_name: sheet名称
@return:
- set_column_width(self, excel_file, column_number, width, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel
@param column_number: 要设置的列列名,例如“A”、"1"表示第A列,“A:B“或者”1:2“表示第A列到第B列
@param width: 宽度,int类型
@param sheet_name:sheet名称
@return:
- set_font_color(self, excel_file, column_number, fg_color, sheet_name)
- @param excel_file: 带绝对路径的excel
@param column_number: 要设置的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param fg_color: 要设置的颜色,rgb格式,如“FF0000”(没有前面的#)
@param sheet_name: 要操作的sheet名称
@return:
- set_font_color_cell(self, excel_file, cell, fg_color, sheet_name)
- # 单元格修改字体色--废弃
- set_format(self, excel_file, column_number, num_format, background_color, font_color, font_size, font_style, alignment_horizontal, alignment_vertical, sheet_name=0, exc=0)
- @param excel_file:带绝对路径的excel
@param column_number:要设置的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param num_format:要设置的格式,目前提供常用格式:常规、数字、货币、会计专用、短日期、长日期、时间、百分比、科学计数,分数、文本
@param background_color:单元格的背景色,rgb格式,如‘FF0000’(没有前面的#)
@param font_color:字体颜色,rgb格式,如‘FF0000’
@param font_size:字体大小,int类型,如20
@param font_style:字体名称,如“微软雅黑”、“宋体”等
@param alignment_horizontal:horizontal代表水平方向,可以左对齐“left”,还有居中“center”和右对齐“right”,分散对齐“distributed”,
跨列居中“centerContinuous”,两端对齐“justify”,填充“fill”,常规“general”,编辑器直接传汉字即可,如左对齐
@param alignment_vertical:vertical代表垂直方向,可以居中“center”,还可以靠上“top”,靠下“bottom”,两端对齐“justify”,分散对齐“distributed”,编辑器直接传汉字即可,如左对齐
@param sheet_name:sheet页名称
@return:
- set_wrapped(self, excel_file, column_number, wrapped, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel文件名称
@param column_number: 要设置的单元格位置,和excel语法一致,例如“A1”、"1,1"表示一个单元格;或者是一个区域:“A”表示A列,“A:B“表示A到B列,
“A1:B3”或者“1,1:1,3”表示一个区域;或者“1”表示第1行,”1:2“表示1到2行
@param wrapped: 是否自动换行,布尔值,True或者False
@param sheet_name: sheet名称
@return:
- transform_path(self, file_path)
- #将windows下的路径修改为个平台通用路径
- write_cell(self, excel_file, cell, value, sheet_name=0, exc=0)
- @param excel_file: 带绝对路径的excel
@param cell: 起始单元格位置,如’A1‘、’a1‘、’1,1‘
@param value: 要写入的值,如果是字符串将写入一个单元格,否则按照行循环写入一个区域,如[1,2,3],将’1‘写入起始单元格,’2‘写入同一行中的下一列
@param sheet_name: excel中sheet页的名称
@return:
- write_excel(self, excel_file, region, cell_h, cell_l, value, sheet_name=0)
- @param excel_file: excel带绝对路径的名称
@param region: 范围,例如‘区域-行’,‘区域-列’,‘行’,‘列’,‘单元格’
@param cell_h:起始行数,数字
@param cell_l:起始列名,字母或者数字,如‘A’、‘a’或者‘1’
@param value:要写入的值,可以是字符串或者是list
@param sheet_name:excel的sheet页名称
@return:
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|