本节介绍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()
此方法用于设置缓存大小,即接收多少条数据就触发自动保存。
📌 set.path()
此方法用于设置文件路径。调用时会自动保存缓存数据到文件。
参数名称 | 类型 | 默认值 | 说明 |
---|
path | str
Path | 必填 | 文件路径 |
file_type | str | None | 文件类型,可与路径后缀不一致 |
📌 set.file_type()
此方法用于手动设置文件类型(xlsx 除外)。
xlsx 类型的文件名必须是以'.xlsx'
作为后缀,否则会报错。
参数名称 | 类型 | 默认值 | 说明 |
---|
file_type | str | 必填 | 文件类型,可选'txt' 、'csv' 、'json' 、'jsonl' ,可与路径后缀不一致 |
返回类型 | 说明 |
---|
RecorderSetter | 设置对象本身 |
📌 set.encoding()
此方法用于设置文本类型文件的编码。编目默认为'utf-8'
。
参数名称 | 类型 | 默认值 | 说明 |
---|
encoding | str | 必填 | 编码格式 |
📌 set.delimiter()
此方法用于设置 csv 文件分隔符。分隔符默认为','
。
参数名称 | 类型 | 默认值 | 说明 |
---|
delimiter | str | 必填 | csv 文件分隔符 |
📌 set.quote_char()
此方法用于设置 csv 文件引用符。引用符默认为'"'
。
参数名称 | 类型 | 默认值 | 说明 |
---|
quote_char | str | 必填 | csv 文件引用符 |
📌 set.show_msg()
此方法用于设置是否显示运行信息。
参数名称 | 类型 | 默认值 | 说明 |
---|
on_off | bool | 必填 | 开 或关 |
✅️ 数据相关
📌 set.table()
此方法用于设置默认数据表,仅 xlsx 文件有效。
参数名称 | 类型 | 默认值 | 说明 |
---|
name | str
None
True | 必填 | 表名称,为None 或Ture 时表示活动数据表 |
📌 set.before()
此方法用于设置在每条数据前面补充的数据。
参数名称 | 类型 | 默认值 | 说明 |
---|
data | Any | 必填 | 插入的数据,任意格式 |
📌 set.after()
此方法用于设置在每条数据后面补充的数据。
参数名称 | 类型 | 默认值 | 说明 |
---|
data | Any | 必填 | 插入的数据,任意格式 |
📌 set.data_col()
此方法用于设置默认填充数据的列。
参数名称 | 类型 | 默认值 | 说明 |
---|
col | str
int | 必填 | 列号或列序号,0 表示新列(表头长度后一列),不支持输入表头值 |
✅️ 保存相关
📌 set.auto_backup()
此方法用于设置自动备份相关参数。
参数名称 | 类型 | 默认值 | 说明 |
---|
interval | int | None | 自动保存多少次时触发备份,为0 表示不自动备份,为None 时不修改已设置值(初始为0 ) |
folder | str
Path | None | 备份文件存放文件夹路径,为None 时不修改已设置值(初始为'backup' ) |
overwrite | bool | None | 是否覆盖原有备份,为False 时每个文件名都添加当前时间,为None 时不修改已设置值(初始为False ) |
✅️ 表头相关
此方法用于设置表头值。
参数名称 | 类型 | 默认值 | 说明 |
---|
header | list
tuple | 必填 | 表头值组成的列表 |
table | str
None
True | None | 表名,只 xlsx 格式文件有效,为True 表示活动数据表,为None 表示不改变设置 |
to_file | bool | True | 是否写入到文件 |
row | int | None | 指定写入文件的行号,不改变对象已设置的header_row 属性,to_file 不为True 时无效 |
此方法用于设置表头行号。
参数名称 | 类型 | 默认值 | 说明 |
---|
num | int | 必填 | 行号,设置0 时以列号为表头值 |
table | str
None
True | None | 表名,仅 xlsx 文件生效,为True 表示活动数据表,为None 表示不改变设置 |
✅️ 样式相关
📌 set.link_style()
此方法用于设置单元格的链接样式,对使用add_link()
添加的链接生效。
参数名称 | 类型 | 默认值 | 说明 |
---|
style | CellStyle
True | True | CellStyle 对象,为True 时使用内置的默认样式 |
📌 set.follow_styles()
此方法用于设置是否跟随上一行的样式,只有 xlsx 文件有效。
参数名称 | 类型 | 默认值 | 说明 |
---|
on_off | bool | True | 开或关 |
📌 set.new_row_height()
此方法用于设置新行行高,只有 xlsx 文件有效。
参数名称 | 类型 | 默认值 | 说明 |
---|
height | float | 必填 | 行高,传入None清空设置 |
📌 set.new_row_styles()
此方法用于设置新行样式,只有 xlsx 文件有效,可传入多个,传入None
则取消。
参数名称 | 类型 | 默认值 | 说明 |
---|
styles | CellStyle
List[CellStyle]
Dict[Union[str, int], CellStyle]
None | 必填 | 传入CellStyle 对象设置整个新行,传入CellStyle 对象组成的列表设置多个,传入dict 自动匹配列,传入None 清空设置 |