ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-26 15:51:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

令参数符合标准

Browse Source
This commit is contained in:
hemengyang
2022-01-12 18:31:12 +08:00
parent a5f32febbd
commit 456d333568
17 changed files with 85 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
nonebot/plugin/load.py
View File

@ -14,8 +14,7 @@ def load_plugin(module_path: str) -> Optional[Plugin]:
"""
使用 `PluginManager` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。
:参数:
参数:
module_path: 插件名称 `path.to.your.plugin`
:返回:
@ -32,8 +31,7 @@ def load_plugins(*plugin_dir: str) -> Set[Plugin]:
"""
导入目录下多个插件，以 `_` 开头的插件不会被导入！
:参数:
参数:
- `*plugin_dir: str`: 插件路径
:返回:
@ -51,8 +49,7 @@ def load_all_plugins(
"""
导入指定列表中的插件以及指定目录下多个插件，以 `_` 开头的插件不会被导入！
:参数:
参数:
- `module_path: Iterable[str]`: 指定插件集合
- `plugin_dir: Iterable[str]`: 指定插件路径集合
@ -69,8 +66,7 @@ def load_from_json(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
"""
导入指定 json 文件中的 `plugins` 以及 `plugin_dirs` 下多个插件，以 `_` 开头的插件不会被导入！
:参数:
参数:
- `file_path: str`: 指定 json 文件路径
- `encoding: str`: 指定 json 文件编码
@ -92,8 +88,7 @@ def load_from_toml(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
导入指定 toml 文件 `[tool.nonebot]` 中的 `plugins` 以及 `plugin_dirs` 下多个插件，
以 `_` 开头的插件不会被导入！
:参数:
参数:
- `file_path: str`: 指定 toml 文件路径
- `encoding: str`: 指定 toml 文件编码
@ -147,8 +142,7 @@ def require(name: str) -> Export:
"""
获取一个插件的导出内容
:参数:
参数:
name: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
:返回:

75
nonebot/plugin/on.py
View File

@ -57,8 +57,7 @@ def on(
"""
注册一个基础事件响应器，可自定义类型。
:参数:
参数:
type: 事件响应器类型
rule: 事件响应规则
permission: 事件响应权限
@ -101,8 +100,7 @@ def on_metaevent(
"""
注册一个元事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -144,8 +142,7 @@ def on_message(
"""
注册一个消息事件响应器。
:参数:
参数:
rule: 事件响应规则
permission: 事件响应权限
handlers: 事件处理函数列表
@ -187,8 +184,7 @@ def on_notice(
"""
注册一个通知事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -229,8 +225,7 @@ def on_request(
"""
注册一个请求事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -268,8 +263,7 @@ def on_startswith(
"""
注册一个消息事件响应器，并且当消息的**文本部分**以指定内容开头时响应。
:参数:
参数:
msg: 指定消息开头内容
rule: 事件响应规则
ignorecase: 是否忽略大小写
@ -297,8 +291,7 @@ def on_endswith(
"""
注册一个消息事件响应器，并且当消息的**文本部分**以指定内容结尾时响应。
:参数:
参数:
msg: 指定消息结尾内容
rule: 事件响应规则
ignorecase: 是否忽略大小写
@ -325,8 +318,7 @@ def on_keyword(
"""
注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。
:参数:
参数:
keywords: 关键词列表
rule: 事件响应规则
permission: 事件响应权限
@ -355,8 +347,7 @@ def on_command(
命令匹配规则参考: `命令形式匹配 <rule.md#command-command>`_
:参数:
参数:
cmd: 指定命令内容
rule: 事件响应规则
aliases: 命令别名
@ -394,8 +385,7 @@ def on_shell_command(
并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]` 中
:参数:
参数:
cmd: 指定命令内容
rule: 事件响应规则
aliases: 命令别名
@ -432,8 +422,7 @@ def on_regex(
命令匹配规则参考: `正则匹配 <rule.md#regex-regex-flags-0>`_
:参数:
参数:
pattern: 正则表达式
flags: 正则匹配标志
rule: 事件响应规则
@ -456,8 +445,7 @@ class CommandGroup:
def __init__(self, cmd: Union[str, Tuple[str, ...]], **kwargs):
"""
:参数:
参数:
cmd: 命令前缀
**kwargs`on_command` 的参数默认值，参考 `on_command <#on-command-cmd-rule-none-aliases-none-kwargs>`_
"""
@ -476,8 +464,7 @@ class CommandGroup:
"""
注册一个新的命令。
:参数:
参数:
cmd: 命令前缀
**kwargs`on_command` 的参数，将会覆盖命令组默认值
@ -498,8 +485,7 @@ class CommandGroup:
"""
注册一个新的命令。
:参数:
参数:
cmd: 命令前缀
**kwargs`on_shell_command` 的参数，将会覆盖命令组默认值
@ -535,8 +521,7 @@ class MatcherGroup:
"""
注册一个基础事件响应器，可自定义类型。
:参数:
参数:
type: 事件响应器类型
rule: 事件响应规则
permission: 事件响应权限
@ -560,8 +545,7 @@ class MatcherGroup:
"""
注册一个元事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -585,8 +569,7 @@ class MatcherGroup:
"""
注册一个消息事件响应器。
:参数:
参数:
rule: 事件响应规则
permission: 事件响应权限
handlers: 事件处理函数列表
@ -610,8 +593,7 @@ class MatcherGroup:
"""
注册一个通知事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -634,8 +616,7 @@ class MatcherGroup:
"""
注册一个请求事件响应器。
:参数:
参数:
rule: 事件响应规则
handlers: 事件处理函数列表
temp: 是否为临时事件响应器（仅执行一次）
@ -660,8 +641,7 @@ class MatcherGroup:
"""
注册一个消息事件响应器，并且当消息的**文本部分**以指定内容开头时响应。
:参数:
参数:
msg: 指定消息开头内容
ignorecase: 是否忽略大小写
rule: 事件响应规则
@ -687,8 +667,7 @@ class MatcherGroup:
"""
注册一个消息事件响应器，并且当消息的**文本部分**以指定内容结尾时响应。
:参数:
参数:
msg: 指定消息结尾内容
ignorecase: 是否忽略大小写
rule: 事件响应规则
@ -714,8 +693,7 @@ class MatcherGroup:
"""
注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。
:参数:
参数:
keywords: 关键词列表
rule: 事件响应规则
permission: 事件响应权限
@ -747,8 +725,7 @@ class MatcherGroup:
命令匹配规则参考: `命令形式匹配 <rule.md#command-command>`_
:参数:
参数:
cmd: 指定命令内容
aliases: 命令别名
rule: 事件响应规则
@ -784,8 +761,7 @@ class MatcherGroup:
并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]` 中
:参数:
参数:
cmd: 指定命令内容
aliases: 命令别名
parser: `nonebot.rule.ArgumentParser` 对象
@ -818,8 +794,7 @@ class MatcherGroup:
命令匹配规则参考: `正则匹配 <rule.md#regex-regex-flags-0>`_
:参数:
参数:
pattern: 正则表达式
flags: 正则匹配标志
rule: 事件响应规则

3
nonebot/plugin/plugin.py
View File

@ -56,8 +56,7 @@ def get_plugin(name: str) -> Optional[Plugin]:
"""
获取当前导入的某个插件。
:参数:
参数:
name: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
:返回: