数据存储
在使用插件的过程中,难免会需要存储一些持久化数据,例如用户的个人信息、群组的信息等。除了使用数据库等第三方存储之外,还可以使用本地文件来自行管理数据。NoneBot 提供了 nonebot-plugin-localstore
插件,可用于获取正确的数据存储路径并写入数据。
安装插件
在使用前请先安装 nonebot-plugin-localstore
插件至项目环境中,可参考获取商店插件来了解并选择安装插件的方式。如:
在项目目录下执行以下命令:
nb plugin install nonebot-plugin-localstore
使用插件
nonebot-plugin-localstore
插件兼容 Windows、Linux 和 macOS 等操作系统,使用时无需关心操作系统的差异。同时插件提供 nb-cli
脚本,可以使用 nb localstore
命令来检查数据存储路径。
在使用本插件前同样需要使用 require
方法进行加载并导入需要使用的方法,可参考 跨插件访问 一节进行了解,如:
from nonebot import require
require("nonebot_plugin_localstore")
import nonebot_plugin_localstore as store
# 获取插件缓存目录
cache_dir = store.get_plugin_cache_dir()
# 获取插件缓存文件
cache_file = store.get_plugin_cache_file("file_name")
# 获取插件数据目录
data_dir = store.get_plugin_data_dir()
# 获取插件数据文件
data_file = store.get_plugin_data_file("file_name")
# 获取插件配置目录
config_dir = store.get_plugin_config_dir()
# 获取插件配置文件
config_file = store.get_plugin_config_file("file_name")
在 Windows 和 macOS 系统下,插件的数据目录和配置目录是同一个目录,因此在使用时需要注意避免文件名冲突。
插件提供的方法均返回一个 pathlib.Path
路径,可以参考 pathlib 文档来了解如何使用。常用的方法有:
from pathlib import Path
data_file = store.get_plugin_data_file("file_name")
# 写入文件内容
data_file.write_text("Hello World!")
# 读取文件内容
data = data_file.read_text()
对于嵌套插件,子插件的存储目录将位于父插件存储目录下。
配置项
localstore_cache_dir
自定义缓存目录
默认值:
- macOS:
~/Library/Caches/<AppName>
- Unix:
~/.cache/<AppName>
(XDG default) - Windows:
C:\Users\<username>\AppData\Local\<AppName>\Cache
LOCALSTORE_CACHE_DIR=/tmp/cache
localstore_data_dir
自定义数据目录
默认值:
- macOS:
~/Library/Application Support/<AppName>
- Unix:
~/.local/share/<AppName>
or in $XDG_DATA_HOME, if defined - Win XP (not roaming):
C:\Documents and Settings\<username>\Application Data\<AppName>
- Win 7 (not roaming):
C:\Users\<username>\AppData\Local\<AppName>
LOCALSTORE_DATA_DIR=/tmp/data
localstore_config_dir
自定义配置目录
默认值:
- macOS: same as user_data_dir
- Unix:
~/.config/<AppName>
- Win XP (roaming):
C:\Documents and Settings\<username>\Local Settings\Application Data\<AppName>
- Win 7 (roaming):
C:\Users\<username>\AppData\Roaming\<AppName>
LOCALSTORE_CONFIG_DIR=/tmp/config