Исключения HTTP

Реализует ряд исключений Python, которые могут быть подняты из представления для запуска стандартного HTTP ответа, отличного от 200.

Пример использования

from werkzeug.wrappers.request import Request
from werkzeug.exceptions import HTTPException, NotFound

def view(request):
    raise NotFound()

@Request.application
def application(request):
    try:
        return view(request)
    except HTTPException as e:
        return e

Как видно из этого примера, эти исключения являются вызываемыми WSGI приложениями. Однако они не являются объектами ответа Werkzeug. Вы можете получить объект ответа, вызвав get_response() для исключения HTTP.

Помните, что вам может потребоваться передать среду (WSGI) или область (ASGI) в get_response(), так как некоторые ошибки извлекают дополнительную информацию, относящуюся к запросу.

Если вы хотите подключить другую страницу обработки исключений, например, для кода состояния 404, вы можете добавить второй блок except для конкретного подкласса ошибки:

@Request.application
def application(request):
    try:
        return view(request)
    except NotFound as e:
        return not_found(request)
    except HTTPException as e:
        return e

Классы ошибок

В Werkzeug существуют следующие классы ошибок:

exception werkzeug.exceptions.BadRequest(description=None, response=None)

400 Bad Request

Вызывается, если браузер отправляет что-то приложению или серверу, с чем приложение или сервер не могут справиться.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.Unauthorized(description=None, response=None, www_authenticate=None)

401 Unauthorized

Вызывается, если пользователь не авторизован для доступа к ресурсу.

Аргумент www_authenticate должен использоваться для установки заголовка WWW-Authenticate. Это используется для HTTP basic auth и других схем. Используйте WWWAuthenticate для создания правильно отформатированных значений. Строго говоря, ответ 401 некорректен, если он не предоставляет хотя бы одно значение для этого заголовка, хотя реальные клиенты обычно не обращают на это внимания.

Параметры

description (Необязательно[str]) – Переопределяет значение сообщения по умолчанию, используемого для тела ответа.
www-authenticate – Одно значение или список значений для заголовка(ов) WWW-Authenticate.
response (Необязательно[Response]) –
www_authenticate (Необязательно[Union[WWWAuthenticate, Iterable[WWWAuthenticate]]]) –

Тип возвращаемого значения

Изменено в версии 2.0: Сериализует несколько элементов www_authenticate в несколько заголовков WWW-Authenticate, а не объединяет их в одно значение для лучшей совместимости.

Изменения

Изменено в версии 0.15.3: Если аргумент www_authenticate не задан, заголовок WWW-Authenticate не устанавливается.

Изменено в версии 0.15.3: Аргумент response был восстановлен.

Изменено в версии 0.15.1: description был возвращен на первое место, восстанавливая его предыдущее положение.

Изменено в версии 0.15.0: www_authenticate был добавлен в качестве первого аргумента, перед description.

exception werkzeug.exceptions.Forbidden(description=None, response=None)

403 Forbidden

Вызывается, если у пользователя нет разрешения на запрашиваемый ресурс, но он был авторизован.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.NotFound(description=None, response=None)

404 Not Found

Вызывается, если ресурс не существует и никогда не существовал.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.MethodNotAllowed(valid_methods=None, description=None, response=None)

405 Method Not Allowed

Вызывается, если сервер использовал метод, который не обрабатывается ресурсом. Например, POST, если ресурс только для просмотра. Особенно полезно для REST.

Первый аргумент для этой исключительной ситуации должен быть списком разрешенных методов. Строго говоря, ответ был бы некорректным, если бы вы не предоставили действительные методы в заголовке, что вы можете сделать с помощью этого списка.

Принимает необязательный список допустимых http-методов, начиная с werkzeug 0.3, этот список будет обязательным.

Параметры

valid_methods (Необязательно[Iterable[str]]) –
description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.NotAcceptable(description=None, response=None)

406 Not Acceptable

Вызывается, если сервер не может вернуть какой-либо контент, соответствующий заголовкам Accept клиента.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.RequestTimeout(description=None, response=None)

408 Request Timeout

Вызывается для сигнализации о таймауте.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.Conflict(description=None, response=None)

409 Conflict

Вызывается, чтобы указать, что запрос не может быть завершен, так как он конфликтует с текущим состоянием на сервере.

Изменения

Новое в версии 0.7.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.Gone(description=None, response=None)

410 Gone

Вызвать, если ресурс существовал ранее и исчез без нового местоположения.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.LengthRequired(description=None, response=None)

411 Length Required

Вызвать, если браузер отправил данные, но не указан заголовок Content-Length, необходимый для обработки сервером.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.PreconditionFailed(description=None, response=None)

412 Precondition Failed

Код состояния, используемый в сочетании с If-Match, If-None-Match, или If-Unmodified-Since.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.RequestEntityTooLarge(description=None, response=None)

413 Request Entity Too Large

Код состояния, который следует вернуть, если отправленные данные превысили заданный лимит.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.RequestURITooLarge(description=None, response=None)

414 Request URI Too Large

Аналогично 413, но для слишком длинных URL.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.UnsupportedMediaType(description=None, response=None)

415 Unsupported Media Type

Код состояния, возвращаемый, если сервер не может обработать тип носителя, переданный клиентом.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.RequestedRangeNotSatisfiable(length=None, units='bytes', description=None, response=None)

416 Requested Range Not Satisfiable

Клиент запросил неверную часть файла.

Changelog

Добавлено в версии 0.7.

Принимает необязательное значение заголовка Content-Range на основе параметра length.

Параметры

length (Optional[int]) –
units (str) –
description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.ExpectationFailed(description=None, response=None)

417 Expectation Failed

Сервер не может выполнить требования заголовка Expect запроса.

Changelog

Добавлено в версии 0.7.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.ImATeapot(description=None, response=None)

418 I’m a teapot

Сервер должен вернуть это, если это чайник, и кто-то пытался сварить кофе с его помощью.

Changelog

Добавлено в версии 0.7.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.UnprocessableEntity(description=None, response=None)

422 Unprocessable Entity

Используется, если запрос правильно составлен, но инструкция в противном случае неверна.

Параметры

description (Optional[str]) –
response (Optional[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.Locked(description=None, response=None)

423 Locked

Используется, если ресурс, к которому происходит доступ, заблокирован.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.FailedDependency(description=None, response=None)

424 Failed Dependency

Используется, если метод не смог быть выполнен над ресурсом, потому что запрошенное действие зависело от другого действия, которое не удалось выполнить.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.PreconditionRequired(description=None, response=None)

428 Precondition Required

Сервер требует, чтобы этот запрос был условным, обычно для предотвращения проблемы потерянного обновления, которая представляет собой состояние гонки между двумя или более клиентами, пытающимися обновить ресурс с помощью PUT или DELETE. Требуя от каждого клиента включить условный заголовок («If-Match» или «If-Unmodified-Since») со значением, сохраненным из недавнего запроса GET, сервер гарантирует, что каждый клиент, по крайней мере, видел предыдущую версию ресурса.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.TooManyRequests(description=None, response=None, retry_after=None)

429 Too Many Requests

Сервер ограничивает скорость, с которой этот пользователь получает ответы, а этот запрос превышает эту скорость. (Сервер может использовать любой удобный метод для идентификации пользователей и их скорости запросов). Сервер может включать заголовок «Retry-After», чтобы указать, сколько времени пользователю следует подождать перед повторной попыткой.

Параметры

retry_after (Необязательно[Union[datetime.datetime, int]]) – Если задано, установите заголовок Retry-After в это значение. Может быть целым числом int секунд или datetime.
description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

Журнал изменений

Изменено в версии 1.0: Добавлен параметр retry_after.

exception werkzeug.exceptions.RequestHeaderFieldsTooLarge(description=None, response=None)

431 Request Header Fields Too Large

Сервер отказывается обрабатывать запрос, потому что заголовки слишком велики. Один или несколько отдельных заголовков могут быть слишком большими, или набор всех заголовков слишком большой.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.UnavailableForLegalReasons(description=None, response=None)

451 Unavailable For Legal Reasons

Этот код состояния указывает, что сервер отказывается предоставить доступ к ресурсу в результате юридического требования.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.InternalServerError(description=None, response=None, original_exception=None)

500 Internal Server Error

Вызывается, если произошла внутренняя ошибка сервера. Это хороший вариант по умолчанию, если в диспетчере произошла неизвестная ошибка.

Журнал изменений

Изменено в версии 1.0.0: Добавлен атрибут original_exception.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –
original_exception (Необязательно[BaseException]) –

Тип возвращаемого значения

original_exception: Исходное исключение, которое вызвало эту ошибку 500. Может использоваться фреймворками для предоставления контекста при обработке непредвиденных ошибок.

exception werkzeug.exceptions.NotImplemented(description=None, response=None)

501 Not Implemented

Вызывается, если приложение не поддерживает действие, запрошенное браузером.

Параметры

description (Необязательно[str]) –
response (Необязательно[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.BadGateway(description=None, response=None)

502 Bad Gateway

Если в вашем приложении используется проксирование, вы должны вернуть этот код состояния, если вы получили недействительный ответ от сервера-источника, к которому обращался сервер при попытке выполнить запрос.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.ServiceUnavailable(description=None, response=None, retry_after=None)

503 Service Unavailable

Код состояния, который следует возвращать, если служба временно недоступна.

Параметры

retry_after (Необязательный[Union[datetime.datetime, int]]) – Если задано, установите заголовок Retry-After в это значение. Может быть целым числом int секунд или значением datetime.
description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

Изменения

Изменено в версии 1.0: Добавлен параметр retry_after.

exception werkzeug.exceptions.GatewayTimeout(description=None, response=None)

504 Gateway Timeout

Код состояния, который следует возвращать, если таймаут подключения к серверу-источнику.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.HTTPVersionNotSupported(description=None, response=None)

505 HTTP Version Not Supported

Сервер не поддерживает версию HTTP, используемую в запросе.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.ClientDisconnected(description=None, response=None)

Внутреннее исключение, которое возникает, если Werkzeug обнаруживает отключение клиента. Поскольку клиент уже ушел, попытка отправки сообщения об ошибке клиенту может не сработать и в конечном итоге привести к другой ошибке на сервере. В основном это здесь для того, чтобы его игнорировали по умолчанию, что касается Werkzeug.

Поскольку отключения невозможно надежно обнаружить и они не определены WSGI в большой степени, это может или не может быть вызвано, если клиент ушел.

Изменения

Добавлено в версии 0.8.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

exception werkzeug.exceptions.SecurityError(description=None, response=None)

Возникает, если что-то вызывает ошибку безопасности. В остальном это точно так же, как ошибка неправильного запроса.

Изменения

Добавлено в версии 0.9.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

Базовый класс

Все исключения реализуют этот общий интерфейс:

exception werkzeug.exceptions.HTTPException(description=None, response=None)

Базовый класс для всех исключений HTTP. Это исключение можно вызвать как WSGI-приложение для отображения страницы с ошибкой по умолчанию, или вы можете поймать подклассы независимо и отобразить более приятные сообщения об ошибках.

Параметры

description (Необязательный[str]) –
response (Необязательный[Response]) –

Тип возвращаемого значения

__call__(environ, start_response)

Вызов исключения как WSGI-приложения.

Параметры

environ (WSGIEnvironment) – среда WSGI.
start_response (StartResponse) – вызываемый объект ответа, предоставляемый сервером WSGI.

Тип возвращаемого значения

Iterable[bytes]

get_response(environ=None, scope=None)

Получение объекта ответа. Если он был передан в исключение, он возвращается напрямую.

Параметры

environ (Необязательный[WSGIEnvironment]) – необязательная среда для запроса. Это можно использовать для изменения ответа в зависимости от того, как выглядел запрос.
scope (Необязательный[dict]) –

Возвращает

объект Response или его подкласс.

Тип возвращаемого значения

Специальные исключения HTTP

Начиная с Werkzeug 0.3 некоторые встроенные классы генерируют исключения, которые выглядят как обычные исключения Python (например, KeyError), но одновременно являются BadRequest исключениями HTTP. Это решение было принято для упрощения распространенного шаблона, где вы хотите прервать выполнение, если клиент внес изменения в данные формы таким образом, что приложение не может корректно восстановиться и должно прерваться с 400 BAD REQUEST.

Предполагая, что приложение перехватывает все исключения HTTP и должным образом реагирует на них, функция представления может безопасно выполнить следующее и не должна проверять, существуют ли ключи:

def new_post(request):
    post = Post(title=request.form['title'], body=request.form['body'])
    post.save()
    return redirect(post.url)

Если title или body отсутствуют в форме, будет генерироваться специальная ошибка ключа, которая ведет себя как KeyError, но также как и BadRequest исключение.

exception werkzeug.exceptions.BadRequestKeyError(arg=None, *args, **kwargs)

Исключение, используемое для сигнализации как KeyError, так и BadRequest. Используется многими структурами данных.

Параметры

arg (Optional[str]) –
args (Any) –
kwargs (Any) –

Простое прерывание

Иногда удобно просто сгенерировать исключение по коду ошибки, не импортируя исключение и не находя его имя и т. д. Для этой цели существует функция abort().

werkzeug.exceptions.abort(status, *args, **kwargs)

Вызывает HTTPException для заданного кода состояния или WSGI-приложения.

Если задан код состояния, он будет найден в списке исключений, и это исключение будет вызвано. Если передано WSGI-приложение, оно будет обернуто в прокси-исключение WSGI и это исключение будет вызвано:

abort(404)  # 404 Not Found
abort(Response('Hello World'))

Параметры

status (Union[int, Response]) –
args (Any) –
kwargs (Any) –

Тип возвращаемого значения

NoReturn

Если вы хотите использовать эту функциональность с пользовательскими исключениями, вы можете создать экземпляр класса aborter:

class werkzeug.exceptions.Aborter(mapping=None, extra=None)

При передаче словаря code -> exception items он может использоваться как вызываемый элемент, который генерирует исключения. Если первый аргумент вызываемого элемента — целое число, он будет найден в отображении; если это WSGI-приложение, оно будет вызвано в прокси-исключении.

Остальные аргументы передаются в конструктор исключения.

Параметры

mapping (Optional[Dict[int, Type[werkzeug.exceptions.HTTPException]]]) –
extra (Optional[Dict[int, Type[werkzeug.exceptions.HTTPException]]]) –

Тип возвращаемого значения

Пользовательские ошибки

Как видно из списка выше, не все коды состояния доступны в виде ошибок. Особенно отсутствуют перенаправления и другие коды состояния, отличные от 200, которые не представляют собой ошибки. Для перенаправлений вы можете использовать функцию redirect() из утилит.

Если вы хотите добавить собственную ошибку, вы можете унаследовать от HTTPException:

from werkzeug.exceptions import HTTPException

class PaymentRequired(HTTPException):
    code = 402
    description = '<p>Payment required.</p>'

Это минимальный код, необходимый для собственного исключения. Если вы хотите добавить больше логики в ошибки, вы можете переопределить методы get_description(), get_body(), get_headers() и get_response(). В любом случае вы должны взглянуть на исходный код модуля исключений.

Вы можете переопределить стандартное описание в конструкторе параметром description:

raise BadRequest(description='Request failed because X was not present')

© 2007–2021 Pallets
Licensed under the BSD 3-clause License.
https://werkzeug.palletsprojects.com/en/2.0.x/exceptions/

спецификации, руководства, описания, API

free hit counter