跳到主要内容

📒 Recorder 设置

本节介绍Recorder对象的运行设置。

多数设置已在相关主题章节介绍,这里汇总所有设置 api。

✅️ 使用方法

调用Recorder对象的set.****()方法,可进行有关设置。

设置支持链式操作。

from DrissionRecord import Recorder

r = Recorder()
r.set.path('data.csv').cache_size(10).data_col(3) # 链式操作

r.set.path('data.csv') # 分行操作,与上面效果一样
r.set.cache_size(10)
r.set.data_col(3)

✅️ 运行参数

📌 set.cache_size()

此方法用于设置缓存大小,即接收多少条数据就触发自动保存。

参数名称类型默认值说明
sizeint必填缓存大小
返回类型说明
RecorderSetter设置对象

📌 set.path()

此方法用于设置文件路径。调用时会自动保存缓存数据到文件。

参数名称类型默认值说明
pathstr
Path
必填文件路径
file_typestrNone文件类型,可与路径后缀不一致
返回类型说明
RecorderSetter设置对象

📌 set.file_type()

此方法用于手动设置文件类型(xlsx 除外)。

xlsx 类型的文件名必须是以'.xlsx'作为后缀,否则会报错。

参数名称类型默认值说明
file_typestr必填文件类型,可选'txt''csv''json''jsonl',可与路径后缀不一致
返回类型说明
RecorderSetter设置对象本身

📌 set.encoding()

此方法用于设置文本类型文件的编码。编目默认为'utf-8'

参数名称类型默认值说明
encodingstr必填编码格式
返回类型说明
RecorderSetter设置对象

📌 set.delimiter()

此方法用于设置 csv 文件分隔符。分隔符默认为','

参数名称类型默认值说明
delimiterstr必填csv 文件分隔符
返回类型说明
RecorderSetter设置对象

📌 set.quote_char()

此方法用于设置 csv 文件引用符。引用符默认为'"'

参数名称类型默认值说明
quote_charstr必填csv 文件引用符
返回类型说明
RecorderSetter设置对象

📌 set.show_msg()

此方法用于设置是否显示运行信息。

参数名称类型默认值说明
on_offbool必填开或关
返回类型说明
RecorderSetter设置对象

✅️ 数据相关

📌 set.table()

此方法用于设置默认数据表,仅 xlsx 文件有效。

参数名称类型默认值说明
namestr
None
True
必填表名称,为NoneTure时表示活动数据表
返回类型说明
RecorderSetter设置对象

📌 set.before()

此方法用于设置在每条数据前面补充的数据。

参数名称类型默认值说明
dataAny必填插入的数据,任意格式
返回类型说明
RecorderSetter设置对象

📌 set.after()

此方法用于设置在每条数据后面补充的数据。

参数名称类型默认值说明
dataAny必填插入的数据,任意格式
返回类型说明
RecorderSetter设置对象

📌 set.data_col()

此方法用于设置默认填充数据的列。

参数名称类型默认值说明
colstr
int
必填列号或列序号,0表示新列(表头长度后一列),不支持输入表头值
返回类型说明
RecorderSetter设置对象

✅️ 保存相关

📌 set.auto_backup()

此方法用于设置自动备份相关参数。

参数名称类型默认值说明
intervalintNone自动保存多少次时触发备份,为0表示不自动备份,为None时不修改已设置值(初始为0
folderstr
Path
None备份文件存放文件夹路径,为None时不修改已设置值(初始为'backup'
overwriteboolNone是否覆盖原有备份,为False时每个文件名都添加当前时间,为None时不修改已设置值(初始为False
返回类型说明
RecorderSetter设置对象

✅️ 表头相关

📌 set.header()

此方法用于设置表头值。

参数名称类型默认值说明
headerlist
tuple
必填表头值组成的列表
tablestr
None
True
None表名,只 xlsx 格式文件有效,为True表示活动数据表,为None表示不改变设置
to_fileboolTrue是否写入到文件
rowintNone指定写入文件的行号,不改变对象已设置的header_row属性,to_file不为True时无效
返回类型说明
RecorderSetter设置对象

📌 set.header_row()

此方法用于设置表头行号。

参数名称类型默认值说明
numint必填行号,设置0时以列号为表头值
tablestr
None
True
None表名,仅 xlsx 文件生效,为True表示活动数据表,为None表示不改变设置
返回类型说明
RecorderSetter设置对象

✅️ 样式相关

此方法用于设置单元格的链接样式,对使用add_link()添加的链接生效。

参数名称类型默认值说明
styleCellStyle
True
TrueCellStyle对象,为True时使用内置的默认样式
返回类型说明
RecorderSetter设置对象

📌 set.follow_styles()

此方法用于设置是否跟随上一行的样式,只有 xlsx 文件有效。

参数名称类型默认值说明
on_offboolTrue开或关
返回类型说明
RecorderSetter设置对象

📌 set.new_row_height()

此方法用于设置新行行高,只有 xlsx 文件有效。

参数名称类型默认值说明
heightfloat必填行高,传入None清空设置
返回类型说明
RecorderSetter设置对象

📌 set.new_row_styles()

此方法用于设置新行样式,只有 xlsx 文件有效,可传入多个,传入None则取消。

参数名称类型默认值说明
stylesCellStyle
List[CellStyle]
Dict[Union[str, int], CellStyle]
None
必填传入CellStyle对象设置整个新行,传入CellStyle对象组成的列表设置多个,传入dict自动匹配列,传入None清空设置
返回类型说明
RecorderSetter设置对象