mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-09-13 07:26:47 +00:00
📝 Docs: 重写教程与进阶指南 (#1604)
Co-authored-by: Johnny Hsieh <32300164+mnixry@users.noreply.github.com>
This commit is contained in:
Ju4tCode
GitHub
@ -1,207 +0,0 @@
|
||||
---
|
||||
id: index
|
||||
sidebar_position: 0
|
||||
description: 深入了解 NoneBot2 运行机制
|
||||
slug: /advanced/
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 10
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 深入
|
||||
|
||||
:::danger 警告
|
||||
进阶部分尚未更新完成
|
||||
:::
|
||||
|
||||
## 它如何工作？
|
||||
|
||||
如同[概览](../README.md)所言：
|
||||
|
||||
> NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。
|
||||
|
||||
NoneBot2 是一个可以对机器人上报的事件进行处理并完成具体功能的机器人框架，在这里，我们将简要讲述它的工作内容。
|
||||
|
||||
**便捷起见，以下内容对 NoneBot2 会被称为 NoneBot，与 NoneBot2 交互的机器人实现会被称为协议端**。
|
||||
|
||||
在实际应用中，NoneBot 会充当一个高性能，轻量级的 Python 微服务框架。协议端可以通过 http、websocket 等方式与之通信，这个通信往往是双向的：一方面，协议端可以上报数据给 NoneBot，NoneBot 会处理数据并返回响应给协议端；另一方面，NoneBot 可以主动推送数据给协议端。而 NoneBot 便是围绕双向通信进行工作的。
|
||||
|
||||
在开始工作之前，NoneBot 需要进行准备工作：
|
||||
|
||||
1. **运行 `nonebot.init` 初始化函数**，它会读取配置文件，并初始化 NoneBot 和后端驱动 `Driver` 对象。
|
||||
2. **注册协议适配器 `Adapter`**。
|
||||
3. **加载插件**。
|
||||
|
||||
准备工作完成后，NoneBot 会利用 uvicorn 启动，并运行 `on_startup` 钩子函数。
|
||||
|
||||
随后，倘若一个协议端与 NoneBot 进行了连接，NoneBot 的后端驱动 `Driver` 就会将数据交给 `Adapter`，然后会实例化 `Bot`，NoneBot 便会利用 `Bot` 开始工作，它的工作内容分为两个方面：
|
||||
|
||||
1. **事件处理**，`Bot` 会将协议端上报的数据转化为 `Event`（事件），之后 NoneBot 会根据一套既定流程来处理事件。
|
||||
|
||||
2. **调用 `API`**，在**事件处理**的过程中，NoneBot 可以通过 `Bot` 调用协议端指定的 `API` 来获取更多数据，或者反馈响应给协议端；NoneBot 也可以通过调用 `API` 向协议端主动请求数据或者主动推送数据。
|
||||
|
||||
在**指南**模块，我们已经叙述了[如何配置 NoneBot](../tutorial/configuration.md)、[如何注册协议适配器](../tutorial/register-adapter.md)以及[如何加载插件](../tutorial/plugin/load-plugin.md)，这里便不再赘述。
|
||||
|
||||
下面，我们将对**事件处理**，**调用 API** 进行说明。
|
||||
|
||||
## 事件处理
|
||||
|
||||
我们可以先看事件处理的流程图：
|
||||
|
||||
|
||||
|
||||
在流程图里，我们可以看到，NoneBot 会有三个阶段来处理事件：
|
||||
|
||||
1. **Driver 接收上报数据**
|
||||
2. **Adapter 处理原始数据**
|
||||
3. **NoneBot 处理 Event**
|
||||
|
||||
我们将顺序说明这三个阶段。其中，会将第三个阶段拆分成**概念解释**，**处理 Event**，**特殊异常处理**三个部分来说明。
|
||||
|
||||
### Driver 接收上报数据
|
||||
|
||||
1. 协议端会通过 websocket 或 http 等方式与 NoneBot 的后端驱动 `Driver` 连接，协议端上报数据后，`Driver` 会将原始数据交给 `Adapter` 处理。
|
||||
|
||||
:::warning
|
||||
连接之前必须要注册 `Adapter`
|
||||
:::
|
||||
|
||||
### Adapter 处理原始数据
|
||||
|
||||
1. `Adapter` 检查授权许可，并获取 `self-id` 作为唯一识别 id 。
|
||||
|
||||
:::tip
|
||||
如果协议端通过 websocket 上报数据，这个步骤只会在建立连接时进行，并在之后运行 `on_bot_connect` 钩子函数；通过 http 方式连接时，会在协议端每次上报数据时都进行这个步骤。
|
||||
:::
|
||||
|
||||
:::warning
|
||||
`self-id` 是帐号的唯一识别 ID ，这意味着不能出现相同的 `self-id`。
|
||||
:::
|
||||
|
||||
2. 根据 `self-id` 实例化 `Adapter` 相应的 `Bot` 。
|
||||
|
||||
3. 根据 `Event Model` 将原始数据转化为 NoneBot 可以处理的 `Event` 对象。
|
||||
|
||||
:::tip
|
||||
`Adapter` 在转换数据格式的同时可以进行一系列的特殊操作，例如 OneBot 适配器会对 reply 信息进行提取。
|
||||
:::
|
||||
|
||||
4. `Bot` 和 `Event` 交由 NoneBot 进一步处理。
|
||||
|
||||
### NoneBot 处理 Event
|
||||
|
||||
在讲述这个阶段之前，我们需要先对几个概念进行解释。
|
||||
|
||||
#### 概念解释
|
||||
|
||||
1. **hook** ，或者说**钩子函数**，它们可以在 NoneBot 处理 `Event` 的不同时刻进行拦截，修改或者扩展，在 NoneBot 中，事件钩子函数分为`事件预处理 hook`、`运行预处理 hook`、`运行后处理 hook` 和`事件后处理 hook`。
|
||||
|
||||
:::tip
|
||||
关于 `hook` 的更多信息，可以查阅[这里](./runtime-hook.md)。
|
||||
:::
|
||||
|
||||
2. **Matcher** 与 **matcher**，在**指南**中，我们讲述了[如何注册事件响应器](../tutorial/plugin/create-matcher.md)，这里的事件响应器或者说 `Matcher` 并不是一个具体的实例 `instance`，而是一个具有特定属性的类 `class`。只有当 `Matcher` **响应事件**时，才会实例化为具体的 `instance`，也就是 `matcher` 。`matcher` 可以认为是 NoneBot 处理 `Event` 的基本单位，运行 `matcher` 是 NoneBot 工作的主要内容。
|
||||
|
||||
3. **handler**，或者说**事件处理函数**，它们可以认为是 NoneBot 处理 `Event` 的最小单位。在不考虑 `hook` 的情况下，**运行 matcher 就是顺序运行 matcher.handlers**，这句话换种表达方式就是，`handler` 只有添加到 `matcher.handlers` 时，才可以参与到 NoneBot 的工作中来。
|
||||
|
||||
:::tip
|
||||
如何让 `handler` 添加到 `matcher.handlers`？
|
||||
|
||||
一方面，我们可以参照[这里](../tutorial/plugin/create-handler.md)利用装饰器来添加；另一方面，我们在用 `on()` 或者 `on_*()` 注册事件响应器时，可以添加 `handlers=[handler1, handler2, ...]` 这样的关键词参数来添加。
|
||||
:::
|
||||
|
||||
#### 处理 Event
|
||||
|
||||
1. **执行事件预处理 hook**， NoneBot 接收到 `Event` 后，会传入到 `事件预处理 hook` 中进行处理。
|
||||
|
||||
:::warning
|
||||
需要注意的是，执行多个 `事件预处理 hook` 时并无顺序可言，它们是**并发运行**的。这个原则同样适用于其他的 `hook`。
|
||||
:::
|
||||
|
||||
2. **按优先级升序选出同一优先级的 Matcher**，NoneBot 提供了一个全局字典 `matchers`，这个字典的 `key` 是优先级 `priority`，`value` 是一个 `list`，里面存放着同一优先级的 `Matcher`。在注册 `Matcher` 时，它和优先级 `priority` 会添加到里面。
|
||||
|
||||
在执行 `事件预处理 hook` 后，NoneBot 会对 `matchers` 的 `key` 升序排序并选择出当前最小优先级的 `Matcher`。
|
||||
|
||||
3. **根据 Matcher 定义的 Rule、Permission 判断是否运行**，在选出 `Matcher` 后，NoneBot 会将 `bot`，`Event` 传入到 `Matcher.check_rule` 和 `Matcher.check_perm` 两个函数中，两个函数分别对 Matcher 定义的 `Rule`、`Permission` 进行 check，当 check 通过后，这个 `Matcher` 就会响应事件。当同一个优先级的所有 `Matcher` 均没有响应时，NoneBot 会返回到上一个步骤，选择出下一优先级的 `Matcher`。
|
||||
|
||||
4. **实例化 matcher 并执行运行预处理 hook**，当 `Matcher` 响应事件后，它便会实例化为 `matcher`，并执行 `运行预处理 hook`。
|
||||
|
||||
5. **顺序运行 matcher 的所有 handlers**，`运行预处理 hook` 执行完毕后，便会运行 `matcher`，也就是**顺序运行**它的 `handlers`。
|
||||
|
||||
:::tip
|
||||
`matcher` 运行 `handlers` 的顺序是：先运行该 `matcher` 的类 `Matcher` 注册时添加的 `handlers`(如果有的话)，再按照装饰器装饰顺序运行装饰的 `handlers`。
|
||||
:::
|
||||
|
||||
6. **执行运行后处理 hook**，`matcher` 的 `handlers` 运行完毕后，会执行 `运行后处理 hook`。
|
||||
|
||||
7. **判断是否停止事件传播**，NoneBot 会根据当前优先级所有 `matcher` 的 `block` 参数或者 `StopPropagation` 异常判断是否停止传播 `Event`，如果事件没有停止传播，NoneBot 便会返回到第 2 步， 选择出下一优先级的 `Matcher`。
|
||||
|
||||
8. **执行事件后处理 hook**，在 `Event` 停止传播或执行完所有响应的 `Matcher` 后，NoneBot 会执行 `事件后处理 hook`。
|
||||
|
||||
当 `事件后处理 hook` 执行完毕后，当前 `Event` 的处理周期就顺利结束了。
|
||||
|
||||
#### 特殊异常处理
|
||||
|
||||
在这个阶段，NoneBot 规定了几个特殊的异常，当 NoneBot 捕获到它们时，会用特定的行为来处理它们。
|
||||
|
||||
1. **IgnoredException**
|
||||
|
||||
这个异常可以在 `事件预处理 hook` 和 `运行预处理 hook` 抛出。
|
||||
|
||||
当 `事件预处理 hook` 抛出它时，NoneBot 会忽略当前的 `Event`，不进行处理。
|
||||
|
||||
当 `运行预处理 hook` 抛出它时，NoneBot 会忽略当前的 `matcher`，结束当前 `matcher` 的运行。
|
||||
|
||||
:::warning
|
||||
当 `hook` 需要抛出这个异常时，要写明原因。
|
||||
:::
|
||||
|
||||
2. **PausedException**
|
||||
|
||||
这个异常可以在 `handler` 中由 `Matcher.pause` 抛出。
|
||||
|
||||
当 NoneBot 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行，并将后续的 `handler` 交给一个临时 `Matcher` 来响应当前交互用户的下一个消息事件，当临时 `Matcher` 响应时，临时 `Matcher` 会运行后续的 `handler`。
|
||||
|
||||
3. **RejectedException**
|
||||
|
||||
这个异常可以在 `handler` 中由 `Matcher.reject` 抛出。
|
||||
|
||||
当 NoneBot 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行，并将当前 handler 和后续 `handler` 交给一个临时 `Matcher` 来响应当前交互用户的下一个消息事件，当临时 `Matcher` 响应时，临时 `Matcher` 会运行当前 `handler` 和后续的 `handler` 。
|
||||
|
||||
4. **FinishedException**
|
||||
|
||||
这个异常可以在 `handler` 中由 `Matcher.finish` 抛出。
|
||||
|
||||
当 NoneBot 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行。
|
||||
|
||||
5. **StopPropagation**
|
||||
|
||||
这个异常一般会在执行 `运行后处理 hook` 后抛出。
|
||||
|
||||
当 NoneBot 捕获到它时， 会停止传播当前 `Event` ，不再寻找下一优先级的 `Matcher` ，直接执行 `事件后处理 hook` 。
|
||||
|
||||
## 调用 API
|
||||
|
||||
NoneBot 可以通过 `bot` 来调用 `API`，`API` 可以向协议端发送数据，也可以向协议端请求更多的数据。
|
||||
|
||||
NoneBot 调用 `API` 会有如下过程：
|
||||
|
||||
1. 调用 `calling_api_hook` 预处理钩子。
|
||||
|
||||
2. `adapter` 将信息处理为原始数据，并转交 `driver`，`driver` 交给协议端处理。
|
||||
|
||||
3. `driver` 接收协议端的结果，交给`adapter` 处理之后将结果反馈给 NoneBot 。
|
||||
|
||||
4. 调用 `called_api_hook` 后处理钩子。
|
||||
|
||||
在调用 `API` 时同样规定了特殊的异常，叫做 `MockApiException` 。该异常会由预处理钩子和后处理钩子触发，当预处理钩子触发时，NoneBot 会跳过之后的调用过程，直接执行后处理钩子。
|
||||
|
||||
:::tip
|
||||
不同 `adapter` 规定了不同的 API，对应的 API 列表请参照协议规范。
|
||||
:::
|
||||
|
||||
一般来说，我们可以用 `bot.*` 来调用 `API`（\*是 `API` 的 `action` 或者 `endpoint`）。
|
||||
|
||||
对于发送消息而言，一方面可以调用既有的 `API` ；另一方面 NoneBot 实现了两个便捷方法，`bot.send(event, message, **kwargs)` 方法和可以在 `handler` 中使用的 `Matcher.send(message, **kwargs)` 方法，来向事件主体发送消息。
|
||||
161
website/docs/advanced/adapter.md
Normal file
161
website/docs/advanced/adapter.md
Normal file
@ -0,0 +1,161 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 注册适配器与指定平台交互
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 20
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 使用适配器
|
||||
|
||||
适配器 (Adapter) 是机器人与平台交互的核心桥梁，它负责在驱动器和机器人插件之间转换与传递消息。
|
||||
|
||||
## 适配器功能与组成
|
||||
|
||||
适配器通常有两种功能，分别是**接收事件**和**调用平台接口**。其中，接收事件是指将驱动器收到的事件消息转换为 NoneBot 定义的事件模型，然后交由机器人插件处理；调用平台接口是指将机器人插件调用平台接口的数据转换为平台指定的格式，然后交由驱动器发送，并接收接口返回数据。
|
||||
|
||||
为了实现这两种功能，适配器通常由四个部分组成：
|
||||
|
||||
- **Adapter**：负责转换事件和调用接口，正确创建 Bot 对象并注册到 NoneBot 中。
|
||||
- **Bot**：负责存储平台机器人相关信息，并提供回复事件的方法。
|
||||
- **Event**：负责定义事件内容，以及事件主体对象。
|
||||
- **Message**：负责正确序列化消息，以便机器人插件处理。
|
||||
|
||||
## 注册适配器
|
||||
|
||||
在使用适配器之前，我们需要先将适配器注册到驱动器中，这样适配器就可以通过驱动器接收事件和调用接口了。我们以 Console 适配器为例，来看看如何注册适配器：
|
||||
|
||||
```python {2,5} title=bot.py
|
||||
import nonebot
|
||||
from nonebot.adapters.console import Adapter
|
||||
|
||||
driver = nonebot.get_driver()
|
||||
driver.register_adapter(Adapter)
|
||||
```
|
||||
|
||||
我们首先需要从适配器模块中导入所需要的适配器类，然后通过驱动器的 `register_adapter` 方法将适配器注册到驱动器中即可。
|
||||
|
||||
## 获取已注册的适配器
|
||||
|
||||
NoneBot 提供了 `get_adapter` 方法来获取已注册的适配器，我们可以通过适配器的名称或类型来获取指定的适配器实例：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
from nonebot.adapters.console import Adapter
|
||||
|
||||
adapters = nonebot.get_adapters()
|
||||
console_adapter = nonebot.get_adapter(Adapter)
|
||||
console_adapter = nonebot.get_adapter(Adapter.get_name())
|
||||
```
|
||||
|
||||
## 获取 Bot 对象
|
||||
|
||||
当前所有适配器已连接的 Bot 对象可以通过 `get_bots` 方法获取，这是一个以机器人 ID 为键的字典：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
bots = nonebot.get_bots()
|
||||
```
|
||||
|
||||
我们也可以通过 `get_bot` 方法获取指定 ID 的 Bot 对象。如果省略 ID 参数，将会返回所有 Bot 中的第一个：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
bot = nonebot.get_bot("bot_id")
|
||||
```
|
||||
|
||||
如果需要获取指定适配器连接的 Bot 对象，我们可以通过适配器的 `bots` 属性获取，这也是一个以机器人 ID 为键的字典：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
from nonebot.adapters.console import Adapter
|
||||
|
||||
console_adapter = nonebot.get_adapter(Adapter)
|
||||
bots = console_adapter.bots
|
||||
```
|
||||
|
||||
Bot 对象都具有一个 `self_id` 属性，它是机器人的唯一 ID，由适配器填写，通常为机器人的帐号 ID 或者 APP ID。
|
||||
|
||||
## 获取事件通用信息
|
||||
|
||||
适配器的所有事件模型均继承自 `Event` 基类，在[事件类型与重载](../appendices/overload.md)一节中，我们也提到了如何使用基类抽象方法来获取事件通用信息。基类能提供如下信息：
|
||||
|
||||
### 事件类型
|
||||
|
||||
事件类型通常为 `meta_event`、`message`、`notice`、`request`。
|
||||
|
||||
```python
|
||||
type: str = event.get_type()
|
||||
```
|
||||
|
||||
### 事件名称
|
||||
|
||||
事件名称由适配器定义，通常用于日志记录。
|
||||
|
||||
```python
|
||||
name: str = event.get_event_name()
|
||||
```
|
||||
|
||||
### 事件描述
|
||||
|
||||
事件描述由适配器定义，通常用于日志记录。
|
||||
|
||||
```python
|
||||
description: str = event.get_event_description()
|
||||
```
|
||||
|
||||
### 事件日志字符串
|
||||
|
||||
事件日志字符串由事件名称和事件描述组成，用于日志记录。
|
||||
|
||||
```python
|
||||
log: str = event.get_log_string()
|
||||
```
|
||||
|
||||
### 事件主体 ID
|
||||
|
||||
事件主体 ID 通常为机器人用户 ID。
|
||||
|
||||
```python
|
||||
user_id: str = event.get_user_id()
|
||||
```
|
||||
|
||||
### 事件会话 ID
|
||||
|
||||
事件会话 ID 通常为机器人用户 ID 与群聊/频道 ID 组合而成。
|
||||
|
||||
```python
|
||||
session_id: str = event.get_session_id()
|
||||
```
|
||||
|
||||
### 事件消息
|
||||
|
||||
如果事件包含消息，则可以通过该方法获取，否则会产生异常。
|
||||
|
||||
```python
|
||||
message: Message = event.get_message()
|
||||
```
|
||||
|
||||
### 事件纯文本消息
|
||||
|
||||
通常为事件消息的纯文本内容，如果事件不包含消息，则会产生异常。
|
||||
|
||||
```python
|
||||
text: str = event.get_plaintext()
|
||||
```
|
||||
|
||||
### 事件是否与机器人有关
|
||||
|
||||
由适配器实现的判断，通常将事件目标主体为机器人、消息中包含“@机器人”或以“机器人的昵称”开始视为与机器人有关。
|
||||
|
||||
```python
|
||||
is_tome: bool = event.is_tome()
|
||||
```
|
||||
|
||||
## 更多
|
||||
|
||||
官方支持的适配器和社区贡献的适配器均可在[商店](/store)中查看。如果你想要开发自己的适配器，可以参考[开发文档](../developer/adapter-writing.md)。欢迎通过商店发布你的适配器。
|
||||
1189
website/docs/advanced/dependency.mdx
Normal file
1189
website/docs/advanced/dependency.mdx
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "依赖注入",
|
||||
"position": 5
|
||||
}
|
||||
@ -1,243 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 依赖注入简介
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 60
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 简介
|
||||
|
||||
受 [FastAPI](https://fastapi.tiangolo.com/tutorial/dependencies/) 启发，NoneBot 同样编写了一个简易的依赖注入模块，使得开发者可以通过事件处理函数参数的类型标注来自动注入依赖。
|
||||
|
||||
## 什么是依赖注入？
|
||||
|
||||
[依赖注入](https://zh.wikipedia.org/wiki/%E4%BE%9D%E8%B5%96%E6%B3%A8%E5%85%A5)
|
||||
|
||||
> 在软件工程中，**依赖注入**（dependency injection）的意思为，给予调用方它所需要的事物。 “依赖”是指可被方法调用的事物。依赖注入形式下，调用方不再直接使用“依赖”，取而代之是“注入” 。“注入”是指将“依赖”传递给调用方的过程。在“注入”之后，调用方才会调用该“依赖。 传递依赖给调用方，而不是让让调用方直接获得依赖，这个是该设计的根本需求。
|
||||
|
||||
依赖注入往往起到了分离依赖和调用方的作用，这样一方面能让代码更为整洁可读，一方面可以提升代码的复用性。
|
||||
|
||||
## 使用依赖注入
|
||||
|
||||
以下通过一个简单的例子来说明依赖注入的使用方法：
|
||||
|
||||
```python {2,7-8,11}
|
||||
from nonebot import on_command
|
||||
from nonebot.params import Depends # 1.引用 Depends
|
||||
from nonebot.adapters.onebot.v11 import MessageEvent
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
async def depend(event: MessageEvent): # 2.编写依赖函数
|
||||
return {"uid": event.get_user_id(), "nickname": event.sender.nickname}
|
||||
|
||||
@test.handle()
|
||||
async def _(x: dict = Depends(depend)): # 3.在事件处理函数里声明依赖项
|
||||
print(x["uid"], x["nickname"])
|
||||
```
|
||||
|
||||
如注释所言，可以用三步来说明依赖注入的使用过程：
|
||||
|
||||
1. 引用 `Depends` 。
|
||||
|
||||
2. 编写依赖函数。依赖函数和普通的事件处理函数并无区别，同样可以接收 `bot`, `event`, `state` 等参数，你可以把它当作一个普通的事件处理函数，但是去除了装饰器（没有使用 `matcher.handle()` 等来装饰），并且可以返回任何类型的值。
|
||||
|
||||
在这里我们接受了 `event`，并以 `onebot` 的 `MessageEvent` 作为类型标注，返回一个新的字典，包括 `uid` 和 `nickname` 两个键值。
|
||||
|
||||
3. 在事件处理函数中声明依赖项。依赖项必须要 `Depends` 包裹依赖函数作为默认值。
|
||||
|
||||
:::tip
|
||||
请注意，参数 `x` 的类型标注将会影响到事件处理函数的运行，与类型标注不符的值将会导致事件处理函数被跳过。
|
||||
:::
|
||||
|
||||
:::tip
|
||||
事实上，bot、event、state 它们本身只是依赖注入的一个特例，它们无需声明这是依赖即可注入。
|
||||
:::
|
||||
|
||||
虽然声明依赖项的方式和其他参数如 `bot`, `event` 并无二样，但他的参数有一些限制，必须是**可调用对象**，函数自然是可调用对象，类和生成器也是，我们会在接下来的小节说明。
|
||||
|
||||
一般来说，当接收到事件时，`NoneBot2` 会进行以下处理：
|
||||
|
||||
1. 准备依赖函数所需要的参数。
|
||||
2. 调用依赖函数并获得返回值。
|
||||
3. 将返回值作为事件处理函数中的参数值传入。
|
||||
|
||||
## 依赖缓存
|
||||
|
||||
在使用 `Depends` 包裹依赖函数时，有一个参数 `use_cache` ，它默认为 `True` ，这个参数会决定 `Nonebot2` 在依赖注入的处理中是否使用缓存。
|
||||
|
||||
```python {11}
|
||||
import random
|
||||
from nonebot import on_command
|
||||
from nonebot.params import Depends
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
async def always_run():
|
||||
return random.randint(1, 100)
|
||||
|
||||
@test.handle()
|
||||
async def _(x: int = Depends(always_run, use_cache=False)):
|
||||
print(x)
|
||||
```
|
||||
|
||||
:::tip
|
||||
缓存是针对单次事件处理来说的，在事件处理中 `Depends` 第一次被调用时，结果存入缓存，在之后都会直接返回缓存中的值，在事件处理结束后缓存就会被清除。
|
||||
:::
|
||||
|
||||
当使用缓存时，依赖注入会这样处理：
|
||||
|
||||
1. 查询缓存，如果缓存中有相应的值，则直接返回。
|
||||
2. 准备依赖函数所需要的参数。
|
||||
3. 调用依赖函数并获得返回值。
|
||||
4. 将返回值存入缓存。
|
||||
5. 将返回值作为事件处理函数中的参数值传入。
|
||||
|
||||
## 同步支持
|
||||
|
||||
我们在编写依赖函数时，可以简单地用同步函数，`NoneBot2` 的内部流程会进行处理：
|
||||
|
||||
```python {2,8-9,12}
|
||||
from nonebot.log import logger
|
||||
from nonebot.params import Depends # 1.引用 Depends
|
||||
from nonebot import on_command, on_message
|
||||
from nonebot.adapters.onebot.v11 import MessageEvent
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
def depend(event: MessageEvent): # 2.编写同步依赖函数
|
||||
return {"uid": event.get_user_id(), "nickname": event.sender.nickname}
|
||||
|
||||
@test.handle()
|
||||
async def _(x: dict = Depends(depend)): # 3.在事件处理函数里声明依赖项
|
||||
print(x["uid"], x["nickname"])
|
||||
```
|
||||
|
||||
## Class 作为依赖
|
||||
|
||||
我们可以看下面的代码段：
|
||||
|
||||
```python
|
||||
class A:
|
||||
def __init__(self):
|
||||
pass
|
||||
a = A()
|
||||
```
|
||||
|
||||
在我们实例化类 `A` 的时候，其实我们就在**调用**它，类本身也是一个**可调用对象**，所以类可以被 `Depends` 包裹成为依赖项。
|
||||
|
||||
因此我们对第一节的代码段做一下改造：
|
||||
|
||||
```python {2,7-10,13}
|
||||
from nonebot import on_command
|
||||
from nonebot.params import Depends # 1.引用 Depends
|
||||
from nonebot.adapters.onebot.v11 import MessageEvent
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
class DependClass: # 2.编写依赖类
|
||||
def __init__(self, event: MessageEvent):
|
||||
self.uid = event.get_user_id()
|
||||
self.nickname = event.sender.nickname
|
||||
|
||||
@test.handle()
|
||||
async def _(x: DependClass = Depends(DependClass)): # 3.在事件处理函数里声明依赖项
|
||||
print(x.uid, x.nickname)
|
||||
```
|
||||
|
||||
依然可以用三步说明如何用类作为依赖项：
|
||||
|
||||
1. 引用 `Depends` 。
|
||||
2. 编写依赖类。类的 `__init__` 函数可以接收 `bot`, `event`, `state` 等参数，在这里我们接受了 `event`，并以 `onebot` 的 `MessageEvent` 作为类型标注。
|
||||
3. 在事件处理函数中声明依赖项。当用类作为依赖项时，它会是一个对应的实例，在这里 `x` 就是 `DependClass` 实例。
|
||||
|
||||
### 另一种依赖项声明方式
|
||||
|
||||
当使用类作为依赖项时，`Depends` 的参数可以为空，`NoneBot2` 会根据参数的类型标注进行推断并进行依赖注入。
|
||||
|
||||
```python
|
||||
@test.handle()
|
||||
async def _(x: DependClass = Depends()): # 在事件处理函数里声明依赖项
|
||||
print(x.uid, x.nickname)
|
||||
```
|
||||
|
||||
## 生成器作为依赖
|
||||
|
||||
:::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) 文档，实际上，`Nonebot2` 的内部就使用了这两个装饰器。
|
||||
:::
|
||||
|
||||
:::tips
|
||||
生成器是 `Python` 高级特性，如果你对此处文档感到疑惑那说明暂时你还用不上这个功能。
|
||||
:::
|
||||
|
||||
与 `FastAPI` 一样，`NoneBot2` 的依赖注入支持依赖项在事件处理结束后进行一些额外的工作，比如数据库 session 或者网络 IO 的关闭，互斥锁的解锁等等。
|
||||
|
||||
要实现上述功能，我们可以用生成器函数作为依赖项，我们用 `yield` 关键字取代 `return` 关键字，并在 `yield` 之后进行额外的工作。
|
||||
|
||||
我们可以看下述代码段, 使用 `httpx.AsyncClient` 异步网络 IO：
|
||||
|
||||
```python {3,7-10,13}
|
||||
import httpx
|
||||
from nonebot import on_command
|
||||
from nonebot.params import Depends # 1.引用 Depends
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
async def get_client(): # 2.编写异步生成器函数
|
||||
async with httpx.AsyncClient() as client:
|
||||
yield client
|
||||
print("调用结束")
|
||||
|
||||
@test.handle()
|
||||
async def _(x: httpx.AsyncClient = Depends(get_client)): # 3.在事件处理函数里声明依赖项
|
||||
resp = await x.get("https://v2.nonebot.dev")
|
||||
# do something
|
||||
```
|
||||
|
||||
我们用 `yield` 代码段作为生成器函数的“返回”，在事件处理函数里用返回出来的 `client` 做自己需要的工作。在 `NoneBot2` 结束事件处理时，会执行 `yield` 之后的代码。
|
||||
|
||||
## 创造可调用对象作为依赖
|
||||
|
||||
:::tips
|
||||
魔法方法 `__call__` 是 `Python` 高级特性，如果你对此处文档感到疑惑那说明暂时你还用不上这个功能。
|
||||
:::
|
||||
|
||||
在 `Python` 的里，类的 `__call__` 方法会让类的实例变成**可调用对象**，我们可以利用这个魔法方法做一个简单的尝试：
|
||||
|
||||
```python{3,9-14,16,19}
|
||||
from typing import Type
|
||||
from nonebot.log import logger
|
||||
from nonebot.params import Depends # 1.引用 Depends
|
||||
from nonebot import on_command
|
||||
from nonebot.adapters.onebot.v11 import MessageEvent, GroupMessageEvent
|
||||
|
||||
test = on_command("123")
|
||||
|
||||
class EventChecker: # 2.编写需要的类
|
||||
def __init__(self, EventClass: Type[MessageEvent]):
|
||||
self.event_class = EventClass
|
||||
|
||||
def __call__(self, event: MessageEvent) -> bool:
|
||||
return isinstance(event, self.event_class)
|
||||
|
||||
checker = EventChecker(GroupMessageEvent) # 3.将类实例化
|
||||
|
||||
@test.handle()
|
||||
async def _(x: bool = Depends(checker)): # 4.在事件处理函数里声明依赖项
|
||||
if x:
|
||||
print("这是群聊消息")
|
||||
else:
|
||||
print("这不是群聊消息")
|
||||
```
|
||||
|
||||
这是判断 `onebot` 的消息事件是不是群聊消息事件的一个例子，我们可以用四步来说明这个例子：
|
||||
|
||||
1. 引用 `Depends` 。
|
||||
2. 编写需要的类。类的 `__init__` 函数接收参数 `EventClass`，它将接收事件类本身。类的 `__call__` 函数将接受消息事件对象，并返回一个 `bool` 类型的判定结果。
|
||||
3. 将类实例化。我们传入群聊消息事件作为参数实例化 `checker` 。
|
||||
4. 在事件处理函数里声明依赖项。`NoneBot2` 将会调用 `checker` 的 `__call__` 方法，返回给参数 `x` 相应的判断结果。
|
||||
@ -1,76 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 重载事件处理函数
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 61
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 事件处理函数重载
|
||||
|
||||
当我们在编写 NoneBot2 应用时，常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `bot` 针对同一类型的事件作出不同响应？
|
||||
|
||||
针对这个问题， NoneBot2 提供一个便捷而高效的解决方案：事件处理函数重载机制。简单地说，`handler`（事件处理函数）会根据其参数的 `type hints`（[PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/)）来对相对应的 `bot` 和 `event` 进行响应，并且会忽略不符合其参数类型标注的情况。
|
||||
|
||||
<!-- 必须要注意的是，该机制利用了 `inspect` 标准库获取到了事件处理函数的 `signature`（签名），进一步获取到参数名称和类型标注。故而，我们在编写 `handler` 时，参数的名称和类型标注必须要符合 `T_Handler` 规定，详情可以参看**指南**中的[事件处理](../../guide/creating-a-handler)。 -->
|
||||
|
||||
:::tip 提示
|
||||
如果想了解更多关于 `inspect` 标准库的信息，可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。
|
||||
:::
|
||||
|
||||
下面，我们会以 OneBot 适配器中的群聊消息事件和私聊消息事件为例，对该机制的应用进行简单的介绍。
|
||||
|
||||
## 一个例子
|
||||
|
||||
首先，我们需要导入需要的方法、类型。
|
||||
|
||||
```python
|
||||
from nonebot import on_command
|
||||
from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent, PrivateMessageEvent
|
||||
```
|
||||
|
||||
之后，我们可以注册一个 `Matcher` 来响应消息事件。
|
||||
|
||||
```python
|
||||
matcher = on_command("test_overload")
|
||||
```
|
||||
|
||||
最后，我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载：
|
||||
|
||||
```python
|
||||
@matcher.handle()
|
||||
async def _(bot: Bot, event: GroupMessageEvent):
|
||||
await matcher.send("群聊消息事件响应成功！")
|
||||
|
||||
|
||||
@matcher.handle()
|
||||
async def _(bot: Bot, event: PrivateMessageEvent):
|
||||
await matcher.send("私聊消息事件响应成功！")
|
||||
```
|
||||
|
||||
此时，我们可以在群聊或私聊中对我们的机器人发送 `test_overload`，它会在不同的场景做出不同的应答。
|
||||
|
||||
这样一个简单的事件处理函数重载就完成了。
|
||||
|
||||
## 进阶
|
||||
|
||||
事件处理函数重载机制同样支持被 `matcher.got` 等装饰器装饰的函数。例如：
|
||||
|
||||
```python
|
||||
@matcher.got("key1", prompt="群事件提问")
|
||||
async def _(bot: Bot, event: GroupMessageEvent):
|
||||
await matcher.send("群聊消息事件响应成功！")
|
||||
|
||||
|
||||
@matcher.got("key2", prompt="私聊事件提问")
|
||||
async def _(bot: Bot, event: PrivateMessageEvent):
|
||||
await matcher.send("私聊消息事件响应成功！")
|
||||
```
|
||||
|
||||
只有触发事件符合的函数才会触发装饰器。
|
||||
|
||||
:::warning 注意
|
||||
bot 和 event 参数具有最高的检查优先级，因此，如果参数类型不符合，所有的依赖项 `Depends` 等都不会被执行。
|
||||
:::
|
||||
286
website/docs/advanced/driver.md
Normal file
286
website/docs/advanced/driver.md
Normal file
@ -0,0 +1,286 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
description: 选择合适的驱动器运行机器人
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 10
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 选择驱动器
|
||||
|
||||
驱动器 (Driver) 是机器人运行的基石，它是机器人初始化的第一步，主要负责数据收发。
|
||||
|
||||
:::important 提示
|
||||
驱动器的选择通常与机器人所使用的协议适配器相关，如果不知道该选择哪个驱动器，可以先阅读相关协议适配器文档说明。
|
||||
:::
|
||||
|
||||
:::tip 提示
|
||||
如何**安装**驱动器请参考[安装驱动器](../tutorial/store.mdx#安装驱动器)。
|
||||
:::
|
||||
|
||||
## 驱动器类型
|
||||
|
||||
驱动器的类型有两种：
|
||||
|
||||
- `ForwardDriver`：即客户端型驱动器，多用于使用 HTTP 轮询，连接 WebSocket 服务器等情形。
|
||||
- `ReverseDriver`：即服务端型驱动器，多用于使用 WebHook，接收 WebSocket 客户端连接等情形。
|
||||
|
||||
客户端型驱动器具有以下两种功能：
|
||||
|
||||
1. 异步发送 HTTP 请求，自定义 `HTTP Method`、`URL`、`Header`、`Body`、`Cookie`、`Proxy`、`Timeout` 等。
|
||||
2. 异步建立 WebSocket 连接上下文，自定义 `WebSocket URL`、`Header`、`Cookie`、`Proxy`、`Timeout` 等。
|
||||
|
||||
服务端型驱动器通常为 ASGI 应用框架，具有以下功能：
|
||||
|
||||
1. 协议适配器自定义 HTTP 上报地址以及对上报数据处理的回调函数。
|
||||
2. 协议适配器自定义 WebSocket 连接请求地址以及对 WebSocket 请求处理的回调函数。
|
||||
3. 用户可以向 ASGI 应用添加任何服务端相关功能，如：[添加自定义路由](./routing.md)。
|
||||
|
||||
## 配置驱动器
|
||||
|
||||
驱动器的配置方法已经在[配置](../appendices/config.mdx)章节中简单进行了介绍，这里将详细介绍驱动器配置的格式。
|
||||
|
||||
NoneBot 中的客户端和服务端型驱动器可以相互配合使用，但服务端型驱动器**仅能选择一个**。所有驱动器模块都会包含一个 `Driver` 子类，即驱动器类，他可以作为驱动器单独运行。同时，客户端驱动器模块中还会提供一个 `Mixin` 子类，用于在与其他驱动器配合使用时加载。因此，驱动器配置格式采用特殊语法：`<module>[:<Driver>][+<module>[:<Mixin>]]*`。
|
||||
|
||||
其中，`<module>` 代表**驱动器模块路径**；`<Driver>` 代表**驱动器类名**，默认为 `Driver`；`<Mixin>` 代表**驱动器混入类名**，默认为 `Mixin`。即，我们需要选择一个主要驱动器，然后在其基础上配合使用其他驱动器的功能。主要驱动器可以为客户端或服务端类型，但混入类驱动器只能为客户端类型。
|
||||
|
||||
特别的，为了简化内置驱动器模块路径，我们可以使用 `~` 符号作为内置驱动器模块路径的前缀，如 `~fastapi` 代表使用内置驱动器 `fastapi`。NoneBot 内置了多个驱动器适配，但需要安装额外依赖才能使用，具体请参考[安装驱动器](../tutorial/store.mdx#安装驱动器)。常见的驱动器配置如下：
|
||||
|
||||
```dotenv
|
||||
DRIVER=~fastapi
|
||||
DRIVER=~aiohttp
|
||||
DRIVER=~httpx+~websockets
|
||||
DRIVER=~fastapi+~httpx+~websockets
|
||||
```
|
||||
|
||||
## 获取驱动器
|
||||
|
||||
在 NoneBot 框架初始化完成后，我们就可以通过 `get_driver()` 方法获取全局驱动器实例：
|
||||
|
||||
```python
|
||||
from nonebot import get_driver
|
||||
|
||||
driver = get_driver()
|
||||
```
|
||||
|
||||
## 内置驱动器
|
||||
|
||||
### None
|
||||
|
||||
**类型：**服务端驱动器
|
||||
|
||||
NoneBot 内置的空驱动器，不提供任何收发数据功能，可以在不需要外部网络连接时使用。
|
||||
|
||||
```env
|
||||
DRIVER=~none
|
||||
```
|
||||
|
||||
### FastAPI（默认）
|
||||
|
||||
**类型：**服务端驱动器
|
||||
|
||||
> FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
|
||||
|
||||
[FastAPI](https://fastapi.tiangolo.com/) 是一个易上手、高性能的异步 Web 框架，具有极佳的编写体验。 FastAPI 可以通过类型注解、依赖注入等方式实现输入参数校验、自动生成 API 文档等功能，也可以挂载其他 ASGI、WSGI 应用。
|
||||
|
||||
```env
|
||||
DRIVER=~fastapi
|
||||
```
|
||||
|
||||
#### FastAPI 配置项
|
||||
|
||||
##### `fastapi_openapi_url`
|
||||
|
||||
类型：`str | None`
|
||||
默认值：`None`
|
||||
说明：`FastAPI` 提供的 `OpenAPI` JSON 定义地址，如果为 `None`，则不提供 `OpenAPI` JSON 定义。
|
||||
|
||||
##### `fastapi_docs_url`
|
||||
|
||||
类型：`str | None`
|
||||
默认值：`None`
|
||||
说明：`FastAPI` 提供的 `Swagger` 文档地址，如果为 `None`，则不提供 `Swagger` 文档。
|
||||
|
||||
##### `fastapi_redoc_url`
|
||||
|
||||
类型：`str | None`
|
||||
默认值：`None`
|
||||
说明：`FastAPI` 提供的 `ReDoc` 文档地址，如果为 `None`，则不提供 `ReDoc` 文档。
|
||||
|
||||
##### `fastapi_include_adapter_schema`
|
||||
|
||||
类型：`bool`
|
||||
默认值：`True`
|
||||
说明：`FastAPI` 提供的 `OpenAPI` JSON 定义中是否包含适配器路由的 `Schema`。
|
||||
|
||||
##### `fastapi_reload`
|
||||
|
||||
:::warning 警告
|
||||
不推荐开启该配置项，在 Windows 平台上开启该功能有可能会造成预料之外的影响！替代方案：使用 `nb-cli` 命令行工具以及参数 `--reload` 启动 NoneBot。
|
||||
|
||||
```bash
|
||||
nb run --reload
|
||||
```
|
||||
|
||||
开启该功能后，在 uvicorn 运行时（FastAPI 提供的 ASGI 底层，即 reload 功能的实际来源），asyncio 使用的事件循环会被 uvicorn 从默认的 `ProactorEventLoop` 强制切换到 `SelectorEventLoop`。
|
||||
|
||||
> 相关信息参考 [uvicorn#529](https://github.com/encode/uvicorn/issues/529)，[uvicorn#1070](https://github.com/encode/uvicorn/pull/1070)，[uvicorn#1257](https://github.com/encode/uvicorn/pull/1257)
|
||||
|
||||
后者（`SelectorEventLoop`）在 Windows 平台的可使用性不如前者（`ProactorEventLoop`），包括但不限于
|
||||
|
||||
1. 不支持创建子进程
|
||||
2. 最多只支持 512 个套接字
|
||||
3. ...
|
||||
|
||||
> 具体信息参考 [Python 文档](https://docs.python.org/zh-cn/3/library/asyncio-platforms.html#windows)
|
||||
|
||||
所以，一些使用了 asyncio 的库因此可能无法正常工作，如：
|
||||
|
||||
1. [playwright](https://playwright.dev/python/docs/library#incompatible-with-selectoreventloop-of-asyncio-on-windows)
|
||||
|
||||
如果在开启该功能后，原本**正常运行**的代码报错，且打印的异常堆栈信息和 asyncio 有关（异常一般为 `NotImplementedError`），
|
||||
你可能就需要考虑相关库对事件循环的支持，以及是否启用该功能。
|
||||
:::
|
||||
|
||||
类型：`bool`
|
||||
默认值：`False`
|
||||
说明：是否开启 `uvicorn` 的 `reload` 功能，需要在机器人入口文件提供 ASGI 应用路径。
|
||||
|
||||
```python title=bot.py
|
||||
app = nonebot.get_asgi()
|
||||
nonebot.run(app="bot:app")
|
||||
```
|
||||
|
||||
##### `fastapi_reload_dirs`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：重载监控文件夹列表，默认为 uvicorn 默认值
|
||||
|
||||
##### `fastapi_reload_delay`
|
||||
|
||||
类型：`float | None`
|
||||
默认值：`None`
|
||||
说明：重载延迟，默认为 uvicorn 默认值
|
||||
|
||||
##### `fastapi_reload_includes`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||
|
||||
##### `fastapi_reload_excludes`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：不要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||
|
||||
##### `fastapi_extra`
|
||||
|
||||
类型：`Dist[str, Any]`
|
||||
默认值：`{}`
|
||||
说明：传递给 `FastAPI` 的其他参数
|
||||
|
||||
### Quart
|
||||
|
||||
**类型：**`ReverseDriver`
|
||||
|
||||
> Quart is an asyncio reimplementation of the popular Flask microframework API.
|
||||
|
||||
[Quart](https://quart.palletsprojects.com/) 是一个类 Flask 的异步版本，拥有与 Flask 非常相似的接口和使用方法。
|
||||
|
||||
```env
|
||||
DRIVER=~quart
|
||||
```
|
||||
|
||||
#### Quart 配置项
|
||||
|
||||
##### `quart_reload`
|
||||
|
||||
:::warning 警告
|
||||
不推荐开启该配置项，在 Windows 平台上开启该功能有可能会造成预料之外的影响！替代方案：使用 `nb-cli` 命令行工具以及参数 `--reload` 启动 NoneBot。
|
||||
|
||||
```bash
|
||||
nb run --reload
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
类型：`bool`
|
||||
默认值：`False`
|
||||
说明：是否开启 `uvicorn` 的 `reload` 功能，需要在机器人入口文件提供 ASGI 应用路径。
|
||||
|
||||
```python title=bot.py
|
||||
app = nonebot.get_asgi()
|
||||
nonebot.run(app="bot:app")
|
||||
```
|
||||
|
||||
##### `quart_reload_dirs`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：重载监控文件夹列表，默认为 uvicorn 默认值
|
||||
|
||||
##### `quart_reload_delay`
|
||||
|
||||
类型：`float | None`
|
||||
默认值：`None`
|
||||
说明：重载延迟，默认为 uvicorn 默认值
|
||||
|
||||
##### `quart_reload_includes`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||
|
||||
##### `quart_reload_excludes`
|
||||
|
||||
类型：`List[str] | None`
|
||||
默认值：`None`
|
||||
说明：不要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||
|
||||
##### `quart_extra`
|
||||
|
||||
类型：`Dist[str, Any]`
|
||||
默认值：`{}`
|
||||
说明：传递给 `Quart` 的其他参数
|
||||
|
||||
### HTTPX
|
||||
|
||||
**类型：**`ForwardDriver`
|
||||
|
||||
:::warning 注意
|
||||
本驱动器仅支持 HTTP 请求，不支持 WebSocket 连接请求。
|
||||
:::
|
||||
|
||||
> [HTTPX](https://www.python-httpx.org/) is a fully featured HTTP client for Python 3, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2.
|
||||
|
||||
```env
|
||||
DRIVER=~httpx
|
||||
```
|
||||
|
||||
### websockets
|
||||
|
||||
**类型：**`ForwardDriver`
|
||||
|
||||
:::warning 注意
|
||||
本驱动器仅支持 WebSocket 连接请求，不支持 HTTP 请求。
|
||||
:::
|
||||
|
||||
> [websockets](https://websockets.readthedocs.io/) is a library for building WebSocket servers and clients in Python with a focus on correctness, simplicity, robustness, and performance.
|
||||
|
||||
```env
|
||||
DRIVER=~websockets
|
||||
```
|
||||
|
||||
### AIOHTTP
|
||||
|
||||
**类型：**`ForwardDriver`
|
||||
|
||||
> [AIOHTTP](https://docs.aiohttp.org/): Asynchronous HTTP Client/Server for asyncio and Python.
|
||||
|
||||
```env
|
||||
DRIVER=~aiohttp
|
||||
```
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 376 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 103 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 128 KiB |
40
website/docs/advanced/matcher-provider.md
Normal file
40
website/docs/advanced/matcher-provider.md
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: 自定义事件响应器存储
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 110
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 事件响应器存储
|
||||
|
||||
事件响应器是 NoneBot 处理事件的核心，它们默认存储在一个字典中。在进入会话状态后，事件响应器将会转为临时响应器，作为最高优先级同样存储于该字典中。因此，事件响应器的存储类似于会话存储，它决定了整个 NoneBot 对事件的处理行为。
|
||||
|
||||
NoneBot 默认使用 Python 的字典将事件响应器存储于内存中，但是我们也可以自定义事件响应器存储，将事件响应器存储于其他地方，例如 Redis 等。这样我们就可以实现持久化、在多实例间共享会话状态等功能。
|
||||
|
||||
## 编写存储提供者
|
||||
|
||||
事件响应器的存储提供者 `MatcherProvider` 抽象类继承自 `MutableMapping[int, list[type[Matcher]]]`，即以优先级为键，以事件响应器列表为值的映射。我们可以方便地进行逐优先级事件传播。
|
||||
|
||||
编写一个自定义的存储提供者，只需要继承并实现 `MatcherProvider` 抽象类：
|
||||
|
||||
```python
|
||||
from nonebot.matcher import MatcherProvider
|
||||
|
||||
class CustomProvider(MatcherProvider):
|
||||
...
|
||||
```
|
||||
|
||||
## 设置存储提供者
|
||||
|
||||
我们可以通过 `matchers.set_provider` 方法设置存储提供者：
|
||||
|
||||
```python {3}
|
||||
from nonebot.matcher import matchers
|
||||
|
||||
matchers.set_provider(CustomProvider)
|
||||
|
||||
assert isinstance(matchers.provider, CustomProvider)
|
||||
```
|
||||
304
website/docs/advanced/matcher.md
Normal file
304
website/docs/advanced/matcher.md
Normal file
@ -0,0 +1,304 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: 事件响应器组成与内置响应规则
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 60
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 事件响应器进阶
|
||||
|
||||
在[指南](../tutorial/matcher.md)与[深入](../appendices/rule.md)中，我们已经介绍了事件响应器的基本用法以及响应规则、权限控制等功能。在这一节中，我们将介绍事件响应器的组成，以及内置的响应规则。
|
||||
|
||||
## 事件响应器组成
|
||||
|
||||
### 事件响应器类型
|
||||
|
||||
事件响应器类型 `type` 即是该响应器所要响应的事件类型，只有在接收到的事件类型与该响应器的类型相同时，才会触发该响应器。如果类型为空字符串 `""`，则响应器将会响应所有类型的事件。事件响应器类型的检查在所有其他检查（权限控制、响应规则）之前进行。
|
||||
|
||||
NoneBot 内置了四种常用事件类型：`meta_event`、`message`、`notice`、`request`，分别对应元事件、消息、通知、请求。通常情况下，协议适配器会将事件合理地分类至这四种类型中。如果有其他类型的事件需要响应，可以自行定义新的类型。
|
||||
|
||||
### 事件触发权限
|
||||
|
||||
事件触发权限 `permission` 是一个 `Permission` 对象，这在[权限控制](../appendices/permission.mdx)一节中已经介绍过。事件触发权限会在事件响应器的类型检查通过后进行检查，如果权限检查通过，则执行响应规则检查。
|
||||
|
||||
### 事件响应规则
|
||||
|
||||
事件响应规则 `rule` 是一个 `Rule` 对象，这在[响应规则](../appendices/rule.md)一节中已经介绍过。事件响应器的响应规则会在事件响应器的权限检查通过后进行匹配，如果响应规则检查通过，则触发该响应器。
|
||||
|
||||
### 响应优先级
|
||||
|
||||
响应优先级 `priority` 是一个正整数，用于指定响应器的优先级。响应器的优先级越小，越先被触发。如果响应器的优先级相同，则按照响应器的注册顺序进行触发。
|
||||
|
||||
### 阻断
|
||||
|
||||
阻断 `block` 是一个布尔值，用于指定响应器是否阻断事件的传播。如果阻断为 `True`，则在该响应器被触发后，事件将不会再传播给其他下一优先级的响应器。
|
||||
|
||||
NoneBot 内置的事件响应器中，所有非 `command` 规则的 `message` 类型的事件响应器都会阻断事件传递，其他则不会。
|
||||
|
||||
在部分情况中，可以使用 [`stop_propagation`](../appendices/session-control.mdx#stop_propagation) 方法动态阻止事件传播，该方法需要 handler 在参数中获取 matcher 实例后调用方法。
|
||||
|
||||
### 有效期
|
||||
|
||||
事件响应器的有效期分为 `temp` 和 `expire_time` 。`temp` 是一个布尔值，用于指定响应器是否为临时响应器。如果为 `True`，则该响应器在被触发后会被自动销毁。`expire_time` 是一个 `datetime` 对象，用于指定响应器的过期时间。如果 `expire_time` 不为 `None`，则在该时间点后，该响应器会被自动销毁。
|
||||
|
||||
### 默认状态
|
||||
|
||||
事件响应器的默认状态 `default_state` 是一个 `dict` 对象，用于指定响应器的默认状态。在响应器被触发时，响应器将会初始化默认状态然后开始执行事件处理流程。
|
||||
|
||||
## 基本辅助函数
|
||||
|
||||
NoneBot 为四种类型的事件响应器提供了五个基本的辅助函数：
|
||||
|
||||
- `on`：创建任何类型的事件响应器。
|
||||
- `on_metaevent`：创建元事件响应器。
|
||||
- `on_message`：创建消息事件响应器。
|
||||
- `on_request`：创建请求事件响应器。
|
||||
- `on_notice`：创建通知事件响应器。
|
||||
|
||||
除了 `on` 函数具有一个 `type` 参数外，其余参数均相同：
|
||||
|
||||
- `rule`：响应规则，可以是 `Rule` 对象或者 `RuleChecker` 函数。
|
||||
- `permission`：事件触发权限，可以是 `Permission` 对象或者 `PermissionChecker` 函数。
|
||||
- `handlers`：事件处理函数列表。
|
||||
- `temp`：是否为临时响应器。
|
||||
- `expire_time`：响应器的过期时间。
|
||||
- `priority`：响应器的优先级。
|
||||
- `block`：是否阻断事件传播。
|
||||
- `state`：响应器的默认状态。
|
||||
|
||||
在消息类型的事件响应器的基础上，NoneBot 还内置了一些常用的响应规则，并结合为辅助函数来方便我们快速创建指定功能的响应器。下面我们逐个介绍。
|
||||
|
||||
## 内置响应规则
|
||||
|
||||
### `startswith`
|
||||
|
||||
`startswith` 响应规则用于匹配消息纯文本部分的开头是否与指定字符串（或一系列字符串）相同。可选参数 `ignorecase` 用于指定是否忽略大小写，默认为 `False`。
|
||||
|
||||
例如，我们可以创建一个匹配消息开头为 `!` 或者 `/` 的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import startswith
|
||||
|
||||
rule = startswith(("!", "/"), ignorecase=False)
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_startswith
|
||||
|
||||
matcher = on_startswith(("!", "/"), ignorecase=False)
|
||||
```
|
||||
|
||||
### `endswith`
|
||||
|
||||
`endswith` 响应规则用于匹配消息纯文本部分的结尾是否与指定字符串（或一系列字符串）相同。可选参数 `ignorecase` 用于指定是否忽略大小写，默认为 `False`。
|
||||
|
||||
例如，我们可以创建一个匹配消息结尾为 `.` 或者 `。` 的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import endswith
|
||||
|
||||
rule = endswith((".", "。"), ignorecase=False)
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_endswith
|
||||
|
||||
matcher = on_endswith((".", "。"), ignorecase=False)
|
||||
```
|
||||
|
||||
### `fullmatch`
|
||||
|
||||
`fullmatch` 响应规则用于匹配消息纯文本部分是否与指定字符串（或一系列字符串）完全相同。可选参数 `ignorecase` 用于指定是否忽略大小写，默认为 `False`。
|
||||
|
||||
例如，我们可以创建一个匹配消息为 `ping` 或者 `pong` 的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import fullmatch
|
||||
|
||||
rule = fullmatch(("ping", "pong"), ignorecase=False)
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_fullmatch
|
||||
|
||||
matcher = on_fullmatch(("ping", "pong"), ignorecase=False)
|
||||
```
|
||||
|
||||
### `keyword`
|
||||
|
||||
`keyword` 响应规则用于匹配消息纯文本部分是否包含指定字符串（或一系列字符串）。
|
||||
|
||||
例如，我们可以创建一个匹配消息中包含 `hello` 或者 `hi` 的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import keyword
|
||||
|
||||
rule = keyword("hello", "hi")
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_keyword
|
||||
|
||||
matcher = on_keyword("hello", "hi")
|
||||
```
|
||||
|
||||
### `command`
|
||||
|
||||
`command` 是最常用的响应规则，它用于匹配消息是否为命令。它会根据配置中的 [Command Start 和 Command Separator](../appendices/config.mdx#command-start-和-command-separator) 来判断消息是否为命令。
|
||||
|
||||
例如，当我们配置了 `Command Start` 为 `/`，`Command Separator` 为 `.` 时：
|
||||
|
||||
```python
|
||||
from nonebot.rule import command
|
||||
|
||||
# 匹配 "/help" 或者 "/帮助" 开头的消息
|
||||
rule = command("help", "帮助")
|
||||
# 匹配 "/help.cmd" 开头的消息
|
||||
rule = command(("help", "cmd"))
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_command
|
||||
|
||||
matcher = on_command("help", aliases={"帮助"})
|
||||
```
|
||||
|
||||
此外，`command` 响应规则默认允许消息命令与参数间不加空格，如果需要严格匹配命令与参数间的空白符，可以使用 `command` 函数的 `force_whitespace` 参数。`force_whitespace` 参数可以是 bool 类型或者具体的字符串，默认为 `False`。如果为 `True`，则命令与参数间必须有任意个数的空白符；如果为字符串，则命令与参数间必须有且与给定字符串一致的空白符。
|
||||
|
||||
```python
|
||||
rule = command("help", force_whitespace=True)
|
||||
rule = command("help", force_whitespace=" ")
|
||||
```
|
||||
|
||||
命令解析后的结果可以通过 [`Command`](./dependency.mdx#command)、[`RawCommand`](./dependency.mdx#rawcommand)、[`CommandArg`](./dependency.mdx#commandarg)、[`CommandStart`](./dependency.mdx#commandstart)、[`CommandWhitespace`](./dependency.mdx#commandwhitespace) 依赖注入获取。
|
||||
|
||||
### `shell_command`
|
||||
|
||||
`shell_command` 响应规则用于匹配类 shell 命令形式的消息。它首先与 [`command`](#command) 响应规则一样进行命令匹配，如果匹配成功，则会进行进一步的参数解析。参数解析采用 `argparse` 标准库进行，在此基础上添加了消息序列 `Message` 支持。
|
||||
|
||||
例如，我们可以创建一个匹配 `/cmd` 命令并且带有 `-v` 选项与默认 `-h` 帮助选项的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import shell_command, ArgumentParser
|
||||
|
||||
parser = ArgumentParser()
|
||||
parser.add_argument("-v", "--verbose", action="store_true")
|
||||
|
||||
rule = shell_command("cmd", parser=parser)
|
||||
```
|
||||
|
||||
更多关于 `argparse` 的使用方法请参考 [argparse 文档](https://docs.python.org/zh-cn/3/library/argparse.html)。我们也可以选择不提供 `parser` 参数，这样 `shell_command` 将不会解析参数，但会提供参数列表 `argv`。
|
||||
|
||||
直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_shell_command
|
||||
from nonebot.rule import ArgumentParser
|
||||
|
||||
parser = ArgumentParser()
|
||||
parser.add_argument("-v", "--verbose", action="store_true")
|
||||
|
||||
matcher = on_shell_command("cmd", parser=parser)
|
||||
```
|
||||
|
||||
参数解析后的结果可以通过 [`ShellCommandArgv`](./dependency.mdx#shellcommandargv)、[`ShellCommandArgs`](./dependency.mdx#shellcommandargs) 依赖注入获取。
|
||||
|
||||
### `regex`
|
||||
|
||||
`regex` 响应规则用于匹配消息是否与指定正则表达式匹配。
|
||||
|
||||
:::tip 提示
|
||||
正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 模式来确保匹配开头。
|
||||
:::
|
||||
|
||||
例如，我们可以创建一个匹配消息中包含字母并且忽略大小写的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import regex
|
||||
|
||||
rule = regex(r"[a-z]+", flags=re.IGNORECASE)
|
||||
```
|
||||
|
||||
也可以直接使用辅助函数新建一个响应器：
|
||||
|
||||
```python
|
||||
from nonebot import on_regex
|
||||
|
||||
matcher = on_regex(r"[a-z]+", flags=re.IGNORECASE)
|
||||
```
|
||||
|
||||
正则匹配后的结果可以通过 [`RegexStr`](./dependency.mdx#regexstr)、[`RegexGroup`](./dependency.mdx#regexgroup)、[`RegexDict`](./dependency.mdx#regexdict) 依赖注入获取。
|
||||
|
||||
### `to_me`
|
||||
|
||||
`to_me` 响应规则用于匹配事件是否与机器人相关。
|
||||
|
||||
例如：
|
||||
|
||||
```python
|
||||
from nonebot.rule import to_me
|
||||
|
||||
rule = to_me()
|
||||
```
|
||||
|
||||
### `is_type`
|
||||
|
||||
`is_type` 响应规则用于匹配事件类型是否为指定类型（或者一系列类型）。
|
||||
|
||||
例如，我们可以创建一个匹配 OneBot v11 私聊和群聊消息事件的规则：
|
||||
|
||||
```python
|
||||
from nonebot.rule import is_type
|
||||
from nonebot.adapters.onebot.v11 import PrivateMessageEvent, GroupMessageEvent
|
||||
|
||||
rule = is_type(PrivateMessageEvent, GroupMessageEvent)
|
||||
```
|
||||
|
||||
## 响应器组
|
||||
|
||||
为了更方便的管理一系列功能相近的响应器，NoneBot 提供了两种响应器组，它们可以帮助我们进行响应器的统一管理。
|
||||
|
||||
### `CommandGroup`
|
||||
|
||||
`CommandGroup` 可以用于管理一系列具有相同前置命令的子命令响应器。
|
||||
|
||||
例如，我们创建 `/cmd`、`/cmd.sub`、`/cmd.help` 三个命令，他们具有相同的优先级：
|
||||
|
||||
```python
|
||||
from nonebot import CommandGroup
|
||||
|
||||
group = CommandGroup("cmd", priority=10)
|
||||
|
||||
cmd = group.command(tuple())
|
||||
sub_cmd = group.command("sub")
|
||||
help_cmd = group.command("help")
|
||||
```
|
||||
|
||||
### `MatcherGroup`
|
||||
|
||||
`MatcherGroup` 可以用于管理一系列具有相同属性的响应器。
|
||||
|
||||
例如，我们创建一个具有相同响应规则的响应器组：
|
||||
|
||||
```python
|
||||
from nonebot.rule import to_me
|
||||
from nonebot import MatcherGroup
|
||||
|
||||
group = MatcherGroup(rule=to_me())
|
||||
|
||||
matcher1 = group.on_message()
|
||||
matcher2 = group.on_message()
|
||||
```
|
||||
@ -1,95 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: 自定义事件响应器的响应权限
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 40
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 权限控制
|
||||
|
||||
**权限控制**是机器人在实际应用中需要解决的重点问题之一，NoneBot2 提供了灵活的权限控制机制——`Permission`，接下来我们将简单说明。
|
||||
|
||||
## 应用
|
||||
|
||||
如同 `Rule` 一样，`Permission` 可以在[定义事件响应器](../tutorial/plugin/create-matcher.md)时添加 `permission` 参数来加以应用，这样 NoneBot2 会在事件响应时检测事件主体的权限。下面我们以 `SUPERUSER` 为例，对该机制的应用做一下介绍。
|
||||
|
||||
```python
|
||||
from nonebot.permission import SUPERUSER
|
||||
from nonebot import on_command
|
||||
|
||||
matcher = on_command("测试超管", permission=SUPERUSER)
|
||||
|
||||
|
||||
@matcher.handle()
|
||||
async def _():
|
||||
await matcher.send("超管命令测试成功")
|
||||
|
||||
|
||||
@matcher.got("key1", "超管提问")
|
||||
async def _():
|
||||
await matcher.send("超管命令 got 成功")
|
||||
```
|
||||
|
||||
在这段代码中，我们事件响应器指定了 `SUPERUSER` 这样一个权限，那么机器人只会响应超级管理员的 `测试超管` 命令，并且会响应该超级管理员的连续对话。
|
||||
|
||||
:::tip 提示
|
||||
在这里需要强调的是，`Permission` 与 `Rule` 的表现并不相同， `Rule` 只会在初次响应时生效，在余下的对话中并没有限制事件；但是 `Permission` 会持续生效，在连续对话中一直对事件主体加以限制。
|
||||
:::
|
||||
|
||||
## 进阶
|
||||
|
||||
`Permission` 除了可以在注册事件响应器时加以应用，还可以在编写事件处理函数 `handler` 时主动调用，我们可以利用这个特性在一个 `handler` 里对不同权限的事件主体进行区别响应，下面我们以 OneBot 适配器中的 `GROUP_ADMIN`（普通管理员非群主）和 `GROUP_OWNER` 为例，说明下怎么进行主动调用。
|
||||
|
||||
```python
|
||||
from nonebot import on_command
|
||||
from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent
|
||||
from nonebot.adapters.onebot.v11 import GROUP_ADMIN, GROUP_OWNER
|
||||
|
||||
matcher = on_command("测试权限")
|
||||
|
||||
@matcher.handle()
|
||||
async def _(bot: Bot, event: GroupMessageEvent):
|
||||
if await GROUP_ADMIN(bot, event):
|
||||
await matcher.send("管理员测试成功")
|
||||
elif await GROUP_OWNER(bot, event):
|
||||
await matcher.send("群主测试成功")
|
||||
else:
|
||||
await matcher.send("群员测试成功")
|
||||
```
|
||||
|
||||
在这段代码里，我们并没有对命令的权限指定，这个命令会响应所有在群聊中的 `测试权限` 命令，但是在 `handler` 里，我们对两个 `Permission` 进行主动调用，从而可以对不同的角色进行不同的响应。
|
||||
|
||||
## 自定义
|
||||
|
||||
如同 `Rule` 一样，`Permission` 也是由非负数个 `PermissionChecker` 组成的，但只需其中一个返回 `True` 时就会匹配成功。下面是自定义 `PermissionChecker` 和 `Permission` 的示例：
|
||||
|
||||
```python
|
||||
from nonebot.adapters import Bot, Event
|
||||
from nonebot.permission import Permission
|
||||
|
||||
async def async_checker(bot: Bot, event: Event) -> bool:
|
||||
return True
|
||||
|
||||
def sync_checker(bot: Bot, event: Event) -> bool:
|
||||
return True
|
||||
|
||||
def check(arg1, arg2):
|
||||
|
||||
async def _checker(bot: Bot, event: Event) -> bool:
|
||||
return bool(arg1 + arg2)
|
||||
|
||||
return Permission(_checker)
|
||||
```
|
||||
|
||||
`Permission` 和 `PermissionChecker` 之间可以使用 `|`（或符号）互相组合：
|
||||
|
||||
```python
|
||||
from nonebot.permission import Permission
|
||||
|
||||
Permission(async_checker1) | sync_checker | async_checker2
|
||||
```
|
||||
|
||||
同样地，如果想用 `Permission(*checkers)` 包裹构造 `Permission`，函数必须是异步的；但是在利用 `|`（或符号）连接构造时，NoneBot2 会自动包裹同步函数为异步函数。
|
||||
97
website/docs/advanced/plugin-info.md
Normal file
97
website/docs/advanced/plugin-info.md
Normal file
@ -0,0 +1,97 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 填写与获取插件相关的信息
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 30
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 插件信息
|
||||
|
||||
NoneBot 是一个插件化的框架，可以通过加载插件来扩展功能。同时，我们也可以通过 NoneBot 的插件系统来获取相关信息，例如插件的名称、使用方法，用于收集帮助信息等。下面我们将介绍如何为插件添加元数据，以及如何获取插件信息。
|
||||
|
||||
## 插件元数据
|
||||
|
||||
在 NoneBot 中，插件 [`Plugin`](../api/plugin/plugin.md#Plugin) 对象中存储了插件系统所需要的一系列信息。包括插件的索引名称、插件模块、插件中的事件响应器、插件父子关系等。通常，只有插件开发者才需要关心这些信息，而插件使用者或者机器人用户想要看到的是插件使用方法等帮助信息。因此，我们可以为插件添加插件元数据 `PluginMetadata`，它允许插件开发者为插件添加一些额外的信息。这些信息编写于插件模块的顶层，可以直接通过源码查看，或者通过 NoneBot 插件系统获取收集到的信息，通过其他方式发送给机器人用户等。
|
||||
|
||||
现在，假设我们有一个插件 `example`, 它的模块结构如下：
|
||||
|
||||
```tree {4-6} title=Project
|
||||
📦 awesome-bot
|
||||
├── 📂 awesome_bot
|
||||
│ └── 📂 plugins
|
||||
| └── 📂 example
|
||||
| ├── 📜 __init__.py
|
||||
| └── 📜 config.py
|
||||
├── 📜 pyproject.toml
|
||||
└── 📜 README.md
|
||||
```
|
||||
|
||||
我们需要在插件顶层模块 `example/__init__.py` 中添加插件元数据，如下所示：
|
||||
|
||||
```python {1,5-11} title=example/__init__.py
|
||||
from nonebot.plugin import PluginMetadata
|
||||
|
||||
from .config import Config
|
||||
|
||||
__plugin_meta__ = PluginMetadata(
|
||||
name="示例插件",
|
||||
description="这是一个示例插件",
|
||||
usage="没什么用",
|
||||
config=Config,
|
||||
extra={},
|
||||
)
|
||||
```
|
||||
|
||||
我们可以看到，插件元数据 `PluginMetadata` 有三个基本属性：插件名称、插件描述、插件使用方法。除此之外，还有两个可选的属性。`config` 属性用于指定插件的[配置类](../appendices/config.mdx#插件配置)，`extra` 属性，它是一个字典，可以用于存储任意信息。其他插件可以通过约定 `extra` 字典的键名来达成收集某些特殊信息的目的。
|
||||
|
||||
请注意，这里的**插件名称**是供使用者或机器人用户查看的，与插件索引名称无关。**插件索引名称（插件模块名称）**仅用于 NoneBot 插件系统**内部索引**。
|
||||
|
||||
## 获取插件信息
|
||||
|
||||
NoneBot 提供了多种获取插件对象的方法，例如获取当前所有已导入的插件：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
plugins: set[Plugin] = nonebot.get_loaded_plugins()
|
||||
```
|
||||
|
||||
也可以通过插件索引名称获取插件对象：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
plugin: Plugin | None = nonebot.get_plugin("example")
|
||||
```
|
||||
|
||||
或者通过模块路径获取插件对象：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
plugin: Plugin | None = nonebot.get_plugin_by_module_name("awesome_bot.plugins.example")
|
||||
```
|
||||
|
||||
如果需要获取所有当前声明的插件名称（可能还未加载），可以使用 `get_available_plugin_names` 函数：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
plugin_names: set[str] = nonebot.get_available_plugin_names()
|
||||
```
|
||||
|
||||
插件对象 `Plugin` 中包含了多个属性：
|
||||
|
||||
- `name`：插件索引名称
|
||||
- `module`：插件模块
|
||||
- `module_name`：插件模块路径
|
||||
- `manager`：插件管理器
|
||||
- `matcher`：插件中定义的事件响应器
|
||||
- `parent_plugin`：插件的父插件
|
||||
- `sub_plugins`：插件的子插件集合
|
||||
- `metadata`：插件元数据
|
||||
|
||||
通过这些属性以及插件元数据，我们就可以收集所需要的插件信息了。
|
||||
41
website/docs/advanced/plugin-nesting.md
Normal file
41
website/docs/advanced/plugin-nesting.md
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: 编写与加载嵌套插件
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 40
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 嵌套插件
|
||||
|
||||
NoneBot 支持嵌套插件，即一个插件可以包含其他插件。通过这种方式，我们可以将一个大型插件拆分成多个功能子插件，使得插件更加清晰、易于维护。我们可以直接在插件中使用 NoneBot 加载插件的方法来加载子插件。
|
||||
|
||||
## 创建嵌套插件
|
||||
|
||||
我们可以在使用 `nb-cli` 命令[创建插件](../tutorial/create-plugin.md#创建插件)时，选择直接通过模板创建一个嵌套插件：
|
||||
|
||||
```bash
|
||||
$ nb plugin create
|
||||
[?] 插件名称: parent
|
||||
[?] 使用嵌套插件? (y/N) Y
|
||||
[?] 输出目录: awesome_bot/plugins
|
||||
```
|
||||
|
||||
或者使用 `nb plugin create --sub-plugin` 选项直接创建一个嵌套插件。
|
||||
|
||||
## 已有插件
|
||||
|
||||
如果你已经有一个插件，想要在其中嵌套加载子插件，可以在插件的 `__init__.py` 中添加如下代码：
|
||||
|
||||
```python title=parent/__init__.py
|
||||
import nonebot
|
||||
from pathlib import Path
|
||||
|
||||
sub_plugins = nonebot.load_plugins(
|
||||
str(Path(__file__).parent.joinpath("plugins").resolve())
|
||||
)
|
||||
```
|
||||
|
||||
这样，`parent` 插件就会加载 `parent/plugins` 目录下的所有插件。NoneBot 会正确识别这些插件的父子关系，你可以在 `parent` 的插件信息中看到这些子插件的信息，也可以在子插件信息中看到它们的父插件信息。
|
||||
@ -1,76 +0,0 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: 发布插件到 NoneBot2 商店
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 80
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 发布插件
|
||||
|
||||
## 前注
|
||||
|
||||
本章节仅包含插件发布流程指导，插件开发请查阅[**创建插件**](../tutorial/plugin/introduction.md)章节与[**Plugin API 文档**](../api/plugin/index.md)。
|
||||
|
||||
## 插件发布流程
|
||||
|
||||
### 发布到 PyPI
|
||||
|
||||
您可以选择自己喜欢的方式将插件发布到 [**PyPI**](https://pypi.org/)，如使用 [**setuptools**](https://pypi.org/project/setuptools/) 或 [**Poetry**](https://pypi.org/project/poetry/)。
|
||||
|
||||
发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 `nonebot-plugin-` 作为 PyPI 项目名前缀（如`nonebot-plugin-foo`），以 `nonebot_plugin_` 作为 Python 包名的前缀（如`nonebot_plugin_foo`），这并非强制规范，而是为了防止与其他 PyPI 包产生冲突，所以我们推荐您在没有特殊需求的情况下这样做。
|
||||
|
||||
:::warning
|
||||
虽然在 NoneBot 2 载入插件时，插件的 Python 包名中可以使用 `-`，但是在 Python 的 import 语句中，`-` 不会被解析为包名的一部分。如果插件需要向外界提供 import 语法导入的支持，应在 Python 包名中使用 `_` 代替 `-`。
|
||||
:::
|
||||
|
||||
发布后，请确保您的插件已能公开的从 PyPI 访问到，试着检查您的插件在 PyPI 的地址，如 `https://pypi.org/project/<您的 NoneBot2 插件项目名>`。
|
||||
|
||||
### 托管您的插件源代码
|
||||
|
||||
将插件源代码及相关构建文件（如 `pyproject.toml` 或 `setup.py` 等与 PyPI 包构建相关的文件）托管在公开代码仓。
|
||||
|
||||
请确保您的代码仓库地址能够被正确的访问，检查您的插件在代码仓的地址，如 `https://github.com/<您的 Github 用户名>/<您的插件 Github 项目名>`。
|
||||
|
||||
### 申请发布到 NoneBot2 插件商店
|
||||
|
||||
完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 [**NoneBot2 商店**](https://v2.nonebot.dev/store)页面，切换到**插件**页签，点击**发布插件**按钮。
|
||||
|
||||
|
||||
|
||||
如图所示，在弹出的插件信息提交表单内，填入您所要发布的相应插件信息：
|
||||
|
||||
```text
|
||||
插件名称：您的 NoneBot2 插件名称
|
||||
插件介绍：为您的插件提供的简短介绍信息
|
||||
PyPI 项目名：您的插件所在的 PyPI Project 名，如 nonebot-plugin-xxxx
|
||||
import 包名：您的插件通过 Python 导入时使用的包名，如 nonebot_plugin_xxxx
|
||||
仓库/主页：您的插件托管地址，如 https://github.com/<您的 Github 用户名>/nonebot-plugin-xxxx
|
||||
标签：一个或多个可选颜色的 TAG，每填写一个点击添加标签，若要删除，点击标签即可；标签长度不超过 10 字符，标签个数不超过 3 个
|
||||
特定标签内容 Adapter：点击 Type 的 Adapter，将创建一个 a: 开头的标签，填入内容以指定您插件使用的 adapter
|
||||
特定标签内容 Topic：点击 Type 的 Topic，将创建一个 t: 开头的标签，填入内容以指定您插件的主题
|
||||
```
|
||||
|
||||
|
||||
|
||||
完成填写后，请点击**发布**按钮，这将自动在[**NoneBot2**](https://github.com/nonebot/nonebot2)代码仓内创建发布您的插件的对应 Issue。
|
||||
|
||||
### 等待插件发布处理
|
||||
|
||||
您的插件发布 Issue 创建后，将会经过 _NoneBot2 Publish Bot_ 的检查，以确保插件信息正确无误。
|
||||
|
||||
若您的插件发布 Issue 未通过检查，您可以**直接修改** Issue 内容以更新发布请求。_NoneBot2 Publish Bot_ 在您修改 Issue 内容后将会自动重新执行检查。您无需关闭、重新提交发布申请。
|
||||
|
||||
之后，NoneBot2 的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。
|
||||
|
||||
完成这些步骤后，您的插件将会被合并到 [**NoneBot2 商店**](https://v2.nonebot.dev/store)，而您也将成为 [**NoneBot2 贡献者**](https://github.com/nonebot/nonebot2/graphs/contributors)中的一员。
|
||||
|
||||
## 完成
|
||||
|
||||
恭喜您，经过上述的发布流程，您的插件已经成功发布到 NoneBot2 商店了。
|
||||
|
||||
此时，您可以在 [**NoneBot2 商店**](https://v2.nonebot.dev/store)的插件页签查找到您的插件。同时，欢迎您成为 [**NoneBot2 贡献者**](https://github.com/nonebot/nonebot2/graphs/contributors)！
|
||||
|
||||
**Congratulations!**
|
||||
37
website/docs/advanced/requiring.md
Normal file
37
website/docs/advanced/requiring.md
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: 使用其他插件提供的功能
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 50
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 跨插件访问
|
||||
|
||||
NoneBot 插件化系统的设计使得插件之间可以功能独立、各司其职，我们可以更好地维护和扩展插件。但是，有时候我们可能需要在不同插件之间调用功能。NoneBot 生态中就有一类插件，它们专为其他插件提供功能支持，如：[定时任务插件](../best-practice/scheduler.md)、[数据存储插件](../best-practice/data-storing.md)等。这时候我们就需要在插件之间进行跨插件访问。
|
||||
|
||||
## 插件跟踪
|
||||
|
||||
由于 NoneBot 插件系统通过 [Import Hooks](https://docs.python.org/3/reference/import.html#import-hooks) 的方式实现插件加载与跟踪管理，因此我们**不能**在 NoneBot 跟踪插件前进行模块 import，这会导致插件加载失败。即，我们不能在使用 NoneBot 提供的加载插件方法前，直接使用 `import` 语句导入插件。
|
||||
|
||||
对于在项目目录下的插件，我们通常直接使用 `load_from_toml` 等方法一次性加载所有插件。由于这些插件已经被声明，即便插件导入顺序不同，NoneBot 也能正确跟踪插件。此时，我们不需要对跨插件访问进行特殊处理。但当我们使用了外部插件，如果没有事先声明或加载插件，NoneBot 并不会将其当作插件进行跟踪，可能会出现意料之外的错误出现。
|
||||
|
||||
简单来说，我们必须在 `import` 外部插件之前，确保依赖的外部插件已经被声明或加载。
|
||||
|
||||
## 插件依赖声明
|
||||
|
||||
NoneBot 提供了一种方法来确保我们依赖的插件已经被正确加载，即使用 `require` 函数。通过 `require` 函数，我们可以在当前插件中声明依赖的插件，NoneBot 会在加载当前插件时，检查依赖的插件是否已经被加载，如果没有，会尝试优先加载依赖的插件。
|
||||
|
||||
假设我们有一个插件 `a` 依赖于插件 `b`，我们可以在插件 `a` 中使用 `require` 函数声明其依赖于插件 `b`：
|
||||
|
||||
```python {3} title=a/__init__.py
|
||||
from nonebot import require
|
||||
|
||||
require("b")
|
||||
|
||||
from b import some_function
|
||||
```
|
||||
|
||||
其中，`require` 函数的参数为插件索引名称或者外部插件的模块名称。在完成依赖声明后，我们可以在插件 `a` 中直接导入插件 `b` 所提供的功能。
|
||||
134
website/docs/advanced/routing.md
Normal file
134
website/docs/advanced/routing.md
Normal file
@ -0,0 +1,134 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: 添加服务端路由规则
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 100
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 添加路由
|
||||
|
||||
在[驱动器](./driver.md)一节中，我们了解了驱动器的两种类型。既然驱动器可以作为服务端运行，那么我们就可以向驱动器添加路由规则，从而实现自定义的 API 接口等功能。在添加路由规则时，我们需要注意驱动器的类型，详情可以参考[选择驱动器](./driver.md#配置驱动器)。
|
||||
|
||||
NoneBot 中，我们可以通过两种途径向驱动器添加路由规则：
|
||||
|
||||
1. 通过 NoneBot 的兼容层建立路由规则。
|
||||
2. 直接向 ASGI 应用添加路由规则。
|
||||
|
||||
这两种途径各有优劣，前者可以在各种服务端型驱动器下运行，但并不能直接使用 ASGI 应用框架提供的特性与功能；后者直接使用 ASGI 应用，更自由、功能完整，但只能在特定类型驱动器下运行。
|
||||
|
||||
在向驱动器添加路由规则时，我们需要注意驱动器是否为服务端类型，我们可以通过以下方式判断：
|
||||
|
||||
```python {3}
|
||||
from nonebot import get_driver
|
||||
from nonebot.drivers import ReverseDriver
|
||||
|
||||
can_use = isinstance(get_driver(), ReverseDriver)
|
||||
```
|
||||
|
||||
## 通过兼容层添加路由
|
||||
|
||||
NoneBot 兼容层定义了两个数据类 `HTTPServerSetup` 和 `WebSocketServerSetup`，分别用于定义 HTTP 服务端和 WebSocket 服务端的路由规则。
|
||||
|
||||
### HTTP 路由
|
||||
|
||||
`HTTPServerSetup` 具有四个属性：
|
||||
|
||||
- `path`：路由路径，不支持特殊占位表达式。类型为 `URL`。
|
||||
- `method`：请求方法。类型为 `str`。
|
||||
- `name`：路由名称，不可重复。类型为 `str`。
|
||||
- `handle_func`：路由处理函数。类型为 `Callable[[Request], Awaitable[Response]]`。
|
||||
|
||||
例如，我们添加一个 `/hello` 的路由，当请求方法为 `GET` 时，返回 `200 OK` 以及返回体信息：
|
||||
|
||||
```python
|
||||
from nonebot import get_driver
|
||||
from nonebot.drivers import URL, Request, Response, HTTPServerSetup
|
||||
|
||||
async def hello(request: Request) -> Response:
|
||||
return Response(200, content="Hello, world!")
|
||||
|
||||
if isinstance((driver := get_driver()), ReverseDriver):
|
||||
driver.setup_http_server(
|
||||
HTTPServerSetup(
|
||||
path=URL("/hello"),
|
||||
method="GET",
|
||||
name="hello",
|
||||
handle_func=hello,
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
对于 `Request` 和 `Response` 的详细信息，可以参考 [API 文档](../api/drivers/index.md)。
|
||||
|
||||
### WebSocket 路由
|
||||
|
||||
`WebSocketServerSetup` 具有三个属性：
|
||||
|
||||
- `path`：路由路径，不支持特殊占位表达式。类型为 `URL`。
|
||||
- `name`：路由名称，不可重复。类型为 `str`。
|
||||
- `handle_func`：路由处理函数。类型为 `Callable[[WebSocket], Awaitable[Any]]`。
|
||||
|
||||
例如，我们添加一个 `/ws` 的路由，发送所有接收到的数据：
|
||||
|
||||
```python
|
||||
from nonebot import get_driver
|
||||
from nonebot.drivers import URL, WebSocket, WebSocketServerSetup
|
||||
|
||||
async def ws_handler(ws: WebSocket):
|
||||
await ws.accept()
|
||||
try:
|
||||
while True:
|
||||
data = await ws.receive()
|
||||
await ws.send(data)
|
||||
except WebSocketClosed as e:
|
||||
# handle closed
|
||||
...
|
||||
finally:
|
||||
with contextlib.suppress(Exception):
|
||||
await websocket.close()
|
||||
# do some cleanup
|
||||
|
||||
if isinstance((driver := get_driver()), ReverseDriver):
|
||||
driver.setup_websocket_server(
|
||||
WebSocketServerSetup(
|
||||
path=URL("/ws"),
|
||||
name="ws",
|
||||
handle_func=ws_handler,
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
对于 `WebSocket` 的详细信息，可以参考 [API 文档](../api/drivers/index.md)。
|
||||
|
||||
## 使用 ASGI 应用添加路由
|
||||
|
||||
### 获取 ASGI 应用
|
||||
|
||||
NoneBot 服务端类型的驱动器具有两个属性 `server_app` 和 `asgi`，分别对应驱动框架应用和 ASGI 应用。通常情况下，这两个应用是同一个对象。我们可以通过 `get_app()` 方法快速获取：
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
|
||||
app = nonebot.get_app()
|
||||
asgi = nonebot.get_asgi()
|
||||
```
|
||||
|
||||
### 添加路由规则
|
||||
|
||||
在获取到了 ASGI 应用后，我们就可以直接使用 ASGI 应用框架提供的功能来添加路由规则了。这里我们以 [FastAPI](./driver.md#fastapi默认) 为例，演示如何添加路由规则。
|
||||
|
||||
在下面的代码中，我们添加了一个 `GET` 类型的 `/api` 路由，具体方法参考 [FastAPI 文档](https://fastapi.tiangolo.com/)。
|
||||
|
||||
```python
|
||||
import nonebot
|
||||
from fastapi import FastAPI
|
||||
|
||||
app: FastAPI = nonebot.get_app()
|
||||
|
||||
@app.get("/api")
|
||||
async def custom_api():
|
||||
return {"message": "Hello, world!"}
|
||||
```
|
||||
@ -1,75 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 自定义事件响应器的响应规则
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 30
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 自定义匹配规则
|
||||
|
||||
机器人在实际应用中，往往会接收到多种多样的事件类型，NoneBot2 提供了可自定义的匹配规则 ── `Rule`。在[定义事件响应器](../tutorial/plugin/create-matcher.md#创建事件响应器)中，已经介绍了多种内置的事件响应器，接下来我们将说明自定义匹配规则的基本用法。
|
||||
|
||||
## 创建匹配规则
|
||||
|
||||
匹配规则可以是一个 `Rule` 对象，也可以是一个 `RuleChecker` 类型。`Rule` 是多个 `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查通过时匹配成功。`RuleChecker` 是一个返回值为 `Bool` 类型的依赖函数，即，`RuleChecker` 支持依赖注入。
|
||||
|
||||
### 创建 `RuleChecker`
|
||||
|
||||
```python {1-2}
|
||||
async def user_checker(event: Event) -> bool:
|
||||
return event.get_user_id() == "123123"
|
||||
|
||||
matcher = on_message(rule=user_checker)
|
||||
```
|
||||
|
||||
在上面的代码中，我们定义了一个函数 `user_checker`，它检查事件的用户 ID 是否等于 `"123123"`。这个函数 `user_checker` 即为一个 `RuleChecker`。
|
||||
|
||||
### 创建 `Rule`
|
||||
|
||||
```python {1-2,4-5,7}
|
||||
async def user_checker(event: Event) -> bool:
|
||||
return event.get_user_id() == "123123"
|
||||
|
||||
async def message_checker(event: Event) -> bool:
|
||||
return event.get_plaintext() == "hello"
|
||||
|
||||
rule = Rule(user_checker, message_checker)
|
||||
matcher = on_message(rule=rule)
|
||||
```
|
||||
|
||||
在上面的代码中，我们定义了两个函数 `user_checker` 和 `message_checker`，它们检查事件的用户 ID 是否等于 `"123123"`，以及消息的内容是否等于 `"hello"`。随后，我们定义了一个 `Rule` 对象，它包含了这两个函数。
|
||||
|
||||
## 注册匹配规则
|
||||
|
||||
在[定义事件响应器](../tutorial/plugin/create-matcher.md#创建事件响应器)中，我们已经了解了如何事件响应器的组成。现在，我们仅需要将匹配规则注册到事件响应器中。
|
||||
|
||||
```python {4}
|
||||
async def user_checker(event: Event) -> bool:
|
||||
return event.get_user_id() == "123123"
|
||||
|
||||
matcher = on_message(rule=user_checker)
|
||||
```
|
||||
|
||||
在定义事件响应器的辅助函数中，都有一个 `rule` 参数，用于指定自定义的匹配规则。辅助函数会为你将自定义匹配规则与内置规则组合，并注册到事件响应器中。
|
||||
|
||||
## 合并匹配规则
|
||||
|
||||
在定义匹配规则时，我们往往希望将规则进行细分，来更好地复用规则。而在使用时，我们需要合并多个规则。除了使用 `Rule` 对象来组合多个 `RuleChecker` 外，我们还可以对 `Rule` 对象进行合并。
|
||||
|
||||
```python {4-6}
|
||||
rule1 = Rule(foo_checker)
|
||||
rule2 = Rule(bar_checker)
|
||||
|
||||
rule = rule1 & rule2
|
||||
rule = rule1 & bar_checker
|
||||
rule = foo_checker & rule2
|
||||
```
|
||||
|
||||
同时，你也无需担心合并了一个 `None` 值，`Rule` 会忽略 `None` 值。
|
||||
|
||||
```python
|
||||
assert (rule & None) is rule
|
||||
```
|
||||
@ -1,39 +1,28 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: 在 NoneBot2 框架中添加 Hook 函数
|
||||
sidebar_position: 8
|
||||
description: 在特定的生命周期中执行代码
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 50
|
||||
weight: 90
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 钩子函数
|
||||
|
||||
[钩子编程](https://zh.wikipedia.org/wiki/%E9%92%A9%E5%AD%90%E7%BC%96%E7%A8%8B)
|
||||
> [钩子编程](https://zh.wikipedia.org/wiki/%E9%92%A9%E5%AD%90%E7%BC%96%E7%A8%8B)（hooking），也称作“挂钩”，是计算机程序设计术语，指通过拦截软件模块间的函数调用、消息传递、事件传递来修改或扩展操作系统、应用程序或其他软件组件的行为的各种技术。处理被拦截的函数调用、事件、消息的代码，被称为钩子（hook）。
|
||||
|
||||
> 钩子编程（hooking），也称作“挂钩”，是计算机程序设计术语，指通过拦截软件模块间的函数调用、消息传递、事件传递来修改或扩展操作系统、应用程序或其他软件组件的行为的各种技术。处理被拦截的函数调用、事件、消息的代码，被称为钩子（hook）。
|
||||
|
||||
在 NoneBot2 中有一系列预定义的钩子函数，分为两类：**全局钩子函数**和**事件钩子函数**，这些钩子函数可以用装饰器的形式来使用。
|
||||
在 NoneBot 中有一系列预定义的钩子函数，可以分为两类：**全局钩子函数**和**事件处理钩子函数**，这些钩子函数可以用装饰器的形式来使用。
|
||||
|
||||
## 全局钩子函数
|
||||
|
||||
全局钩子函数是指 NoneBot2 针对其本身运行过程的钩子函数。
|
||||
全局钩子函数是指 NoneBot 针对其本身运行过程的钩子函数。
|
||||
|
||||
这些钩子函数是由其后端驱动 `Driver` 来运行的，故需要先获得全局 `Driver` 对象：
|
||||
|
||||
```python
|
||||
from nonebot import get_driver
|
||||
|
||||
|
||||
driver=get_driver()
|
||||
```
|
||||
|
||||
共分为六种函数：
|
||||
这些钩子函数是由驱动器来运行的，故需要先[获得全局驱动器](./driver.md#获取驱动器)。
|
||||
|
||||
### 启动准备
|
||||
|
||||
这个钩子函数会在 NoneBot2 启动时运行。
|
||||
这个钩子函数会在 NoneBot 启动时运行。很多时候，我们并不希望在模块被导入时就执行一些耗时操作，如：连接数据库，这时候我们可以在这个钩子函数中进行这些操作。
|
||||
|
||||
```python
|
||||
@driver.on_startup
|
||||
@ -43,7 +32,7 @@ async def do_something():
|
||||
|
||||
### 终止处理
|
||||
|
||||
这个钩子函数会在 NoneBot2 终止时运行。
|
||||
这个钩子函数会在 NoneBot 终止时运行。我们可以在这个钩子函数中进行一些清理工作，如：关闭数据库连接。
|
||||
|
||||
```python
|
||||
@driver.on_shutdown
|
||||
@ -53,7 +42,7 @@ async def do_something():
|
||||
|
||||
### Bot 连接处理
|
||||
|
||||
这个钩子函数会在 `Bot` 通过 websocket 连接到 NoneBot2 时运行。
|
||||
这个钩子函数会在任何协议适配器连接 `Bot` 对象至 NoneBot 时运行。支持依赖注入，可以直接注入 `Bot` 对象。
|
||||
|
||||
```python
|
||||
@driver.on_bot_connect
|
||||
@ -61,9 +50,9 @@ async def do_something(bot: Bot):
|
||||
pass
|
||||
```
|
||||
|
||||
### bot 断开处理
|
||||
### Bot 断开处理
|
||||
|
||||
这个钩子函数会在 `Bot` 断开与 NoneBot2 的 websocket 连接时运行。
|
||||
这个钩子函数会在 `Bot` 断开与 NoneBot 的连接时运行。支持依赖注入，可以直接注入 `Bot` 对象。
|
||||
|
||||
```python
|
||||
@driver.on_bot_disconnect
|
||||
@ -71,101 +60,82 @@ async def do_something(bot: Bot):
|
||||
pass
|
||||
```
|
||||
|
||||
### bot api 调用钩子
|
||||
## 事件处理钩子函数
|
||||
|
||||
这个钩子函数会在 `Bot` 调用 API 时运行。
|
||||
|
||||
```python
|
||||
from nonebot.adapters import Bot
|
||||
|
||||
@Bot.on_calling_api
|
||||
async def handle_api_call(bot: Bot, api: str, data: Dict[str, Any]):
|
||||
pass
|
||||
```
|
||||
|
||||
### bot api 调用后钩子
|
||||
|
||||
这个钩子函数会在 `Bot` 调用 API 后运行。
|
||||
|
||||
```python
|
||||
from nonebot.adapters import Bot
|
||||
|
||||
@Bot.on_called_api
|
||||
async def handle_api_result(bot: Bot, exception: Optional[Exception], api: str, data: Dict[str, Any], result: Any):
|
||||
pass
|
||||
```
|
||||
|
||||
## 事件钩子函数
|
||||
|
||||
这些钩子函数指的是影响 NoneBot2 进行**事件处理**的函数, 这些函数可以认为跟普通的事件处理函数一样，接受相应的参数。
|
||||
|
||||
:::tip 提示
|
||||
关于**事件处理**的流程，可以在[这里](./README.md)查阅。
|
||||
:::
|
||||
|
||||
:::warning
|
||||
|
||||
1.在事件处理钩子函数中，与 `matcher` 运行状态相关的函数将不可用，如 `matcher.finish()`
|
||||
|
||||
2.如果需要在事件处理钩子函数中打断整个对话的执行，请参考以下范例：
|
||||
|
||||
```python
|
||||
from nonebot.exception import IgnoredException
|
||||
|
||||
|
||||
@event_preprocessor
|
||||
async def do_something():
|
||||
raise IgnoredException("reason")
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
共分为四种函数：
|
||||
这些钩子函数指的是影响 NoneBot 进行**事件处理**的函数, 这些函数可以跟普通的事件处理函数一样接受相应的参数。
|
||||
|
||||
### 事件预处理
|
||||
|
||||
这个钩子函数会在 `Event` 上报到 NoneBot2 时运行
|
||||
这个钩子函数会在 NoneBot 接收到新的事件时运行。支持依赖注入，可以注入 `Bot` 对象、事件、会话状态。
|
||||
|
||||
```python
|
||||
from nonebot.message import event_preprocessor
|
||||
|
||||
@event_preprocessor
|
||||
async def do_something():
|
||||
async def do_something(event: Event):
|
||||
pass
|
||||
```
|
||||
|
||||
### 事件后处理
|
||||
|
||||
这个钩子函数会在 NoneBot2 处理 `Event` 后运行
|
||||
这个钩子函数会在 NoneBot 处理事件完成后运行。支持依赖注入，可以注入 `Bot` 对象、事件、会话状态。
|
||||
|
||||
```python
|
||||
from nonebot.message import event_postprocessor
|
||||
|
||||
@event_postprocessor
|
||||
async def do_something():
|
||||
async def do_something(event: Event):
|
||||
pass
|
||||
```
|
||||
|
||||
### 运行预处理
|
||||
|
||||
这个钩子函数会在 NoneBot2 运行 `matcher` 前运行。
|
||||
这个钩子函数会在 NoneBot 运行事件响应器前运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态。
|
||||
|
||||
```python
|
||||
from nonebot.message import run_preprocessor
|
||||
|
||||
@run_preprocessor
|
||||
async def do_something():
|
||||
async def do_something(event: Event, matcher: Matcher):
|
||||
pass
|
||||
```
|
||||
|
||||
### 运行后处理
|
||||
|
||||
这个钩子函数会在 NoneBot2 运行 `matcher` 后运行。
|
||||
这个钩子函数会在 NoneBot 运行事件响应器后运行。支持依赖注入，可以注入 `Bot` 对象、事件、事件响应器、会话状态、运行中产生的异常。
|
||||
|
||||
```python
|
||||
from nonebot.message import run_postprocessor
|
||||
|
||||
@run_postprocessor
|
||||
async def do_something():
|
||||
async def do_something(event: Event, matcher: Matcher, exception: Optional[Exception]):
|
||||
pass
|
||||
```
|
||||
|
||||
### 平台接口调用钩子
|
||||
|
||||
这个钩子函数会在 `Bot` 对象调用平台接口时运行。在这个钩子函数中，我们可以通过引起 `MockApiException` 异常来阻止 `Bot` 对象调用平台接口并返回指定的结果。
|
||||
|
||||
```python
|
||||
from nonebot.adapters import Bot
|
||||
from nonebot.exception import MockApiException
|
||||
|
||||
@Bot.on_calling_api
|
||||
async def handle_api_call(bot: Bot, api: str, data: Dict[str, Any]):
|
||||
if api == "send_msg":
|
||||
raise MockApiException(result={"message_id": 123})
|
||||
```
|
||||
|
||||
### 平台接口调用后钩子
|
||||
|
||||
这个钩子函数会在 `Bot` 对象调用平台接口后运行。在这个钩子函数中，我们可以通过引起 `MockApiException` 异常来忽略平台接口返回的结果并返回指定的结果。
|
||||
|
||||
```python
|
||||
from nonebot.adapters import Bot
|
||||
from nonebot.exception import MockApiException
|
||||
|
||||
@Bot.on_called_api
|
||||
async def handle_api_result(
|
||||
bot: Bot, exception: Optional[Exception], api: str, data: Dict[str, Any], result: Any
|
||||
):
|
||||
if not exception and api == "send_msg":
|
||||
raise MockApiException(result={**result, "message_id": 123})
|
||||
```
|
||||
|
||||
@ -1,147 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 在 NoneBot2 中使用定时任务
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 20
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 定时任务
|
||||
|
||||
[APScheduler](https://apscheduler.readthedocs.io/en/3.x/) —— Advanced Python Scheduler
|
||||
|
||||
> Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code to be executed later, either just once or periodically. You can add new jobs or remove old ones on the fly as you please. If you store your jobs in a database, they will also survive scheduler restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs it should have run while it was offline.
|
||||
|
||||
## 从 NoneBot v1 迁移
|
||||
|
||||
`APScheduler` 作为 NoneBot v1 的可选依赖，为众多 bot 提供了方便的定时任务功能。NoneBot2 已将 `APScheduler` 独立为 nonebot_plugin_apscheduler 插件，你可以在[商店](/store)中找到它。
|
||||
|
||||
相比于 NoneBot v1，NoneBot v2 只需要安装插件并修改 `scheduler` 的导入方式即可完成迁移。
|
||||
|
||||
## 安装插件
|
||||
|
||||
### 通过 nb-cli
|
||||
|
||||
如正在使用 nb-cli 构建项目，你可以从插件市场复制安装命令或手动输入以下命令以添加 nonebot_plugin_apscheduler。
|
||||
|
||||
```bash
|
||||
nb plugin install nonebot_plugin_apscheduler
|
||||
```
|
||||
|
||||
:::tip 提示
|
||||
nb-cli 默认通过 PyPI 安装，你可以添加命令参数 `-i [mirror]` 或 `--index [mirror]` 以使用镜像源安装。
|
||||
:::
|
||||
|
||||
### 通过 Poetry
|
||||
|
||||
执行以下命令以添加 nonebot_plugin_apscheduler
|
||||
|
||||
```bash
|
||||
poetry add nonebot-plugin-apscheduler
|
||||
```
|
||||
|
||||
:::tip 提示
|
||||
由于稍后我们将使用 `nonebot.require()` 方法进行声明依赖，所以无需额外的 `nonebot.load_plugin()`
|
||||
:::
|
||||
|
||||
## 快速上手
|
||||
|
||||
1. 在需要设置定时任务的插件中，通过 `nonebot.require` 声明插件依赖
|
||||
2. 从 nonebot_plugin_apscheduler 导入 `scheduler` 对象
|
||||
3. 在该对象的基础上，根据 `APScheduler` 的使用方法进一步配置定时任务
|
||||
|
||||
将上述步骤归纳为最小实现的代码如下：
|
||||
|
||||
```python {3,5}
|
||||
from nonebot import require
|
||||
|
||||
require("nonebot_plugin_apscheduler")
|
||||
|
||||
from nonebot_plugin_apscheduler import scheduler
|
||||
|
||||
@scheduler.scheduled_job("cron", hour="*/2", id="xxx", args=[1], kwargs={"arg2": 2})
|
||||
async def run_every_2_hour(arg1, arg2):
|
||||
pass
|
||||
|
||||
scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx")
|
||||
```
|
||||
|
||||
## 分步进行
|
||||
|
||||
### 导入 scheduler 对象
|
||||
|
||||
为了使插件能够实现定时任务，需要先将 `scheduler` 对象导入插件。
|
||||
|
||||
NoneBot2 提供了 `nonebot.require` 方法来实现声明插件依赖，确保 `nonebot_plugin_apscheduler` 插件可以在使用之前被导入。声明完成即可直接通过 import 导入 `scheduler` 对象。
|
||||
|
||||
NoneBot2 使用的 `scheduler` 对象为 `AsyncIOScheduler` 。
|
||||
|
||||
```python {3,5}
|
||||
from nonebot import require
|
||||
|
||||
require("nonebot_plugin_apscheduler")
|
||||
|
||||
from nonebot_plugin_apscheduler import scheduler
|
||||
```
|
||||
|
||||
### 编写定时任务
|
||||
|
||||
由于本部分为标准的通过 `APScheduler` 配置定时任务，有关指南请参阅 [APScheduler 官方文档](https://apscheduler.readthedocs.io/en/3.x/userguide.html#adding-jobs)。
|
||||
|
||||
### 配置插件选项
|
||||
|
||||
根据项目的 `.env` 文件设置，向 `.env.*` 或 `bot.py` 文件添加 nonebot_plugin_apscheduler 的可选配置项
|
||||
|
||||
:::warning 注意
|
||||
`.env.*` 文件的编写应遵循 NoneBot2 对 `.env.*` 文件的编写要求
|
||||
:::
|
||||
|
||||
#### `apscheduler_autostart`
|
||||
|
||||
类型：`bool`
|
||||
|
||||
默认值：`True`
|
||||
|
||||
是否自动启动 `APScheduler`。
|
||||
|
||||
对于大多数情况，我们需要在 NoneBot2 项目被启动时启动定时任务，则此处设为 `true`
|
||||
|
||||
##### 在 `.env` 中添加
|
||||
|
||||
```bash
|
||||
APSCHEDULER_AUTOSTART=true
|
||||
```
|
||||
|
||||
##### 在 `bot.py` 中添加
|
||||
|
||||
```python
|
||||
nonebot.init(apscheduler_autostart=True)
|
||||
```
|
||||
|
||||
#### `apscheduler_config`
|
||||
|
||||
类型：`dict`
|
||||
|
||||
默认值：`{"apscheduler.timezone": "Asia/Shanghai"}`
|
||||
|
||||
`APScheduler` 相关配置。修改/增加其中配置项需要确保 `prefix: apscheduler`。
|
||||
|
||||
对于 `APScheduler` 的相关配置，请参阅 [scheduler-config](https://apscheduler.readthedocs.io/en/3.x/userguide.html#scheduler-config) 和 [BaseScheduler](https://apscheduler.readthedocs.io/en/3.x/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)
|
||||
|
||||
> 官方文档在绝大多数时候能提供最准确和最具时效性的指南
|
||||
|
||||
##### 在 `.env` 中添加
|
||||
|
||||
```bash
|
||||
APSCHEDULER_CONFIG={"apscheduler.timezone": "Asia/Shanghai"}
|
||||
```
|
||||
|
||||
##### 在 `bot.py` 中添加
|
||||
|
||||
```python
|
||||
nonebot.init(apscheduler_config={
|
||||
"apscheduler.timezone": "Asia/Shanghai"
|
||||
})
|
||||
```
|
||||
59
website/docs/advanced/session-updating.md
Normal file
59
website/docs/advanced/session-updating.md
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: 控制会话响应对象
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 80
|
||||
category: advanced
|
||||
---
|
||||
|
||||
# 会话更新
|
||||
|
||||
在 NoneBot 中，在某个事件响应器对事件响应后，即是进入了会话状态，会话状态会持续到整个事件响应流程结束。会话过程中，机器人可以与用户进行多次交互。每次需要等待用户事件时，NoneBot 将会复制一个新的临时事件响应器，并更新该事件响应器使其响应当前会话主体的消息，这个过程称为会话更新。
|
||||
|
||||
会话更新分为两部分：**更新[事件响应器类型](./matcher.md#事件响应器类型)**和**更新[事件触发权限](./matcher.md#事件触发权限)**。
|
||||
|
||||
## 更新事件响应器类型
|
||||
|
||||
通常情况下，与机器人用户进行的会话都是通过消息事件进行的，因此会话更新后的默认响应事件类型为 `message`。如果希望接收一个特定类型的消息，比如 `notice` 等，我们需要自定义响应事件类型更新函数。响应事件类型更新函数是一个 `Dependent`，可以使用依赖注入。
|
||||
|
||||
```python {3-5}
|
||||
foo = on_message()
|
||||
|
||||
@foo.type_updater
|
||||
async def _() -> str:
|
||||
return "notice"
|
||||
```
|
||||
|
||||
在注册了上述响应事件类型更新函数后，当我们需要等待用户事件时，将只会响应 `notice` 类型的事件。如果希望在会话过程中的不同阶段响应不同类型的事件，我们就需要使用更复杂的逻辑来更新响应事件类型（如：根据会话状态），这里将不再展示。
|
||||
|
||||
## 更新事件触发权限
|
||||
|
||||
会话通常是由机器人与用户进行的一对一交互，因此会话更新后的默认触发权限为当前事件的会话 ID。这个会话 ID 由协议适配器生成，通常由用户 ID 和群 ID 等组成。如果希望实现更复杂的会话功能（如：多用户同时参与的会话），我们需要自定义触发权限更新函数。触发权限更新函数是一个 `Dependent`，可以使用依赖注入。
|
||||
|
||||
```python {5-7}
|
||||
from nonebot.permission import User
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.permission_updater
|
||||
async def _(event: Event, matcher: Matcher) -> Permission:
|
||||
return Permission(User.from_event(event, perm=matcher.permission))
|
||||
```
|
||||
|
||||
上述权限更新函数是默认的权限更新函数，它将会话的触发权限更新为当前事件的会话 ID。如果我们希望响应多个用户的消息，我们可以如下修改：
|
||||
|
||||
```python {5-7}
|
||||
from nonebot.permission import USER
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.permission_updater
|
||||
async def _(matcher: Matcher) -> Permission:
|
||||
return USER("session1", "session2", perm=matcher.permission)
|
||||
```
|
||||
|
||||
请注意，此处为全大写字母的 `USER` 权限，它可以匹配多个会话 ID。通过这种方式，我们可以实现多用户同时参与的会话。
|
||||
|
||||
我们已经了解了如何控制会话的更新，相信你已经能够实现更复杂的会话功能了，例如多人小游戏等等。欢迎将你的作品分享到[插件商店](/store)。
|
||||
@ -1,106 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 使用 NoneBug 测试机器人
|
||||
slug: /advanced/unittest/
|
||||
|
||||
options:
|
||||
menu:
|
||||
weight: 70
|
||||
category: advanced
|
||||
---
|
||||
|
||||
import CodeBlock from "@theme/CodeBlock";
|
||||
|
||||
# 单元测试
|
||||
|
||||
[单元测试](https://zh.wikipedia.org/wiki/%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95)
|
||||
|
||||
> 在计算机编程中，单元测试（Unit Testing）又称为模块测试，是针对程序模块（软件设计的最小单位）来进行正确性检验的测试工作。
|
||||
|
||||
NoneBot2 使用 [Pytest](https://docs.pytest.org) 单元测试框架搭配 [NoneBug](https://github.com/nonebot/nonebug) 插件进行单元测试，通过直接与事件响应器/适配器等交互简化测试流程，更易于编写。
|
||||
|
||||
## 安装 NoneBug
|
||||
|
||||
安装 NoneBug 时，Pytest 会作为依赖被一起安装。
|
||||
|
||||
要运行 NoneBug，还需要额外安装 Pytest 异步插件 `pytest-asyncio` 或 `anyio`，文档将以 `pytest-asyncio` 为例。
|
||||
|
||||
```bash
|
||||
poetry add nonebug pytest-asyncio --dev
|
||||
# 也可以通过 pip 安装
|
||||
pip install nonebug pytest-asyncio
|
||||
```
|
||||
|
||||
:::tip 提示
|
||||
建议首先阅读 [Pytest 文档](https://docs.pytest.org) 理解相关术语。
|
||||
:::
|
||||
|
||||
## 加载插件
|
||||
|
||||
我们可以使用 Pytest **Fixtures** 来加载插件，下面是一个示例：
|
||||
|
||||
```python title=conftest.py
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING, Set
|
||||
|
||||
import pytest
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from nonebot.plugin import Plugin
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def load_plugins(nonebug_init: None) -> Set["Plugin"]:
|
||||
import nonebot # 这里的导入必须在函数内
|
||||
|
||||
# 加载插件
|
||||
return nonebot.load_plugins("awesome_bot/plugins")
|
||||
```
|
||||
|
||||
此 Fixture 的 [`nonebug_init`](https://github.com/nonebot/nonebug/blob/master/nonebug/fixture.py) 形参也是一个 Fixture，用于初始化 NoneBug。
|
||||
|
||||
Fixture 名称 `load_plugins` 可以修改为其他名称，文档以 `load_plugins` 为例。需要加载插件时，在测试函数添加形参 `load_plugins` 即可。加载完成后即可使用 `import` 导入事件响应器。
|
||||
|
||||
## 测试流程
|
||||
|
||||
Pytest 会在函数开始前通过 Fixture `app`(nonebug_app) **初始化 NoneBug** 并返回 `App` 对象。
|
||||
|
||||
:::warning 警告
|
||||
所有从 `nonebot` 导入模块的函数都需要首先初始化 NoneBug App，否则会发生不可预料的问题。
|
||||
|
||||
在每个测试函数结束时，NoneBug 会自动销毁所有与 NoneBot 相关的资源。所有与 NoneBot 相关的 import 应在函数内进行导入。
|
||||
:::
|
||||
|
||||
随后使用 `test_matcher` 等测试方法获取到 `Context` 上下文，通过上下文管理提供的方法（如 `should_call_send` 等）预定义行为。
|
||||
|
||||
在上下文管理器关闭时，`Context` 会调用 `run_test` 方法按照预定义行为对事件响应器进行断言（如：断言事件响应和 API 调用等）。
|
||||
|
||||
## 测试样例
|
||||
|
||||
:::tip 提示
|
||||
将从 `utils` 导入的 `make_fake_message`，`make_fake_event` 替换为对应平台的消息/事件类型。
|
||||
|
||||
将 `load_example` 替换为加载插件的 Fixture 名称。
|
||||
:::
|
||||
|
||||
使用 NoneBug 的 `test_matcher` 可以模拟出一个事件流程。如下是一个简单的示例：
|
||||
|
||||
import WeatherSource from "!!raw-loader!@site/../tests/examples/weather.py";
|
||||
import WeatherTest from "!!raw-loader!@site/../tests/test_examples/test_weather.py";
|
||||
|
||||
<CodeBlock className="language-python" title="test_weather.py">
|
||||
{WeatherTest}
|
||||
</CodeBlock>
|
||||
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
<CodeBlock className="language-python" title="examples/weather.py">
|
||||
{WeatherSource}
|
||||
</CodeBlock>
|
||||
</details>
|
||||
|
||||
在测试用例编写完成后 ，可以使用下面的命令运行单元测试。
|
||||
|
||||
```bash
|
||||
pytest test_weather.py
|
||||
```
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "单元测试",
|
||||
"position": 6
|
||||
}
|
||||
@ -1,162 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: 测试适配器
|
||||
---
|
||||
|
||||
# 测试适配器
|
||||
|
||||
通常来说，测试适配器需要测试这三项。
|
||||
|
||||
1. 测试连接
|
||||
2. 测试事件转化
|
||||
3. 测试 API 调用
|
||||
|
||||
## 注册适配器
|
||||
|
||||
任何的适配器都需要注册才能起作用。
|
||||
|
||||
我们可以使用 Pytest 的 Fixtures，在测试开始前初始化 NoneBot 并**注册适配器**。
|
||||
|
||||
我们假设适配器为 `nonebot.adapters.test`。
|
||||
|
||||
```python {20,21} title=conftest.py
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
# 如果适配器采用 nonebot.adapters monospace 则需要使用此hook方法正确添加路径
|
||||
@pytest.fixture
|
||||
def import_hook():
|
||||
import nonebot.adapters
|
||||
|
||||
nonebot.adapters.__path__.append( # type: ignore
|
||||
str((Path(__file__).parent.parent / "nonebot" / "adapters").resolve())
|
||||
)
|
||||
|
||||
@pytest.fixture
|
||||
async def init_adapter(app: App, import_hook):
|
||||
import nonebot
|
||||
from nonebot.adapters.test import Adapter
|
||||
|
||||
driver = nonebot.get_driver()
|
||||
driver.register_adapter(Adapter)
|
||||
```
|
||||
|
||||
## 测试连接
|
||||
|
||||
任何的适配器的连接方式主要有以下 4 种：
|
||||
|
||||
1. 反向 HTTP（WebHook）
|
||||
2. 反向 WebSocket
|
||||
3. 正向 HTTP
|
||||
4. 正向 WebSocket
|
||||
|
||||
NoneBug 的 `test_server` 方法可以供我们测试反向连接方式。
|
||||
|
||||
`test_server` 的 `get_client` 方法可以获取 HTTP/WebSocket 客户端。
|
||||
|
||||
我们假设适配器 HTTP 上报地址为 `/test/http`，反向 WebSocket 地址为 `/test/ws`，上报机器人 ID
|
||||
使用请求头 `Bot-ID` 来演示如何通过 NoneBug 测试适配器。
|
||||
|
||||
```python {8,16,17,19-22,26,34,36-39} title=test_connection.py
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize(
|
||||
"endpoints", ["/test/http"]
|
||||
)
|
||||
async def test_http(app: App, init_adapter, endpoints: str):
|
||||
import nonebot
|
||||
|
||||
async with app.test_server() as ctx:
|
||||
client = ctx.get_client()
|
||||
|
||||
body = {"post_type": "test"}
|
||||
headers = {"Bot-ID": "test"}
|
||||
|
||||
resp = await client.post(endpoints, json=body, headers=headers)
|
||||
assert resp.status_code == 204 # 检测状态码是否正确
|
||||
bots = nonebot.get_bots()
|
||||
assert "test" in bots # 检测是否连接成功
|
||||
|
||||
@pytest.mark.asyncio
|
||||
@pytest.mark.parametrize(
|
||||
"endpoints", ["/test/ws"]
|
||||
)
|
||||
async def test_ws(app: App, init_adapter, endpoints: str):
|
||||
import nonebot
|
||||
|
||||
async with app.test_server() as ctx:
|
||||
client = ctx.get_client()
|
||||
|
||||
headers = {"Bot-ID": "test"}
|
||||
|
||||
async with client.websocket_connect(endpoints, headers=headers) as ws:
|
||||
bots = nonebot.get_bots()
|
||||
assert "test" in bots # 检测是否连接成功
|
||||
```
|
||||
|
||||
## 测试事件转化
|
||||
|
||||
事件转化就是将原始数据反序列化为 `Event` 对象的过程。
|
||||
|
||||
测试事件转化就是测试反序列化是否按照预期转化为对应 `Event` 类型。
|
||||
|
||||
下面将以 `dict_to_event` 作为反序列化方法，`type` 为 `test` 的事件类型为 `TestEvent` 来演示如何测试事件转化。
|
||||
|
||||
```python {8,9} title=test_event.py
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_event(app: App, init_adapter):
|
||||
from nonebot.adapters.test import Adapter, TestEvent
|
||||
|
||||
event = Adapter.dict_to_event({"post_type": "test"}) # 反序列化原始数据
|
||||
assert isinstance(event, TestEvent) # 断言类型是否与预期一致
|
||||
```
|
||||
|
||||
## 测试 API 调用
|
||||
|
||||
将消息序列化为原始数据并由适配器发送到协议端叫做 API 调用。
|
||||
|
||||
测试 API 调用就是调用 API 并验证返回与预期返回是否一致。
|
||||
|
||||
```python {16-18,23-32} title=test_call_api.py
|
||||
import asyncio
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_ws(app: App, init_adapter):
|
||||
import nonebot
|
||||
|
||||
async with app.test_server() as ctx:
|
||||
client = ctx.get_client()
|
||||
|
||||
headers = {"Bot-ID": "test"}
|
||||
|
||||
async def call_api():
|
||||
bot = nonebot.get_bot("test")
|
||||
return await bot.test_api()
|
||||
|
||||
async with client.websocket_connect("/test/ws", headers=headers) as ws:
|
||||
task = asyncio.create_task(call_api())
|
||||
|
||||
# received = await ws.receive_text()
|
||||
# received = await ws.receive_bytes()
|
||||
received = await ws.receive_json()
|
||||
assert received == {"action": "test_api"} # 检测调用是否与预期一致
|
||||
response = {"result": "test"}
|
||||
# await ws.send_text(...)
|
||||
# await ws.send_bytes(...)
|
||||
await ws.send_json(response, mode="bytes")
|
||||
result = await task
|
||||
assert result == response # 检测返回是否与预期一致
|
||||
```
|
||||
@ -1,122 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: 测试事件响应处理
|
||||
---
|
||||
|
||||
# 测试事件响应处理行为
|
||||
|
||||
除了 `send`，事件响应器还有其他的操作，我们也需要对它们进行测试，下面我们将定义如下事件响应器操作的预期行为对对应的事件响应器操作进行测试。
|
||||
|
||||
## should_finished
|
||||
|
||||
定义事件响应器预期结束当前事件的整个处理流程。
|
||||
|
||||
适用事件响应器操作：[`finish`](../../tutorial/plugin/matcher-operation.md#finish)。
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python title=example.py
|
||||
from nonebot import on_message
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.handle()
|
||||
async def _():
|
||||
await foo.finish("test")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {13}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_call_send(event, "test", True)
|
||||
ctx.should_finished()
|
||||
```
|
||||
|
||||
## should_paused
|
||||
|
||||
定义事件响应器预期立即结束当前事件处理依赖并等待接收一个新的事件后进入下一个事件处理依赖。
|
||||
|
||||
适用事件响应器操作：[`pause`](../../tutorial/plugin/matcher-operation.md#pause)。
|
||||
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python title=example.py
|
||||
from nonebot import on_message
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.handle()
|
||||
async def _():
|
||||
await foo.pause("test")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {13}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_call_send(event, "test", True)
|
||||
ctx.should_paused()
|
||||
```
|
||||
|
||||
## should_rejected
|
||||
|
||||
定义事件响应器预期立即结束当前事件处理依赖并等待接收一个新的事件后再次执行当前事件处理依赖。
|
||||
|
||||
适用事件响应器操作：[`reject`](../../tutorial/plugin/matcher-operation.md#reject)
|
||||
、[`reject_arg`](../../tutorial/plugin/matcher-operation.md#reject_arg)
|
||||
和 [`reject_receive`](../../tutorial/plugin/matcher-operation.md#reject_receive)。
|
||||
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python title=example.py
|
||||
from nonebot import on_message
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.got("key")
|
||||
async def _():
|
||||
await foo.reject("test")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {13}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_call_send(event, "test", True)
|
||||
ctx.should_rejected()
|
||||
```
|
||||
@ -1,159 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: 测试事件响应和 API 调用
|
||||
---
|
||||
|
||||
# 测试事件响应和 API 调用
|
||||
|
||||
事件响应器通过 `Rule` 和 `Permission` 来判断当前事件是否触发事件响应器，通过 `send` 发送消息或使用 `call_api` 调用平台 API，这里我们将对上述行为进行测试。
|
||||
|
||||
## 定义预期响应行为
|
||||
|
||||
NoneBug 提供了六种定义 `Rule` 和 `Permission` 的预期行为的方法来进行测试：
|
||||
|
||||
- `should_pass_rule`
|
||||
- `should_not_pass_rule`
|
||||
- `should_ignore_rule`
|
||||
- `should_pass_permission`
|
||||
- `should_not_pass_permission`
|
||||
- `should_ignore_permission`
|
||||
|
||||
以下为示例代码
|
||||
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python title=example.py
|
||||
from nonebot import on_message
|
||||
|
||||
async def always_pass():
|
||||
return True
|
||||
|
||||
async def never_pass():
|
||||
return False
|
||||
|
||||
foo = on_message(always_pass)
|
||||
bar = on_message(never_pass, permission=never_pass)
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {12,13,19,20,27,28}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo, bar
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_pass_rule()
|
||||
ctx.should_pass_permission()
|
||||
|
||||
async with app.test_matcher(bar) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_not_pass_rule()
|
||||
ctx.should_not_pass_permission()
|
||||
|
||||
# 如需忽略规则/权限不通过
|
||||
async with app.test_matcher(bar) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_ignore_rule()
|
||||
ctx.should_ignore_permission()
|
||||
```
|
||||
|
||||
## 定义预期 API 调用行为
|
||||
|
||||
在[事件响应器操作](../../tutorial/plugin/matcher-operation.md)和[调用平台 API](../../tutorial/call-api.md) 中，我们已经了解如何向发送消息或调用平台 `API`。接下来对 [`send`](../../tutorial/plugin/matcher-operation.md#send) 和 [`call_api`](../../api/adapters/index.md#Bot-call_api) 进行测试。
|
||||
|
||||
### should_call_send
|
||||
|
||||
定义事件响应器预期发送消息，包括使用 [`send`](../../tutorial/plugin/matcher-operation.md#send)、[`finish`](../../tutorial/plugin/matcher-operation.md#finish)、[`pause`](../../tutorial/plugin/matcher-operation.md#pause)、[`reject`](../../tutorial/plugin/matcher-operation.md#reject) 以及 [`got`](../../tutorial/plugin/create-handler.md#使用-got-装饰器) 的 prompt 等方法发送的消息。
|
||||
|
||||
`should_call_send` 需要提供四个参数：
|
||||
|
||||
- `event`：事件对象。
|
||||
- `message`：预期的消息对象，可以是`str`、[`Message`](../../api/adapters/index.md#Message) 或 [`MessageSegment`](../../api/adapters/index.md#MessageSegment)。
|
||||
- `result`：`send` 的返回值，将会返回给插件。
|
||||
- `**kwargs`：`send` 方法的额外参数。
|
||||
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python title=example.py
|
||||
from nonebot import on_message
|
||||
|
||||
foo = on_message()
|
||||
|
||||
@foo.handle()
|
||||
async def _():
|
||||
await foo.send("test")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {12}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_call_send(event, "test", True)
|
||||
```
|
||||
|
||||
### should_call_api
|
||||
|
||||
定义事件响应器预期调用机器人 API 接口，包括使用 `call_api` 或者直接使用 `bot.some_api` 的方式调用 API。
|
||||
|
||||
`should_call_api` 需要提供四个参数：
|
||||
|
||||
- `api`：API 名称。
|
||||
- `data`：预期的请求数据。
|
||||
- `result`：`call_api` 的返回值，将会返回给插件。
|
||||
- `**kwargs`：`call_api` 方法的额外参数。
|
||||
|
||||
<details>
|
||||
<summary>示例插件</summary>
|
||||
|
||||
```python
|
||||
from nonebot import on_message
|
||||
from nonebot.adapters import Bot
|
||||
|
||||
foo = on_message()
|
||||
|
||||
|
||||
@foo.handle()
|
||||
async def _(bot: Bot):
|
||||
await bot.example_api(test="test")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
```python {12}
|
||||
import pytest
|
||||
from nonebug import App
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_matcher(app: App, load_plugins):
|
||||
from awesome_bot.plugins.example import foo
|
||||
|
||||
async with app.test_matcher(foo) as ctx:
|
||||
bot = ctx.create_bot()
|
||||
event = make_fake_event()() # 此处替换为平台事件
|
||||
ctx.receive_event(bot, event)
|
||||
ctx.should_call_api("example_api", {"test": "test"}, True)
|
||||
```
|
||||
Reference in New Issue
Block a user