mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-28 16:16:21 +08:00
592 lines
8.4 KiB
Markdown
592 lines
8.4 KiB
Markdown
---
|
|
contentSidebar: true
|
|
sidebarDepth: 0
|
|
---
|
|
|
|
# NoneBot.plugin 模块
|
|
|
|
## 插件
|
|
|
|
为 NoneBot 插件开发提供便携的定义函数。
|
|
|
|
|
|
## `plugins`
|
|
|
|
|
|
* **类型**
|
|
|
|
`Dict[str, Plugin]`
|
|
|
|
|
|
|
|
* **说明**
|
|
|
|
已加载的插件
|
|
|
|
|
|
|
|
## _class_ `Plugin`
|
|
|
|
基类：`object`
|
|
|
|
存储插件信息
|
|
|
|
|
|
### `name`
|
|
|
|
|
|
* **类型**: `str`
|
|
|
|
|
|
* **说明**: 插件名称，使用 文件/文件夹 名称作为插件名
|
|
|
|
|
|
### `module`
|
|
|
|
|
|
* **类型**: `ModuleType`
|
|
|
|
|
|
* **说明**: 插件模块对象
|
|
|
|
|
|
### `matcher`
|
|
|
|
|
|
* **类型**: `Set[Type[Matcher]]`
|
|
|
|
|
|
* **说明**: 插件内定义的 `Matcher`
|
|
|
|
|
|
## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个基础事件响应器，可自定义类型。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `type: str`: 事件响应器类型
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_metaevent(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个元事件响应器。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_message(rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=True, state=None)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个消息事件响应器。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_notice(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个通知事件响应器。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_request(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个请求事件响应器。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_startswith(msg, rule=None, **kwargs)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容开头时响应。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `msg: str`: 指定消息开头内容
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_endswith(msg, rule=None, **kwargs)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容结尾时响应。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `msg: str`: 指定消息结尾内容
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## `on_command(cmd, rule=None, aliases=None, **kwargs)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个消息事件响应器，并且当消息以指定命令开头时响应。
|
|
|
|
命令匹配规则参考: [命令形式匹配](rule.html#command-command)
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
* `MatcherGroup`
|
|
|
|
|
|
|
|
## `on_regex(pattern, flags=0, rule=None, **kwargs)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个消息事件响应器，并且当消息匹配正则表达式时响应。
|
|
|
|
命令匹配规则参考: [正则匹配](rule.html#regex-regex-flags-0)
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `pattern: str`: 正则表达式
|
|
|
|
|
|
* `flags: Union[int, re.RegexFlag]`: 正则匹配标志
|
|
|
|
|
|
* `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则
|
|
|
|
|
|
* `permission: Optional[Permission]`: 事件响应权限
|
|
|
|
|
|
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
|
|
|
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
|
|
|
|
|
* `priority: int`: 事件响应器优先级
|
|
|
|
|
|
* `block: bool`: 是否阻止事件向更低优先级传递
|
|
|
|
|
|
* `state: Optional[dict]`: 默认的 state
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
|
|
## _class_ `CommandGroup`
|
|
|
|
基类：`object`
|
|
|
|
命令组，用于声明一组有相同名称前缀的命令。
|
|
|
|
|
|
### `__init__(cmd, **kwargs)`
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
|
|
|
|
|
* `**kwargs`: 其他传递给 `on_command` 的参数默认值，参考 [on_command](#on-command-cmd-rule-none-aliases-none-kwargs)
|
|
|
|
|
|
|
|
### `basecmd`
|
|
|
|
|
|
* **类型**: `Tuple[str, ...]`
|
|
|
|
|
|
* **说明**: 命令前缀
|
|
|
|
|
|
### `base_kwargs`
|
|
|
|
|
|
* **类型**: `Dict[str, Any]`
|
|
|
|
|
|
* **说明**: 其他传递给 `on_command` 的参数默认值
|
|
|
|
|
|
### `command(cmd, **kwargs)`
|
|
|
|
|
|
* **说明**
|
|
|
|
注册一个新的命令。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
|
|
|
|
|
* `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Type[Matcher]`
|
|
|
|
|
|
* `MatcherGroup`
|
|
|
|
|
|
|
|
## `load_plugin(module_path)`
|
|
|
|
|
|
* **说明**
|
|
|
|
使用 `importlib` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `module_path: str`: 插件名称 `path.to.your.plugin`
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Optional[Plugin]`
|
|
|
|
|
|
|
|
## `load_plugins(*plugin_dir)`
|
|
|
|
|
|
* **说明**
|
|
|
|
导入目录下多个插件，以 `_` 开头的插件不会被导入！
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
* `*plugin_dir: str`: 插件路径
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Set[Plugin]`
|
|
|
|
|
|
|
|
## `load_builtin_plugins()`
|
|
|
|
|
|
* **说明**
|
|
|
|
导入 NoneBot 内置插件
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Plugin`
|
|
|
|
|
|
|
|
## `get_loaded_plugins()`
|
|
|
|
|
|
* **说明**
|
|
|
|
获取当前已导入的插件。
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
* `Set[Plugin]`
|