📝 Fix copywriting

This commit is contained in:
jigsaw
2022-02-05 19:46:33 +08:00
parent b8456b12ad
commit b9fd4b1ac8
27 changed files with 321 additions and 332 deletions

View File

@ -10,7 +10,7 @@ options:
# 简介
受 [`FastApi`](https://fastapi.tiangolo.com/tutorial/dependencies/) 启发NoneBot 同样编写了一个简易的依赖注入模块,使得开发者可以通过事件处理函数参数的类型标注来自动注入依赖。
受 [FastAPI](https://fastapi.tiangolo.com/tutorial/dependencies/) 启发NoneBot 同样编写了一个简易的依赖注入模块,使得开发者可以通过事件处理函数参数的类型标注来自动注入依赖。
## 什么是依赖注入?
@ -40,7 +40,7 @@ async def _(x: dict = Depends(depend)):
print(x)
```
它和普通的事件处理函数并无区别,同样可以接 `bot`, `event` 等参数,你可以把它当作一个普通的事件处理函数但是去除了装饰器(没有使用 `matcher.handle()` 等来进行装饰),并且可以返回任何类型的值。
它和普通的事件处理函数并无区别,同样可以接 `bot`, `event` 等参数,你可以把它当作一个普通的事件处理函数但是去除了装饰器(没有使用 `matcher.handle()` 等来装饰),并且可以返回任何类型的值。
在这个例子中,依赖函数接受一个参数:
@ -48,7 +48,7 @@ async def _(x: dict = Depends(depend)):
并且返回了一个 `state` 的复制以及一个附加的键值 `depend` 。
### Import `Depends`
### 导入 `Depends`
```python {2}
from nonebot.log import logger

View File

@ -10,19 +10,17 @@ options:
# 事件处理函数重载
当我们在编写 `nonebot2` 应用时,常常会遇到这样一个问题:该怎么让同一类型的不同事件执行不同的响应逻辑?又或者如何让不同的 `bot` 针对同一类型的事件作出不同响应?
当我们在编写 NoneBot2 应用时,常常会遇到这样一个问题:该怎么让同一类型的不同事件执行不同的响应逻辑?又或者如何让不同的 `bot` 针对同一类型的事件作出不同响应?
针对这个问题, `nonebot2` 提供一个便捷而高效的解决方案:事件处理函数重载机制。简单地说,`handler` (事件处理函数) 会根据其参数的 `type hints` ([PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/)) 来对相对应的 `bot``Event` 进行响应,并且会忽略不符合其参数类型标注的情况。
针对这个问题, NoneBot2 提供一个便捷而高效的解决方案:事件处理函数重载机制。简单地说,`handler`事件处理函数会根据其参数的 `type hints`[PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/)来对相对应的 `bot``event` 进行响应,并且会忽略不符合其参数类型标注的情况。
<!-- 必须要注意的是,该机制利用了 `inspect` 标准库获取到了事件处理函数的 `singnature` (签名) ,进一步获取到参数名称和类型标注。故而,我们在编写 `handler` 时,参数的名称和类型标注必须要符合 `T_Handler` 规定,详情可以参看 **指南** 中的[事件处理](../../guide/creating-a-handler)。 -->
<!-- 必须要注意的是,该机制利用了 `inspect` 标准库获取到了事件处理函数的 `signature`(签名),进一步获取到参数名称和类型标注。故而,我们在编写 `handler` 时,参数的名称和类型标注必须要符合 `T_Handler` 规定,详情可以参看**指南**中的[事件处理](../../guide/creating-a-handler)。 -->
:::tip 提示
如果想了解更多关于 `inspect` 标准库的信息,可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。
:::
下面,我们会以 `onebot` 中的 `群聊消息事件``私聊消息事件` 为例,对该机制的应用进行简单的介绍。
下面,我们会以 OneBot 适配器中的群聊消息事件和私聊消息事件为例,对该机制的应用进行简单的介绍。
## 一个例子
@ -33,13 +31,13 @@ from nonebot import on_command
from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent, PrivateMessageEvent
```
之后,我们可以注册一个 `Matcher` 来响应 `消息事件`
之后,我们可以注册一个 `Matcher` 来响应消息事件。
```python
matcher = on_command("testoverload")
matcher = on_command("test_overload")
```
最后, 我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载:
最后我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载:
```python
@matcher.handle()
@ -52,7 +50,7 @@ async def _(bot: Bot, event: PrivateMessageEvent):
await matcher.send("私聊消息事件响应成功!")
```
此时,我们可以在群聊或私聊中对我们的机器人发送 `testoverload` ,它会在不同的场景做出不同的应答。
此时,我们可以在群聊或私聊中对我们的机器人发送 `test_overload`,它会在不同的场景做出不同的应答。
这样一个简单的事件处理函数重载就完成了。