Nonebot Plugin Manager base on import hook
Project description
Nonebot Plugin Manager
适用于 nonebot2 的非侵入式插件管理器
安装
从 PyPI 安装(推荐)
- 使用 nb-cli
nb plugin install nonebot_plugin_manager
- 使用 poetry
poetry add nonebot_plugin_manager
- 使用 pip
pip install nonebot_plugin_manager
从 GitHub 安装(不推荐)
git clone https://github.com/Jigsaw111/nonebot_plugin_manager.git
使用
使用前请先确保命令前缀为空,否则请在以下命令前加上命令前缀 (默认为 /
)。
-
npm list
查看当前群插件列表 -
-s, --store
可选参数,查看 Nonebot 插件商店(仅超级用户可用)
-
-d, --default
可选参数,管理默认设置(仅超级用户可用)
-
-g group_id, --group group_id
可选参数,管理指定群设置(仅超级用户可用)
-
npm block 插件名...
屏蔽当前群插件 (仅群管及超级用户可用) -
-a, --all
可选参数,全选插件
-
-d, --default
可选参数,管理默认设置 (仅超级用户可用)
-
-g group_id, --group group_id
可选参数,管理指定群设置(仅超级用户可用)
-
npm unblock 插件名...
启用当前群插件 (仅群管及超级用户可用) -
-a, --all
可选参数,全选插件
-
-d, --default
可选参数,管理默认设置 (仅超级用户可用)
-
-g group_id, --group group_id
可选参数,管理指定群设置(仅超级用户可用)
-
npm info 插件名
查询插件信息 (仅超级用户可用)
以下功能尚未实现
-
npm install 插件名...
安装插件 (仅超级用户可用) -
-i index, --index index
指定 PyPI 源
-
npm update 插件名...
更新插件 (仅超级用户可用) -
-i index, --index index
指定 PyPI 源
-
-a, --all
可选参数,全选插件
-
npm uninstall 插件名...
卸载插件 (仅超级用户可用) -
-a, --all
可选参数,全选插件
导出
from nonebot import require
export = require("nonebot_plugin_manager")
# 在指定群聊中启用/禁用插件
export.block_plugin(group_id, *plugins)
export.unblock_plugin(group_id, *plugins)
# 获取指定群插件列表
export.get_group_plugin_list(group_id)
Q&A
- 这是什么?
基于 import hook 的插件管理器,能够在不重启 nonebot2 的情况下分群管理插件。 - 有什么用?
在 nonebot2 仍然缺乏插件管理机制的时期暂时充当插件管理器。 - 自造 Rule 不是更好?
Rule 当然更好且更有效率,但是 Rule 是一种侵入式的插件管理方式,需要用户自行修改其他插件,这对于管理从 pypi 安装的插件来说相对复杂。而使用本插件,你不需要修改其他插件的任何内容,更符合插件之间松耦合的设计原则。
Thanks
展开更多
原理
使用 run_preprocessor
装饰器,在 Matcher 运行之前检测其所属的 Plugin 判断是否打断。
事实上 Nonebot 还是加载了插件,所以只能算是屏蔽而非卸载。
以下功能尚未实现
当然,你也可以使用 npm uninstall
命令来真正卸载插件,但我不建议你这样做,因为该命令将会重启 Nonebot 。
TO DO
- 分群插件管理
- 安装卸载插件
Bug
- 无法停用 Matcher 以外的机器人行为(如 APSchedule )
**解决方法:**暂无 - 任何人都可以屏蔽/启用插件
- 不能在其他插件里 import 本插件,否则将导致自锁。
**解决方法:**等 a12
Changelog
- 210330,修复启用/禁用颠倒的 bug。
- 210329,修复 block/unblock 指令中的 -a 参数无效的 bug,修复文档中导出部分的错误。
- 210320,新增
get_group_plugin_list
的 export 用于获取群插件列表。 - 210317,调整项目结构,将绝大多数数据处理操作移至 data,handle 只负责调用;修改 export,不再对其他插件暴露底层接口。
- 210314,修复
npm list
的 --group 参数不起作用的 bug,实现查询插件信息。 - 210313,实现爬取插件商店列表,实现 -h 参数,新增 export 导出给其他插件。
- 210312,重构 0.3.0,
setting.json
重命名为plugin_list.json
,结构改为plugin:{group_id:true,group_id:false}
。 - 210310,0.3.0 完工,将__init__.py分离成 setting,command,nb 三个文件。
- 210310,0.2.0 完工,命令格式改为 shelllike,使用
setting.json
作为配置文件,基本结构为group_id:{plugin:true,plugin:false}
。 - 210307,0.1.0 完工,上架插件商店。确定了通过
run_preprocessor
屏蔽 Matcher 的基本原理,使用block_list
作为全局设置(即只屏蔽 block_list 中的插件)
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
Close
Hashes for nonebot_plugin_manager-0.3.8.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84f643efdb87d9d37dde8d643ea1bc7f0b6b242841e2c9dc5038340cb2ea0df9 |
|
MD5 | 976d423f58921fcfac50047aa24ea09f |
|
BLAKE2b-256 | bf0f0fbdde32dc46996568246448de6c358206f0b086efe9a49a4e39addd7a7b |
Close
Hashes for nonebot_plugin_manager-0.3.8.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f1e8f53bc1e1de13f9e3371971a2825561678b92c2800d93a4741a24ceecce2 |
|
MD5 | 9307155b6e7da3b0cd59d8c30c1b0504 |
|
BLAKE2b-256 | 197e37dcc3e534d315fe14e09d11417c6d46b1eee3c8db2d8fb53449a17454c9 |