📒 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.path()`

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

参数名称	类型	默认值	说明
`path`	`str` `Path`	必填	文件路径
`file_type`	`str`	`None`	文件类型，可与路径后缀不一致

返回类型	说明
`Setter`	设置对象

📌 `set.file_type()`

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

说明

xlsx 类型的文件名必须是以'.xlsx'作为后缀，否则会报错。参数'byte'可简写为'b'。

参数名称	类型	默认值	说明
`file_type`	`str`	必填	文件类型，可与路径后缀不一致可选：`'txt'`、`'csv'`、`'json'`、`'jsonl'`、`'db'`、`'byte'`、`'b'`

返回类型	说明
`Setter`	设置对象本身

📌 `set.encoding()`

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

txt、csv、json、jsonl 类型文件支持此方法。

参数名称	类型	默认值	说明
`encoding`	`str`	必填	编码格式

返回类型	说明
`Setter`	设置对象

📌 `set.delimiter()`

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

csv 类型文件支持此方法。

参数名称	类型	默认值	说明
`delimiter`	`str`	必填	csv 文件分隔符

返回类型	说明
`Setter`	设置对象

📌 `set.quote_char()`

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

csv 类型文件支持此方法。

参数名称	类型	默认值	说明
`quote_char`	`str`	必填	csv 文件引用符

返回类型	说明
`Setter`	设置对象

📌 `set.show_msg()`

此方法用于设置是否显示运行信息，如保存文件提示。

参数名称	类型	默认值	说明
`on_off`	`bool`	必填	开或关

返回类型	说明
`Setter`	设置对象

✅️ 数据相关

📌 `set.table()`

此方法用于设置默认数据表或数据块。

xlsx 和 db 类型文件支持此方法。

参数名称	类型	默认值	说明
`name`	`str` `None` `True`	必填	表名称，为`None`或`Ture`时表示活动数据表

返回类型	说明
`Setter`	设置对象

📌 `set.left()`

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

xlsx、csv、db、json、jsonl 类型文件支持此方法。

参数名称	类型	默认值	说明
`data`	`Any`	必填	插入的数据，任意格式

返回类型	说明
`Setter`	设置对象

📌 `set.right()`

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

xlsx、csv、db、json、jsonl 类型文件支持此方法。

参数名称	类型	默认值	说明
`data`	`Any`	必填	插入的数据，任意格式

返回类型	说明
`Setter`	设置对象

📌 `set.data_col()`

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

xlsx、csv 类型文件支持此方法。

参数名称	类型	默认值	说明
`col`	`str` `int`	必填	列号或列序号，`0`表示新列（表头长度后一列），不支持输入表头值

返回类型	说明
`Setter`	设置对象

✅️ 保存相关

📌 `set.cache_size()`

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

参数名称	类型	默认值	说明
`size`	`int`	必填	接收多少条数据自动保持，为`0`不会自动保存

返回类型	说明
`Setter`	设置对象

📌 `set.auto_backup()`

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

参数名称	类型	默认值	说明
`interval`	`int`	`None`	自动保存多少次时触发备份，为`0`表示不自动备份，为`None`时不修改已设置值（初始为`0`）
`folder`	`str` `Path`	`None`	备份文件存放文件夹路径，为`None`时不修改已设置值（初始为`'backup'`）
`overwrite`	`bool`	`None`	是否覆盖原有备份，为`False`时每个文件名都添加当前时间，为`None`时不修改已设置值（初始为`False`）

返回类型	说明
`Setter`	设置对象

✅️ 表头相关

📌 `set.header()`

此方法用于设置表头值。

xlsx 和 csv 类型文件支持此方法。

参数名称	类型	默认值	说明
`header`	`list` `tuple`	必填	表头值组成的列表
`to_file`	`bool`	`True`	是否写入到文件
`row`	`int`	`None`	指定写入文件的行号，不改变对象已设置的`header_row`属性，`to_file`不为`True`时无效
`table`	`str` `None` `True`	`None`	表名，只 xlsx 格式文件有效，为`True`表示活动数据表，为`None`表示不改变设置

返回类型	说明
`Setter`	设置对象

📌 `set.header_row()`

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

xlsx 和 csv 类型文件支持此方法。

参数名称	类型	默认值	说明
`num`	`int`	必填	行号，设置`0`时以列号为表头值
`table`	`str` `None` `True`	`None`	表名，仅 xlsx 文件生效，为`True`表示活动数据表，为`None`表示不改变设置

返回类型	说明
`Setter`	设置对象

📌 `set.auto_new_header()`

此方法用于设置数据中有表头不存在的列时是否自动添加到表头。

xlsx、csv 和 db 类型文件支持此方法。

参数名称	类型	默认值	说明
`on_off`	`bool`	`True`	`bool`表示开关

返回类型	说明
`Setter`	设置对象

✅️ 样式相关

样式相关设置仅 xlsx 类型文件支持。

📌 `set.link_style()`

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

参数名称	类型	默认值	说明
`style`	`CellStyle` `True`	`True`	`CellStyle`对象，为`True`时使用内置的默认样式

返回类型	说明
`Setter`	设置对象

📌 `set.follow_styles()`

此方法用于设置是否跟随上一行的样式。

参数名称	类型	默认值	说明
`on_off`	`bool`	`True`	开或关

返回类型	说明
`Setter`	设置对象

📌 `set.new_row_height()`

此方法用于设置新行行高。

参数名称	类型	默认值	说明
`height`	`float`	必填	行高，传入None清空设置

返回类型	说明
`Setter`	设置对象

📌 `set.new_row_styles()`

此方法用于设置新行样式，可传入多个，传入None则取消。

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

返回类型	说明
`Setter`	设置对象

✅️ 使用方法​

✅️ 运行参数​

📌 set.path()​

📌 set.file_type()​

📌 set.encoding()​

📌 set.delimiter()​

📌 set.quote_char()​

📌 set.show_msg()​

✅️ 数据相关​

📌 set.table()​

📌 set.left()​

📌 set.right()​

📌 set.data_col()​

✅️ 保存相关​

📌 set.cache_size()​

📌 set.auto_backup()​

✅️ 表头相关​

📌 set.header()​

📌 set.header_row()​

📌 set.auto_new_header()​

✅️ 样式相关​

📌 set.link_style()​

📌 set.follow_styles()​

📌 set.new_row_height()​

📌 set.new_row_styles()​