📝 update api docs

This commit is contained in:
AkiraXie
2021-02-02 04:06:57 +00:00
parent c9a8e7ff0d
commit 88bbb57c66
3 changed files with 123 additions and 13 deletions

View File

@ -507,16 +507,16 @@ def something_else():
## `on_shell_like_command(cmd, rule=None, aliases=None, shell_like_argsparser=None, **kwargs)`
## `on_shell_command(cmd, rule=None, aliases=None, parser=None, **kwargs)`
* **说明**
注册一个支持 `shell_like` 解析参数的命令消息事件响应器。
与普通的 `on_command` 不同的是,在添加 `shell_like_argsparser` 参数时, 响应器会自动处理消息,
与普通的 `on_command` 不同的是,在添加 `parser` 参数时, 响应器会自动处理消息
并将 `shell_like_argsparser` 处理的参数保存在 `state["args"]`
并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]`
@ -532,7 +532,7 @@ def something_else():
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
* `shell_like_argsparser:Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象,是一个类 `shell``argsparser`
* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象
* `permission: Optional[Permission]`: 事件响应权限
@ -680,6 +680,32 @@ def something_else():
### `shell_command(cmd, **kwargs)`
* **说明**
注册一个新的命令。
* **参数**
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
* `**kwargs`: 其他传递给 `on_command` 的参数,将会覆盖命令组默认值
* **返回**
* `Type[Matcher]`
## _class_ `MatcherGroup`
基类:`object`
@ -1127,6 +1153,63 @@ def something_else():
### `on_shell_command(cmd, rule=None, aliases=None, parser=None, **kwargs)`
* **说明**
注册一个支持 `shell_like` 解析参数的命令消息事件响应器。
与普通的 `on_command` 不同的是,在添加 `parser` 参数时, 响应器会自动处理消息。
并将用户输入的原始参数列表保存在 `state["argv"]`, `parser` 处理的参数保存在 `state["args"]`
* **参数**
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象
* `permission: Optional[Permission]`: 事件响应权限
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
* `temp: bool`: 是否为临时事件响应器(仅执行一次)
* `priority: int`: 事件响应器优先级
* `block: bool`: 是否阻止事件向更低优先级传递
* `state: Optional[T_State]`: 默认 state
* `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数
* **返回**
* `Type[Matcher]`
### `on_regex(pattern, flags=0, rule=None, **kwargs)`