删除说明前缀

This commit is contained in:
hemengyang
2022-01-12 18:16:05 +08:00
parent 0e11959347
commit 0099364838
25 changed files with 226 additions and 568 deletions

View File

@ -13,18 +13,14 @@ from pydantic.fields import ModelField
class NoneBotException(Exception):
"""
:说明:
所有 NoneBot 发生的异常基类。
所有 NoneBot 发生的异常基类。
"""
# Rule Exception
class ParserExit(NoneBotException):
"""
:说明:
``shell command`` 处理消息失败时返回的异常
``shell command`` 处理消息失败时返回的异常
:参数:
@ -46,17 +42,13 @@ class ParserExit(NoneBotException):
# Processor Exception
class ProcessException(NoneBotException):
"""
:说明:
事件处理过程中发生的异常基类。
事件处理过程中发生的异常基类。
"""
class IgnoredException(ProcessException):
"""
:说明:
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
:参数:
@ -75,9 +67,7 @@ class IgnoredException(ProcessException):
class MockApiException(ProcessException):
"""
:说明:
指示 NoneBot 阻止本次 API 调用或修改本次调用返回值,并返回自定义内容。可由 api hook 抛出。
指示 NoneBot 阻止本次 API 调用或修改本次调用返回值,并返回自定义内容。可由 api hook 抛出。
:参数:
@ -96,9 +86,7 @@ class MockApiException(ProcessException):
class StopPropagation(ProcessException):
"""
:说明:
指示 NoneBot 终止事件向下层传播。
指示 NoneBot 终止事件向下层传播。
:用法:
@ -109,17 +97,13 @@ class StopPropagation(ProcessException):
# Matcher Exceptions
class MatcherException(NoneBotException):
"""
:说明:
所有 Matcher 发生的异常基类。
所有 Matcher 发生的异常基类。
"""
class SkippedException(MatcherException):
"""
:说明:
指示 NoneBot 立即结束当前 ``Handler`` 的处理,继续处理下一个 ``Handler``。
指示 NoneBot 立即结束当前 ``Handler`` 的处理,继续处理下一个 ``Handler``。
:用法:
@ -129,9 +113,7 @@ class SkippedException(MatcherException):
class TypeMisMatch(SkippedException):
"""
:说明:
当前 ``Handler`` 的参数类型不匹配。
当前 ``Handler`` 的参数类型不匹配。
"""
def __init__(self, param: ModelField, value: Any):
@ -147,9 +129,7 @@ class TypeMisMatch(SkippedException):
class PausedException(MatcherException):
"""
:说明:
指示 NoneBot 结束当前 ``Handler`` 并等待下一条消息后继续下一个 ``Handler``。
指示 NoneBot 结束当前 ``Handler`` 并等待下一条消息后继续下一个 ``Handler``。
可用于用户输入新信息。
:用法:
@ -160,9 +140,7 @@ class PausedException(MatcherException):
class RejectedException(MatcherException):
"""
:说明:
指示 NoneBot 结束当前 ``Handler`` 并等待下一条消息后重新运行当前 ``Handler``。
指示 NoneBot 结束当前 ``Handler`` 并等待下一条消息后重新运行当前 ``Handler``。
可用于用户重新输入。
:用法:
@ -173,9 +151,7 @@ class RejectedException(MatcherException):
class FinishedException(MatcherException):
"""
:说明:
指示 NoneBot 结束当前 ``Handler`` 且后续 ``Handler`` 不再被运行。
指示 NoneBot 结束当前 ``Handler`` 且后续 ``Handler`` 不再被运行。
可用于结束用户会话。
:用法:
@ -187,9 +163,7 @@ class FinishedException(MatcherException):
# Adapter Exceptions
class AdapterException(NoneBotException):
"""
:说明:
代表 ``Adapter`` 抛出的异常,所有的 ``Adapter`` 都要在内部继承自这个 ``Exception``
代表 ``Adapter`` 抛出的异常,所有的 ``Adapter`` 都要在内部继承自这个 ``Exception``
:参数:
@ -202,9 +176,7 @@ class AdapterException(NoneBotException):
class NoLogException(AdapterException):
"""
:说明:
指示 NoneBot 对当前 ``Event`` 进行处理但不显示 Log 信息,可在 ``get_log_string`` 时抛出
指示 NoneBot 对当前 ``Event`` 进行处理但不显示 Log 信息,可在 ``get_log_string`` 时抛出
"""
pass
@ -212,9 +184,7 @@ class NoLogException(AdapterException):
class ApiNotAvailable(AdapterException):
"""
:说明:
在 API 连接不可用时抛出。
在 API 连接不可用时抛出。
"""
pass
@ -222,9 +192,7 @@ class ApiNotAvailable(AdapterException):
class NetworkError(AdapterException):
"""
:说明:
在网络出现问题时抛出,如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
在网络出现问题时抛出,如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
"""
pass
@ -232,9 +200,7 @@ class NetworkError(AdapterException):
class ActionFailed(AdapterException):
"""
:说明:
API 请求成功返回数据,但 API 操作失败。
API 请求成功返回数据,但 API 操作失败。
"""
pass
@ -243,17 +209,13 @@ class ActionFailed(AdapterException):
# Driver Exceptions
class DriverException(NoneBotException):
"""
:说明:
``Driver`` 抛出的异常基类
``Driver`` 抛出的异常基类
"""
class WebSocketClosed(DriverException):
"""
:说明:
WebSocket 连接已关闭
WebSocket 连接已关闭
"""
def __init__(self, code: int, reason: Optional[str] = None):