例外情况¶

sanic.errorpages¶

Sanic provides a pattern 用于在发生异常时提供响应。但是，如果不处理异常，它将提供后备。有三种回退类型：

Html- default
文本
JSON

设置 app.config.FALLBACK_ERROR_FORMAT = "auto" 将启用尝试根据请求类型提供适当响应格式的交换机。

class sanic.errorpages.BaseRenderer(request, exception, debug)¶

基类：object

所有呈现器都必须继承的基类。

此类定义了呈现对象的结构，处理特定呈现器可能扩展的核心功能。

属性：: REQUEST(请求)：需要呈现的传入请求对象。异常(Exeption)：发生并需要呈现的任何异常。调试(Bool)：指示是否使用调试信息呈现的标志。
方法：: 转储：必须由子类覆盖以定义特定呈现的静态方法。
参数：: REQUEST(请求)：需要呈现的传入请求对象。异常(Exeption)：发生并需要呈现的任何异常。调试(Bool)：指示是否使用调试信息呈现的标志。

static dumps()¶: 以递归方式将任意对象转换为JSON。使用Enure_ascii=FALSE输出UTF-8。设置encode_html_chars=True将<>编码为Unicode转义序列。设置ESCAPE_FORWARD_SLASS=FALSE可防止转义/字符。设置ALLOW_NAN=FALSE可在序列化NaN或Infinity时引发异常。设置REJECT_BYTES=True可按字节引发TypeError。

full()¶

提供格式化的消息，该消息包含所有详细信息，主要用于调试和非生产环境。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

minimal()¶

提供格式化的邮件，不显示任何敏感数据或详细信息。

这是生产环境的默认备用设置。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

render()¶

将异常作为响应输出。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

property headers¶: 要用于响应的标头。

property status¶: 要用于响应的状态代码。

property text¶: 要用于响应的文本。

property title¶: 要用于响应的标题。

class sanic.errorpages.HTMLRenderer(request, exception, debug)¶

基类：sanic.errorpages.BaseRenderer

将异常呈现为HTML。

默认的回退类型。

full()¶

提供格式化的消息，该消息包含所有详细信息，主要用于调试和非生产环境。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

minimal()¶

提供格式化的邮件，不显示任何敏感数据或详细信息。

这是生产环境的默认备用设置。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

class sanic.errorpages.JSONRenderer(request, exception, debug)¶

基类：sanic.errorpages.BaseRenderer

将异常呈现为JSON。

full()¶

提供格式化的消息，该消息包含所有详细信息，主要用于调试和非生产环境。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

minimal()¶

提供格式化的邮件，不显示任何敏感数据或详细信息。

这是生产环境的默认备用设置。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

property title¶: 要用于响应的标题。

class sanic.errorpages.TextRenderer(request, exception, debug)¶

基类：sanic.errorpages.BaseRenderer

以纯文本形式呈现异常。

full()¶

提供格式化的消息，该消息包含所有详细信息，主要用于调试和非生产环境。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

minimal()¶

提供格式化的邮件，不显示任何敏感数据或详细信息。

这是生产环境的默认备用设置。

返回：: HTTPResponse：响应对象。

返回类型:: HTTPResponse

property title¶: 要用于响应的标题。

sanic.errorpages.check_error_format(format)¶: 检查是否知道格式。

sanic.errorpages.escape(text)¶: 最小的HTML转义，不适用于属性值(不同于html.ESCRIPE)。

sanic.errorpages.exception_response(request, exception, debug, fallback, base, renderer=None)¶

为默认的回退异常处理程序呈现响应。

参数:

request (Request) --
exception (Exception) --
debug (bool) --
fallback (str) --
base (t.Type[BaseRenderer]) --
renderer (t.Optional[t.Type[BaseRenderer]]) --

返回类型:

HTTPResponse

sanic.errorpages.guess_mime(req, fallback)¶

根据请求猜测响应的MIME类型。

参数:

req (Request) --
fallback (str) --

返回类型:

str

sanic.exceptions¶

exception sanic.exceptions.BadRequest(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

400坏请求

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

sanic.exceptions.BadURL¶: sanic.exceptions.BadRequest 的别名

sanic.exceptions.ContentRangeError¶: sanic.exceptions.RangeNotSatisfiable 的别名

exception sanic.exceptions.ExpectationFailed(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

417期望落空

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.FileNotFound(message=None, path=None, relative_url=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.NotFound

404未找到

一种特定形式的 NotFound 尤其是在文件系统上以已知路径查找文件时。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 然后，将发送HTTP状态“未找到”。默认为 None 。
路径(可选 [PathLike] ，可选)：文件的路径(如果有的话): 被找到。默认为 None 。

相对url(可选 [str] ，可选)：文件的相对URL。默认为 None 。静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制

从日志中找到的。默认为 None 。

上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
path (Optional[os.PathLike, None]) --
relative_url (Optional[str, None]) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

exception sanic.exceptions.Forbidden(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

403禁止

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.HTTPException(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.SanicException

其他异常的基类，不应直接调用。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

sanic.exceptions.HeaderExpectationFailed¶: sanic.exceptions.ExpectationFailed 的别名

exception sanic.exceptions.HeaderNotFound(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.BadRequest

400坏请求

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

sanic.exceptions.InternalServerError¶: sanic.exceptions.ServerError 的别名

exception sanic.exceptions.InvalidHeader(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.BadRequest

400坏请求

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.InvalidRangeType(message=None, content_range=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.RangeNotSatisfiable

416范围不能满足

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
content_range (Optional[sanic.models.protocol_types.Range, None]) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

exception sanic.exceptions.InvalidSignal(message=None, status_code=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.SanicException

发送无效信号时引发异常。

参数:

message (str) --
status_code (int) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

sanic.exceptions.InvalidUsage¶: sanic.exceptions.BadRequest 的别名

exception sanic.exceptions.LoadFileException(message=None, status_code=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.SanicException

无法加载文件时引发异常。

参数:

message (str) --
status_code (int) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.MethodNotAllowed(message=None, method='', allowed_methods=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

不允许使用405方法

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“不允许使用该方法”。默认为 None 。

方法(可选 [str] ，可选)：使用的HTTP方法。默认为空字符串。允许的方法(可选 [Sequence[str] ]，可选)：可以用来代替

有人试图这样做。

静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
method (str) --
allowed_methods (Optional[Sequence[str], None]) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

sanic.exceptions.MethodNotSupported¶: sanic.exceptions.MethodNotAllowed 的别名

exception sanic.exceptions.NotFound(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

其他异常的基类，不应直接调用。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None ，: 则将使用适当的HTTP响应状态消息。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，将从日志中抑制错误回溯。: 默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.PayloadTooLarge(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

413有效载荷太大

这是Sanic引发的内部异常，不应直接使用。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.PyFileError(file, status_code=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.SanicException

参数:

status_code (int) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

exception sanic.exceptions.RangeNotSatisfiable(message=None, content_range=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

416范围不能满足

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 然后，将发送HTTP状态“Range Not Sritable”(范围不可满足)。默认为 None 。
Content_Range(可选 [ContentRange] ，可选)：符合 ContentRange 协议: 它有一个 total 财产。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
content_range (Optional[sanic.models.protocol_types.Range, None]) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

exception sanic.exceptions.RequestCancelled¶: 基类：asyncio.exceptions.CancelledError

exception sanic.exceptions.RequestTimeout(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

408请求超时

Web服务器（运行网站）认为在1）客户端和服务器之间建立IP连接（套接字）和2）在该套接字上接收到任何数据之间的时间间隔太长，因此服务器已断开连接。套接字连接实际上已丢失-Web服务器已在该特定套接字连接上“超时”。

这是Sanic引发的内部异常，不应直接使用。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.SanicException(message=None, status_code=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：Exception

在请求生命周期的上下文中引发时将生成HTTP响应的通用异常。

通常，最佳实践是使用比此通用异常更具体的异常之一。即使在试图筹集500分的时候，通常情况下也更可取的是使用 ServerError 。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None ，: 则将使用适当的HTTP响应状态消息。默认为 None 。
STATUS_CODE(可选 [int] ，可选)：要发送的HTTP响应代码(如果适用)。如果 None ，: 那就是500美元了。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，将从日志中抑制错误回溯。: 默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

例如：

``` PYTHON引发SanicException(

“出现问题”，STATUS_CODE=999，CONTEXT={

“Info”：“要发送给客户端的一些其他详细信息”，

}，标头={

“X-foo”：“bar”

}

参数:

message (str) --
status_code (int) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.ServerError(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

500内部服务器错误

出现一般服务器端错误。如果没有合适的其他HTTP异常，则应使用

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.ServerKilled¶

基类：Exception

异常Sanic服务器在因发生意外情况而终止服务器进程时使用。

exception sanic.exceptions.ServiceUnavailable(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

503服务不可用

服务器当前不可用（因为它因维护而过载或停机）。一般来说，这是一种临时状态。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.URLBuildError(message=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.HTTPException

500内部服务器错误

无法构建URL时由Sanic内部使用的异常。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。
静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制: 从日志中找到的。默认为 None 。
上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。

参数:

message (str) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None

exception sanic.exceptions.Unauthorized(message=None, scheme=None, *, quiet=None, context=None, extra=None, headers=None, **challenges)¶

基类：sanic.exceptions.HTTPException

Status ：401未经授权

如果存在，则可以使用其他关键字参数来完成WWW-身份验证头。

参数：

消息(可选 [Union[str, bytes] ]，可选)：要发送给客户端的消息。如果 None: 则将发送HTTP状态“Bad Request”。默认为 None 。

方案(可选 [str] ，可选)：要使用的身份验证方案的名称。默认为 None 。静音(可选 [bool] ，可选)：何时 True ，错误回溯将被抑制

从日志中找到的。默认为 None 。

上下文(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在出现异常时发送给客户端。默认为 None 。
额外(可选 [Dict[str, Any] ]，可选)：键/值数据的其他映射: 在生产模式下发送给客户端。默认为 None 。
页眉(可选 [Dict[str, Any] ]，可选)：应与HTTP一起发送的其他标头: 回应。默认为 None 。
**挑战(判决 [str, Any] )：其他关键字参数将用于完成: WWW-身份验证头。默认为 None 。

例如：

使用基本身份验证方案时，域必须存在： ``` 未经授权的Python引发(

“需要身份验证。”，方案=“基本”，领域=“受限区域”

有了摘要身份验证方案，事情就稍微复杂了一些： ``` 未经授权的Python引发(

“需要身份验证。”，方案=“摘要”，领域=“受限区域”，QOP=“身份验证，身份验证-INT”，算法=“MD5”，NONCE=“ABCDEF”，OPAQUE=“zyxwvu”

使用不记名身份验证方案时，域是可选的，因此您可以编写： ``python raise Unauthorized("Auth required.", scheme="Bearer") ` `

或者，如果要指定领域： ``` 未经授权的Python引发(

“需要身份验证。”，方案=“承载”，领域=“受限区域”

参数:

message (str) --
scheme (Optional[str, None]) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

exception sanic.exceptions.WebsocketClosed(message=None, status_code=None, *, quiet=None, context=None, extra=None, headers=None)¶

基类：sanic.exceptions.SanicException

关闭WebSocket时引发异常。

参数:

message (str) --
status_code (int) --
quiet (Optional[bool, None]) --
context (Optional[Dict[str, Any], None]) --
extra (Optional[Dict[str, Any], None]) --
headers (Dict[str, str]) --

返回类型:

None