nonebot2/docs/api/exception.md

190 lines
2.8 KiB
Markdown
Raw Normal View History

2020-08-23 17:03:59 +08:00
---
contentSidebar: true
sidebarDepth: 0
---
2020-08-20 15:07:05 +08:00
# NoneBot.exception 模块
## 异常
下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
这些异常并非所有需要用户处理,在 NoneBot 内部运行时被捕获,并进行对应操作。
2020-12-03 13:23:47 +08:00
## _exception_ `NoneBotException`
2020-08-20 15:07:05 +08:00
基类:`Exception`
2020-12-03 13:23:47 +08:00
* **说明**
所有 NoneBot 发生的异常基类。
## _exception_ `IgnoredException`
基类:`nonebot.exception.NoneBotException`
2020-08-20 15:07:05 +08:00
* **说明**
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
* **参数**
* `reason`: 忽略事件的原因
## _exception_ `PausedException`
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-08-20 15:07:05 +08:00
* **说明**
2020-08-22 14:11:04 +08:00
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`
2020-08-20 15:07:05 +08:00
可用于用户输入新信息。
* **用法**
2020-08-22 14:11:04 +08:00
可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
2020-08-20 15:07:05 +08:00
## _exception_ `RejectedException`
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-08-20 15:07:05 +08:00
* **说明**
2020-08-22 14:11:04 +08:00
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`
2020-08-20 15:07:05 +08:00
可用于用户重新输入。
* **用法**
2020-08-22 14:11:04 +08:00
可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
2020-08-20 15:07:05 +08:00
## _exception_ `FinishedException`
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-08-20 15:07:05 +08:00
* **说明**
2020-08-22 14:11:04 +08:00
指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
2020-08-20 15:07:05 +08:00
可用于结束用户会话。
* **用法**
2020-08-22 14:11:04 +08:00
可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
## _exception_ `StopPropagation`
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-08-22 14:11:04 +08:00
* **说明**
指示 NoneBot 终止事件向下层传播。
* **用法**
`Matcher.block == True` 时抛出。
2020-08-20 15:07:05 +08:00
2020-11-13 01:46:26 +08:00
## _exception_ `RequestDenied`
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-11-13 01:46:26 +08:00
* **说明**
Bot 连接请求不合法。
* **参数**
* `status_code: int`: HTTP 状态码
* `reason: str`: 拒绝原因
2020-12-03 13:23:47 +08:00
## _exception_ `AdapterException`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.NoneBotException`
2020-08-20 15:07:05 +08:00
* **说明**
2020-12-03 13:23:47 +08:00
代表 `Adapter` 抛出的异常,所有的 `Adapter` 都要在内部继承自这个 `Exception`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
* **参数**
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
* `adapter_name: str`: 标识 adapter
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
## _exception_ `ApiNotAvailable`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.AdapterException`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
* **说明**
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
在 API 连接不可用时抛出。
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
## _exception_ `NetworkError`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.AdapterException`
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
* **说明**
2020-08-20 15:07:05 +08:00
2020-12-03 13:23:47 +08:00
在网络出现问题时抛出,如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
2020-12-03 01:04:45 +08:00
2020-12-03 13:23:47 +08:00
## _exception_ `ActionFailed`
2020-12-03 01:04:45 +08:00
2020-12-03 13:23:47 +08:00
基类:`nonebot.exception.AdapterException`
2020-12-03 12:09:54 +08:00
* **说明**
2020-12-03 13:23:47 +08:00
API 请求成功返回数据,但 API 操作失败。
2020-12-03 12:09:54 +08:00
* **参数**
2020-12-03 13:23:47 +08:00
* `retcode: Optional[int]`: 错误代码