mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-12-01 01:25:07 +08:00
112 lines
3.0 KiB
Markdown
112 lines
3.0 KiB
Markdown
|
---
|
||
|
|
mdx:
|
||
|
|
format: md
|
||
|
|
sidebar_position: 0
|
||
|
|
description: nonebot.plugin 模块
|
||
|
|
---
|
||
|
|
|
||
|
|
# nonebot.plugin
|
||
|
|
|
||
|
|
本模块为 NoneBot 插件开发提供便携的定义函数。
|
||
|
|
|
||
|
|
## 快捷导入
|
||
|
|
|
||
|
|
为方便使用，本模块从子模块导入了部分内容，以下内容可以直接通过本模块导入:
|
||
|
|
|
||
|
|
- `on` => [`on`](on.md#on)
|
||
|
|
- `on_metaevent` => [`on_metaevent`](on.md#on-metaevent)
|
||
|
|
- `on_message` => [`on_message`](on.md#on-message)
|
||
|
|
- `on_notice` => [`on_notice`](on.md#on-notice)
|
||
|
|
- `on_request` => [`on_request`](on.md#on-request)
|
||
|
|
- `on_startswith` => [`on_startswith`](on.md#on-startswith)
|
||
|
|
- `on_endswith` => [`on_endswith`](on.md#on-endswith)
|
||
|
|
- `on_fullmatch` => [`on_fullmatch`](on.md#on-fullmatch)
|
||
|
|
- `on_keyword` => [`on_keyword`](on.md#on-keyword)
|
||
|
|
- `on_command` => [`on_command`](on.md#on-command)
|
||
|
|
- `on_shell_command` => [`on_shell_command`](on.md#on-shell-command)
|
||
|
|
- `on_regex` => [`on_regex`](on.md#on-regex)
|
||
|
|
- `on_type` => [`on_type`](on.md#on-type)
|
||
|
|
- `CommandGroup` => [`CommandGroup`](on.md#CommandGroup)
|
||
|
|
- `Matchergroup` => [`MatcherGroup`](on.md#MatcherGroup)
|
||
|
|
- `load_plugin` => [`load_plugin`](load.md#load-plugin)
|
||
|
|
- `load_plugins` => [`load_plugins`](load.md#load-plugins)
|
||
|
|
- `load_all_plugins` => [`load_all_plugins`](load.md#load-all-plugins)
|
||
|
|
- `load_from_json` => [`load_from_json`](load.md#load-from-json)
|
||
|
|
- `load_from_toml` => [`load_from_toml`](load.md#load-from-toml)
|
||
|
|
- `load_builtin_plugin` =>
|
||
|
|
[`load_builtin_plugin`](load.md#load-builtin-plugin)
|
||
|
|
- `load_builtin_plugins` =>
|
||
|
|
[`load_builtin_plugins`](load.md#load-builtin-plugins)
|
||
|
|
- `require` => [`require`](load.md#require)
|
||
|
|
- `PluginMetadata` => [`PluginMetadata`](model.md#PluginMetadata)
|
||
|
|
|
||
|
|
## _def_ `get_plugin(plugin_id)` {#get-plugin}
|
||
|
|
|
||
|
|
- **说明**
|
||
|
|
|
||
|
|
获取已经导入的某个插件。
|
||
|
|
|
||
|
|
如果为 `load_plugins` 文件夹导入的插件，则为文件(夹)名。
|
||
|
|
|
||
|
|
如果为嵌套的子插件，标识符为 `父插件标识符:子插件文件(夹)名`。
|
||
|
|
|
||
|
|
- **参数**
|
||
|
|
|
||
|
|
- `plugin_id` (str): 插件标识符，即 [Plugin.id\_](model.md#Plugin-id-)。
|
||
|
|
|
||
|
|
- **返回**
|
||
|
|
|
||
|
|
- [Plugin](model.md#Plugin) | None
|
||
|
|
|
||
|
|
## _def_ `get_plugin_by_module_name(module_name)` {#get-plugin-by-module-name}
|
||
|
|
|
||
|
|
- **说明**
|
||
|
|
|
||
|
|
通过模块名获取已经导入的某个插件。
|
||
|
|
|
||
|
|
如果提供的模块名为某个插件的子模块，同样会返回该插件。
|
||
|
|
|
||
|
|
- **参数**
|
||
|
|
|
||
|
|
- `module_name` (str): 模块名，即 [Plugin.module_name](model.md#Plugin-module-name)。
|
||
|
|
|
||
|
|
- **返回**
|
||
|
|
|
||
|
|
- [Plugin](model.md#Plugin) | None
|
||
|
|
|
||
|
|
## _def_ `get_loaded_plugins()` {#get-loaded-plugins}
|
||
|
|
|
||
|
|
- **说明:** 获取当前已导入的所有插件。
|
||
|
|
|
||
|
|
- **参数**
|
||
|
|
|
||
|
|
empty
|
||
|
|
|
||
|
|
- **返回**
|
||
|
|
|
||
|
|
- set[[Plugin](model.md#Plugin)]
|
||
|
|
|
||
|
|
## _def_ `get_available_plugin_names()` {#get-available-plugin-names}
|
||
|
|
|
||
|
|
- **说明:** 获取当前所有可用的插件标识符（包含尚未加载的插件）。
|
||
|
|
|
||
|
|
- **参数**
|
||
|
|
|
||
|
|
empty
|
||
|
|
|
||
|
|
- **返回**
|
||
|
|
|
||
|
|
- set[str]
|
||
|
|
|
||
|
|
## _def_ `get_plugin_config(config)` {#get-plugin-config}
|
||
|
|
|
||
|
|
- **说明:** 从全局配置获取当前插件需要的配置项。
|
||
|
|
|
||
|
|
- **参数**
|
||
|
|
|
||
|
|
- `config` (type[C])
|
||
|
|
|
||
|
|
- **返回**
|
||
|
|
|
||
|
|
- C
|