nonebot2/docs/api/exception.md

118 lines
1.7 KiB
Markdown
Raw Normal View History

2020-08-20 15:07:05 +08:00
# NoneBot.exception 模块
## 异常
下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
这些异常并非所有需要用户处理,在 NoneBot 内部运行时被捕获,并进行对应操作。
## _exception_ `IgnoredException`
基类:`Exception`
* **说明**
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
* **参数**
* `reason`: 忽略事件的原因
## _exception_ `PausedException`
基类:`Exception`
* **说明**
指示 NoneBot 结束当前 Handler 并等待下一条消息后继续下一个 Handler。
可用于用户输入新信息。
* **用法**
可以在 Handler 中通过 Matcher.pause() 抛出。
## _exception_ `RejectedException`
基类:`Exception`
* **说明**
指示 NoneBot 结束当前 Handler 并等待下一条消息后重新运行当前 Handler。
可用于用户重新输入。
* **用法**
可以在 Handler 中通过 Matcher.reject() 抛出。
## _exception_ `FinishedException`
基类:`Exception`
* **说明**
指示 NoneBot 结束当前 Handler 且后续 Handler 不再被运行。
可用于结束用户会话。
* **用法**
可以在 Handler 中通过 Matcher.finish() 抛出。
## _exception_ `ApiNotAvailable`
基类:`Exception`
* **说明**
在 API 连接不可用时抛出。
## _exception_ `NetworkError`
基类:`Exception`
* **说明**
在网络出现问题时抛出,如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
## _exception_ `ActionFailed`
基类:`Exception`
* **说明**
API 请求成功返回数据,但 API 操作失败。
* **参数**
* `retcode`: 错误代码