nonebot2/archive/2.0.0a2/api/exception.md
2020-10-01 00:55:03 +08:00

2.1 KiB

contentSidebar sidebarDepth
true 0

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 ExpiredException

基类:Exception

  • 说明

    指示 NoneBot 当前 Matcher 已失效。

  • 用法

    Matcher 运行前检查时抛出。

exception StopPropagation

基类:Exception

  • 说明

    指示 NoneBot 终止事件向下层传播。

  • 用法

    Matcher.block == True 时抛出。

exception ApiNotAvailable

基类:Exception

  • 说明

    在 API 连接不可用时抛出。

exception NetworkError

基类:Exception

  • 说明

    在网络出现问题时抛出,如: API 请求地址不正确, API 请求无返回或返回状态非正常等。

exception ActionFailed

基类:Exception

  • 说明

    API 请求成功返回数据,但 API 操作失败。

  • 参数

    • retcode: 错误代码