mirror of
https://github.com/nonebot/nonebot2.git
synced 2026-07-25 17:52:39 +00:00
📝 migrate admonition title syntax to Docusaurus v3 bracket form
This commit is contained in:
@@ -29,11 +29,11 @@ import TabItem from "@theme/TabItem";
|
||||
- 根据已经解析的 `Dependency` 依赖,执行调用。
|
||||
- 将所有 `Dependency` 的返回值根据参数名传入并调用 `Dependent` 。
|
||||
|
||||
:::danger 警告
|
||||
:::danger[警告]
|
||||
在依赖注入中,类型注解是非常重要的,因为它不仅可以决定依赖注入的对象,还可以触发[重载机制](../appendices/overload.md#重载)。如果类型注解与实际获得数据类型不一致,将会跳过当前 `Dependent` 对象(即事件处理函数)。
|
||||
:::
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
如果对于依赖注入的解析流程有疑问,可以调整[日志等级配置项](../appendices/config.mdx#log-level)为 `TRACE`,查看依赖解析日志。
|
||||
:::
|
||||
|
||||
@@ -349,7 +349,7 @@ async def _(x: int = Depends(random_result, use_cache=False)):
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
缓存的生命周期与当前接收到的事件相同。接收到事件后,子依赖在首次执行时缓存,在该事件处理完成后,缓存就会被清除。
|
||||
:::
|
||||
|
||||
@@ -558,7 +558,7 @@ async def _(x: httpx.AsyncClient = Depends(get_client)):
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::warning 注意
|
||||
:::warning[注意]
|
||||
生成器作为依赖时,其中只能进行一次 `yield`,否则将会触发异常。如果对此有疑问并想探究原因,可以参考 [contextmanager](https://docs.python.org/zh-cn/3/library/contextlib.html#contextlib.contextmanager) 和 [asynccontextmanager](https://docs.python.org/zh-cn/3/library/contextlib.html#contextlib.asynccontextmanager) 文档。事实上,NoneBot 内部就使用了这两个装饰器。
|
||||
:::
|
||||
|
||||
@@ -715,7 +715,7 @@ async def _(foo: tuple[str, ...] = Command()): ...
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
命令详情只能在**触发命令型事件响应器时**获取。如果在事件处理后续流程中获取,则会获取到不同的值。
|
||||
:::
|
||||
|
||||
@@ -745,7 +745,7 @@ async def _(foo: str = RawCommand()): ...
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
命令详情只能在**触发命令型事件响应器时**获取。如果在事件处理后续流程中获取,则会获取到不同的值。
|
||||
:::
|
||||
|
||||
@@ -777,7 +777,7 @@ async def _(foo: Message = CommandArg()): ...
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
命令详情只能在**触发命令型事件响应器时**获取。如果在事件处理后续流程中获取,则会获取到不同的值。
|
||||
:::
|
||||
|
||||
@@ -807,7 +807,7 @@ async def _(foo: str = CommandStart()): ...
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
命令详情只能在**触发命令型事件响应器时**获取。如果在事件处理后续流程中获取,则会获取到不同的值。
|
||||
:::
|
||||
|
||||
@@ -837,7 +837,7 @@ async def _(foo: str = CommandWhitespace()): ...
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
命令详情只能在**触发命令型事件响应器时**获取。如果在事件处理后续流程中获取,则会获取到不同的值。
|
||||
:::
|
||||
|
||||
@@ -921,7 +921,7 @@ async def _(foo: list[Union[str, MessageSegment]] = ShellCommandArgv()): ...
|
||||
|
||||
获取 shell 命令解析后的参数 Namespace,支持 MessageSegment 富文本(如:图片)。
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
如果参数解析成功,则为 parser 返回的 Namespace;如果参数解析失败,则为 [`ParserExit`](../api/exception.md#ParserExit) 异常,并携带错误码与错误信息。在前置词法解析失败时,返回值也为 [`ParserExit`](../api/exception.md#ParserExit) 异常。通过重载机制即可处理两种不同的情况。
|
||||
|
||||
由于 `ArgumentParser` 在解析到 `--help` 参数时也会抛出异常,这种情况下错误码为 `0` 且错误信息即为帮助信息。
|
||||
|
||||
@@ -12,11 +12,11 @@ options:
|
||||
|
||||
驱动器 (Driver) 是机器人运行的基石,它是机器人初始化的第一步,主要负责数据收发。
|
||||
|
||||
:::info 提示
|
||||
:::info[提示]
|
||||
驱动器的选择通常与机器人所使用的协议适配器相关,如果不知道该选择哪个驱动器,可以先阅读相关协议适配器文档说明。
|
||||
:::
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
如何**安装**驱动器请参考[安装驱动器](../tutorial/store.mdx#安装驱动器)。
|
||||
:::
|
||||
|
||||
@@ -118,7 +118,7 @@ DRIVER=~fastapi
|
||||
|
||||
##### `fastapi_reload`
|
||||
|
||||
:::warning 警告
|
||||
:::warning[警告]
|
||||
不推荐开启该配置项,在 Windows 平台上开启该功能有可能会造成预料之外的影响!替代方案:使用 `nb-cli` 命令行工具以及参数 `--reload` 启动 NoneBot。
|
||||
|
||||
```bash
|
||||
@@ -200,7 +200,7 @@ DRIVER=~quart
|
||||
|
||||
##### `quart_reload`
|
||||
|
||||
:::warning 警告
|
||||
:::warning[警告]
|
||||
不推荐开启该配置项,在 Windows 平台上开启该功能有可能会造成预料之外的影响!替代方案:使用 `nb-cli` 命令行工具以及参数 `--reload` 启动 NoneBot。
|
||||
|
||||
```bash
|
||||
@@ -252,7 +252,7 @@ nonebot.run(app="bot:app")
|
||||
|
||||
**类型:**HTTP 客户端驱动器
|
||||
|
||||
:::warning 注意
|
||||
:::warning[注意]
|
||||
本驱动器仅支持 HTTP 请求,不支持 WebSocket 连接请求。
|
||||
:::
|
||||
|
||||
@@ -266,7 +266,7 @@ DRIVER=~httpx
|
||||
|
||||
**类型:**WebSocket 客户端驱动器
|
||||
|
||||
:::warning 注意
|
||||
:::warning[注意]
|
||||
本驱动器仅支持 WebSocket 连接请求,不支持 HTTP 请求。
|
||||
:::
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ options:
|
||||
|
||||
在[指南](../tutorial/matcher.md)与[深入](../appendices/rule.md)中,我们已经介绍了事件响应器的基本用法以及响应规则、权限控制等功能。在这一节中,我们将介绍事件响应器的组成,内置的响应规则,与第三方响应规则拓展。
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
事件响应器允许继承,你可以通过直接继承 `Matcher` 类来创建一个新的事件响应器。
|
||||
:::
|
||||
|
||||
@@ -228,7 +228,7 @@ matcher = on_shell_command("cmd", parser=parser)
|
||||
|
||||
`regex` 响应规则用于匹配消息是否与指定正则表达式匹配。
|
||||
|
||||
:::tip 提示
|
||||
:::tip[提示]
|
||||
正则表达式匹配使用 search 而非 match,如需从头匹配请使用 `r"^xxx"` 模式来确保匹配开头。
|
||||
:::
|
||||
|
||||
|
||||
Reference in New Issue
Block a user