3.6 KiB
| sidebar_position | description | options | ||||||
|---|---|---|---|---|---|---|---|---|
| 1 | 通过不同方式加载插件 |
|
加载插件
:::danger 警告
请勿在插件被加载前 import 插件模块，这会导致 NoneBot2 无法将其转换为插件而损失部分功能。
:::
加载插件通常在机器人的入口文件进行，例如在创建项目中创建的项目中的 bot.py 文件。在 NoneBot2 初始化完成后即可加载插件。
import nonebot
nonebot.init()
# load your plugin here
nonebot.run()
加载插件的方式有多种，但在底层的加载逻辑是一致的。以下是为加载插件提供的几种方式：
load_plugin
通过点分割模块名称来加载插件，通常用于加载单个插件或者是第三方插件。例如：
nonebot.load_plugin("path.to.your.plugin")
load_plugins
加载传入插件目录中的所有插件，通常用于加载一系列本地编写的插件。例如：
nonebot.load_plugins("src/plugins", "path/to/your/plugins")
:::warning 警告 请注意，插件所在目录应该为相对机器人入口文件可导入的，例如与入口文件在同一目录下。 :::
load_all_plugins
这种加载方式是以上两种方式的混合，加载所有传入的插件模块名称，以及所有给定目录下的插件。例如：
nonebot.load_all_plugins(["path.to.your.plugin"], ["path/to/your/plugins"])
load_from_json
通过 JSON 文件加载插件，是 load_all_plugins 的 JSON 变种。通过读取 JSON 文件中的 plugins 字段和 plugin_dirs 字段进行加载。例如：
{
"plugins": ["path.to.your.plugin"],
"plugin_dirs": ["path/to/your/plugins"]
}
nonebot.load_from_json("plugin_config.json", encoding="utf-8")
:::tip 提示
如果 JSON 配置文件中的字段无法满足你的需求，可以使用 load_all_plugins 方法自行读取配置来加载插件。
:::
load_from_toml
通过 TOML 文件加载插件，是 load_all_plugins 的 TOML 变种。通过读取 TOML 文件中的 [tool.nonebot] Table 中的 plugins 和 plugin_dirs Array 进行加载。例如：
[tool.nonebot]
plugins = ["path.to.your.plugin"]
plugin_dirs = ["path/to/your/plugins"]
nonebot.load_from_toml("plugin_config.toml", encoding="utf-8")
:::tip 提示
如果 TOML 配置文件中的字段无法满足你的需求，可以使用 load_all_plugins 方法自行读取配置来加载插件。
:::
load_builtin_plugin
加载一个内置插件，是 load_plugin 的封装。例如：
nonebot.load_builtin_plugin("echo")
确保插件加载和跨插件访问
倘若 plugin_a, plugin_b 均需被加载, 且 plugin_b 插件需要导入 plugin_a 才可运行, 可以在 plugin_b 利用 require 方法来确保插件加载, 同时可以直接 import 导入 plugin_a ,进行跨插件访问。
from nonebot import require
require('plugin_a')
import plugin_a
:::danger 警告
不用 require 方法也可以进行跨插件访问，但需要保证插件已加载。例如，以下两种方式均可确保插件正确加载：
import nonebot
# 顺序加载
nonebot.load_plugin("plugin_a")
nonebot.load_plugin("plugin_b")
import nonebot
# 同时加载
nonebot.load_all_plugins(["plugin_a", "plugin_b"], [])
:::