nb_cli.plugin.load

本模块定义插件加载接口。

def `load_plugin(module_path)`

说明
加载单个插件，可以是本地插件或是通过 pip 安装的插件。
参数
- module_path (str | pathlib.Path): 插件名称 path.to.your.plugin 或插件路径 pathlib.Path(path/to/your/plugin)
返回
- Plugin | None

说明
导入指定列表中的插件以及指定目录下多个插件，以 _ 开头的插件不会被导入!
参数
- module_path (Iterable[str]): 指定插件集合
- plugin_dir (Iterable[str]): 指定文件夹路径集合
返回
- set[Plugin]

说明
导入指定 toml 文件 [tool.nonebot] 中的 cli_plugins 以及 cli_plugin_dirs 下多个插件，以 _ 开头的插件不会被导入!
参数
- file_path (str): 指定 toml 文件路径
- encoding (str): 指定 toml 文件编码
返回
- set[Plugin] | None

用法

pyproject.toml

[tool.nonebot]
cli_plugins = ["some_plugin"]
cli_plugin_dirs = ["some_dir"]