mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-01-19 09:38:21 +08:00
📝 update api docs
This commit is contained in:
parent
f8fb36a1f7
commit
c8ebaf38b6
@ -507,6 +507,63 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `on_shell_like_command(cmd, rule=None, aliases=None, shell_like_argsparser=None, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个支持 `shell_like` 解析参数的命令消息事件响应器。
|
||||||
|
|
||||||
|
与普通的 `on_command` 不同的是,在添加 `shell_like_argsparser` 参数时, 响应器会自动处理消息,
|
||||||
|
|
||||||
|
并将 `shell_like_argsparser` 处理的参数保存在 `state["args"]` 中
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
||||||
|
|
||||||
|
|
||||||
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
|
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
||||||
|
|
||||||
|
|
||||||
|
* `shell_like_argsparser:Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象,是一个类 `shell` 的 `argsparser`
|
||||||
|
|
||||||
|
|
||||||
|
* `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)`
|
## `on_regex(pattern, flags=0, rule=None, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
|
@ -170,6 +170,44 @@ Rule(async_function, run_sync(sync_function))
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
||||||
|
## `shell_like_command(shell_like_argsparser=None, *cmds)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
支持 `shell_like` 解析参数的命令形式匹配,根据配置里提供的 `command_start`, `command_sep` 判断消息是否为命令。
|
||||||
|
|
||||||
|
可以通过 `state["_prefix"]["command"]` 获取匹配成功的命令(例:`("test",)`),通过 `state["_prefix"]["raw_command"]` 获取匹配成功的原始命令文本(例:`"/test"`)。
|
||||||
|
|
||||||
|
添加 `shell_like_argpsarser` 参数后, 可以自动处理消息并将结果保存在 `state["args"]` 中。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `shell_like_argsparser: Optional[ArgumentParser]`: `argparse.ArgumentParser` 对象, 是一个类 `shell` 的 `argsparser`
|
||||||
|
|
||||||
|
|
||||||
|
* `*cmds: Union[str, Tuple[str, ...]]`: 命令内容
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **示例**
|
||||||
|
|
||||||
|
使用默认 `command_start`, `command_sep` 配置
|
||||||
|
|
||||||
|
命令 `("test",)` 可以匹配:`/test` 开头的消息
|
||||||
|
命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息
|
||||||
|
|
||||||
|
当 `shell_like_argsparser` 的 `argument` 为 `-a` 时且 `action` 为 `store_true` , `state["args"]["a"]` 将会记录 `True`
|
||||||
|
|
||||||
|
|
||||||
|
:::tip 提示
|
||||||
|
命令内容与后续消息间无需空格!
|
||||||
|
:::
|
||||||
|
|
||||||
|
|
||||||
## `regex(regex, flags=0)`
|
## `regex(regex, flags=0)`
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user