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

✨ add rich text support for shell command (#1171)

Browse Source
This commit is contained in:
Ju4tCode
2022-08-24 09:54:08 +08:00
committed by GitHub
parent 00af815b8a
commit 3f8af04803
4 changed files with 194 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
website/docs/tutorial/plugin/create-handler.md
View File

@ -277,7 +277,7 @@ async def _(foo: str = CommandStart()): ...
### ShellCommandArgs
获取 shell 命令解析后的参数。
获取 shell 命令解析后的参数，支持 MessageSegment 富文本（如：图片）。
:::tip 提示
如果参数解析失败，则为 [`ParserExit`](../../api/exception.md#ParserExit) 异常，并携带错误码与错误信息。
@ -288,21 +288,28 @@ async def _(foo: str = CommandStart()): ...
```python {8,12}
from nonebot import on_shell_command
from nonebot.params import ShellCommandArgs
from nonebot.rule import Namespace, ArgumentParser
parser = ArgumentParser("demo")
# parser.add_argument ...
matcher = on_shell_command("cmd", parser)
# 解析失败
@matcher.handle()
async def _(foo: ParserExit = ShellCommandArgs()): ...
async def _(foo: ParserExit = ShellCommandArgs()):
if foo.status == 0:
foo.message # help message
else:
foo.message # error message
# 解析成功
@matcher.handle()
async def _(foo: Dict[str, Any] = ShellCommandArgs()): ...
async def _(foo: Namespace = ShellCommandArgs()): ...
```
### ShellCommandArgv
获取 shell 命令解析前的参数列表。
获取 shell 命令解析前的参数列表，支持 MessageSegment 富文本（如：图片）。
```python {7}
from nonebot import on_shell_command
@ -311,7 +318,7 @@ from nonebot.params import ShellCommandArgs
matcher = on_shell_command("cmd")
@matcher.handle()
async def _(foo: List[str] = ShellCommandArgv()): ...
async def _(foo: List[Union[str, MessageSegment]] = ShellCommandArgv()): ...
```
### RegexMatched