A customizable, adapter-independent, event-based scheduled broadcaster aiming for all nonebot2 adapters.
Project description
Nonebot Plugin Scheduled Broadcast
✨ 一款可配置的, 不依赖具体适配器的, 基于事件的定时广播插件. ✨
特性
- 基于一般事件
nonebot.adapters.Event
构造, 从而支持全部协议的信息发送. - 定时广播由文件配置, 基于
apscheduler
提供类crontab
的配置参数.
安装
使用 nb-cli
安装
- 在
nonebot2
项目的根目录下打开命令行, 输入以下指令即可安装:
nb-cli plugin install nonebot-plugin-scheduled-broadcast
使用包管理器安装
- 使用
pdm
安装:
pdm add nonebot-plugin-scheduled-broadcast
- 使用
poetry
安装:
poetry add nonebot-plugin-scheduled-broadcast
- 使用
pip
安装:(虽然不太推荐但大概率没事)
pip install nonebot-plugin-scheduled-broadcast
使用
启动广播
- 保证发送消息的
id
位于SUPERUSER
用户组中. - 在需要启动广播的地方发送:
启动广播/enablebc [广播ID]
广播ID
是可选项, 如果用户没有输入广播ID
, 则会使用对应事件的session_id
去掉user_id
的结果作为广播ID
, 如果此时广播ID
为空, 则不支持自动生成广播ID
.- 如果是第一次使用, 机器人在执行上述命令后, 在
nonebot2
项目的根目录下生成一个名为broadcast_policy.json
的配置文件. - 如果该机器人下已经存在相同的
广播ID
, 配置文件将会保留, 同时广播作业将被恢复
, 如果不需要修改config
中的内容, 不需要重启.
配置文件的填写
- 一般而言, 配置文件的结构如下:
{
"self_id": {
"broadcast_id": {
"config": {
"example": {"second": "*/30"}
},
"data": "event data (b64encode)",
"hash": "event hash (sha256)",
"enable": true
},
"another broadcast_id": {
// ...
}
},
"another self_id": {
// ...
}
}
config
的可用配置与apscheduler
一致, 以下给出一个示例, 该示例表示,example
命令会在每天10:24
, 每隔10
秒被触发:
{
"config": {
"example": {
"hour": 10,
"minute": 24,
"second": "*/10"
}
}
}
- 在准备好了配置文件后, 就可以准备编写待触发的指令了.
待触发指令的编写
- 由于本插件提供了一个装饰器, 可以按照如下方式编写待触发指令:
from nonebot import require
from nonebot.adapters import Event
from nonebot.log import logger
require("nonebot_plugin_scheduled_broadcast")
from nonebot_plugin_scheduled_broadcast.core import broadcast
@broadcast('example')
async def _(self_id: str, event: Event):
"""Scheduled example broadcast."""
message = generate_your_message()
try:
bot = nonebot.get_bots()[self_id] # select the target bot
await bot.send(event=event, message=message) # send message
except Exception:
logger.error(traceback.format_exc()) # print logs
- 触发指令编写完成以后, 重新启动机器人即可.
关闭广播
- 保证发送消息的
id
位于SUPERUSER
用户组中. - 在需要关闭广播的地方发送:
关闭广播/disablebc [广播ID]
广播ID
是可选项, 如果用户没有输入广播ID
, 则会使用对应事件的session_id
去掉user_id
的结果作为广播ID
, 如果此时广播ID
为空, 则不支持自动生成广播ID
.- 停止广播之后, 对应
广播ID
中的enable
将被置为false
, 为保持可复用性, 其余部分将不会改变, 同时广播作业将被暂停
, 如果不需要修改config
中的内容, 不需要重启.
配置
broadcast_policy_location
: 代表配置文件的存放位置, 默认值为./broadcast_policy.json
注意事项
- 由于每一个
Event
几乎不会相同, 建议不要在同一个地方多次执行启动广播
命令, 可能会刷屏的. - 由于用到了
pickle
的序列化和反序列化功能, 而该功能具有潜在的安全风险, 请谨慎对待来源不明的配置文件. 如果不确定配置文件的安全性, 建议重新启动广播以生成新的广播ID
, 然后替换配置文件中的config
键里面的内容. - 由于配置文件的生成限制, 当修改了
config
中的内容时, 必须需要重启机器人使得新的配置生效, 其它情况下均不需要重启机器人.
协议
- 本项目使用 MIT 协议
Project details
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
Close
Hashes for nonebot_plugin_scheduled_broadcast-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb884142716d3f8d75ada57cb24eb622ee057b2393cf0f7a20c50e0e7e78fc8f |
|
MD5 | 057017111fa4e05ec13397dd8b4b8ee4 |
|
BLAKE2b-256 | dedb8385c200511b4085a88aba1a54562d1f563adca71179c9101636437d5b2e |
Close
Hashes for nonebot_plugin_scheduled_broadcast-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2e39c1b4ccddf00ba13bdb0af209cea0a81d39ee01a169f4aa15e7a5e82479c |
|
MD5 | 002ab83d84b6d19519a0eccd7b61a552 |
|
BLAKE2b-256 | 1835ec4fe0730c9a671621b479c75df2888b45e97d1ebfda84b709e83d425ae6 |