适用于 Nonebot2 的聊天记录插件
Project description
nonebot-plugin-chatrecorder
适用于 Nonebot2 的聊天记录插件。
将聊天消息存至数据库中,方便其他插件使用。
安装
- 使用 nb-cli
nb plugin install nonebot_plugin_chatrecorder
- 使用 pip
pip install nonebot_plugin_chatrecorder
配置项
以下配置项可在
.env.*
文件中设置,具体参考 NoneBot 配置方式
chatrecorder_record_send_msg
- 类型:
bool
- 默认:
True
- 说明:是否记录机器人自己发出的消息
chatrecorder_record_migration_bot_id
- 类型:
Optional[str]
- 默认:
None
- 说明:在旧版本(0.1.x) 时使用的机器人账号(机器人qq号),用于数据库迁移;若使用过此插件的旧版本则必须配置,数据库迁移完成后可删除;未使用过旧版本可不配置
其他说明
插件依赖 nonebot-plugin-datastore 插件来提供数据库支持
nonebot-plugin-datastore
插件默认使用 SQLite 数据库,
消息记录文件会存放在 nonebot-plugin-datastore
插件设置的数据目录
[!NOTE]
由于在 OneBot V11 适配器中,机器人发送的消息中可能存在 base64 形式的图片、语音等,
为避免消息记录文件体积过大,本插件会将 base64 形式的图片、语音等存成文件,并在消息记录中以文件路径替代。
这些文件会放置在
nonebot-plugin-datastore
插件设置的缓存目录,建议定期清理
插件依赖 nonebot-plugin-session 插件来获取会话相关信息
其中 id1
代表“用户级别”的 id,即 user_id
;
id2
代表“群组级别”的 id,如对于 OneBot V11
适配器,id2
代表 group_id
,对于 OneBot V12
适配器中的单级群组,id2
代表群组 id,对于 OneBot V12
适配器中的两级群组,id2
代表 channel_id
;
id3
代表“两级群组”的 id,如对于 OneBot V12
适配器中的两级群组,id3
代表 guild_id
;
使用
其他插件可使用本插件提供的接口获取消息记录
先在插件代码最前面声明依赖:
from nonebot import require
require("nonebot_plugin_chatrecorder")
使用示例:
- 获取当前群内成员 "12345" 和 "54321" 1天之内的消息记录
from nonebot.adapters.onebot.v11 import GroupMessageEvent
from nonebot_plugin_chatrecorder import get_message_records
@matcher.handle()
async def _(event: GroupMessageEvent):
records = await get_message_records(
id1s=["12345", "54321"],
id2s=[str(event.group_id)],
time_start=datetime.utcnow() - timedelta(days=1),
)
[!NOTE]
time_start
和time_stop
参数 传入的datetime
对象必须为 感知型对象(即包含时区信息),或者确保其为 UTC 时间
- 获取当前会话成员 1 天之内的消息记录
from nonebot_plugin_session import extract_session, SessionIdType
from nonebot_plugin_chatrecorder import get_message_records_by_session
@matcher.handle()
async def _(bot: Bot, event: Event):
session = extract_session(bot, event)
records = await get_message_records_by_session(
session, SessionIdType.GROUP_USER,
time_start=datetime.utcnow() - timedelta(days=1),
)
- 获取当前 群聊/私聊 除机器人发出的消息外,其他消息的纯本文形式
from nonebot_plugin_session import extract_session, SessionIdType
from nonebot_plugin_chatrecorder import get_messages_plain_text_by_session
@matcher.handle()
async def _(bot: Bot, event: Event):
session = extract_session(bot, event)
msgs = await get_messages_plain_text_by_session(
session, SessionIdType.GROUP, types=["message"]
)
详细参数及说明见代码注释
支持的 adapter
OneBot v11 | OneBot v12 | Console | Kaiheila | QQ Guild | Telegram |
---|---|---|---|---|---|
✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
鸣谢
- nonebot-plugin-send-anything-anywhere 项目的灵感来源以及部分实现的参考
- uy/sun 感谢歪日佬的技术支持
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nonebot_plugin_chatrecorder-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 434674af70ef2b68c9bb9b353e582be5af7407e57e971bed479f4809ddead429 |
|
MD5 | 87662b0a9641213ffd9fc00289b923db |
|
BLAKE2b-256 | 7bb80437a44b614d49a46270bef74583ed470244d3880b64fc95bc274390b11a |
Hashes for nonebot_plugin_chatrecorder-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68983635f254a102f040186f8d8a8441a2c3e0e6487968805bf3408d09c0542f |
|
MD5 | 06d9894b98664d4889774b9f888d1d3a |
|
BLAKE2b-256 | 28a4bae6882df9a144fffe275b844c61dead0529e650b6e3686add69f613bc00 |