Регистрация¶

Зарегистрируйте обработчики, украсив функцию символом errorhandler(). Или используйте register_error_handler(), чтобы зарегистрировать функцию позже. Не забудьте установить код ошибки при возврате ответа.

@app.errorhandler(werkzeug.exceptions.BadRequest)
def handle_bad_request(e):
    return 'bad request!', 400

# or, without the decorator
app.register_error_handler(400, handle_bad_request)

Подклассы werkzeug.exceptions.HTTPException типа BadRequest и их HTTP-коды взаимозаменяемы при регистрации обработчиков. (BadRequest.code == 400)

Нестандартные HTTP-коды не могут быть зарегистрированы кодом, поскольку они не известны Werkzeug. Вместо этого определите подкласс HTTPException с соответствующим кодом, зарегистрируйте и поднимите этот класс исключений.

class InsufficientStorage(werkzeug.exceptions.HTTPException):
    code = 507
    description = 'Not enough storage space.'

app.register_error_handler(InsufficientStorage, handle_507)

raise InsufficientStorage()

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

Работа с¶

Когда Flask ловит исключение при обработке запроса, оно сначала ищется по коду. Если для кода не зарегистрирован обработчик, его ищут по иерархии классов; выбирается наиболее специфичный обработчик. Если обработчик не зарегистрирован, подклассы HTTPException показывают общее сообщение о своем коде, а другие исключения преобразуются в общее сообщение 500 Internal Server Error.

Например, если возникает экземпляр ConnectionRefusedError, а обработчик зарегистрирован для ConnectionError и ConnectionRefusedError, то для генерации ответа вызывается более специфический обработчик ConnectionRefusedError с экземпляром исключения.

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

Общие обработчики исключений¶

Можно зарегистрировать обработчики ошибок для очень общих базовых классов, таких как HTTPException или даже Exception. Однако имейте в виду, что они будут ловить больше, чем вы ожидаете.

Обработчик ошибок HTTPException может быть полезен, например, для превращения HTML-страниц ошибок по умолчанию в JSON. Однако этот обработчик будет срабатывать при ошибках, которые вы не вызываете напрямую, таких как 404 и 405 ошибки при маршрутизации. Убедитесь, что вы тщательно разработали обработчик, чтобы не потерять информацию об ошибке HTTP.

from flask import json
from werkzeug.exceptions import HTTPException

@app.errorhandler(HTTPException)
def handle_exception(e):
    """Return JSON instead of HTML for HTTP errors."""
    # start with the correct headers and status code from the error
    response = e.get_response()
    # replace the body with JSON
    response.data = json.dumps({
        "code": e.code,
        "name": e.name,
        "description": e.description,
    })
    response.content_type = "application/json"
    return response

Обработчик ошибок для Exception может показаться полезным для изменения того, как все ошибки, даже необработанные, представляются пользователю. Однако это аналогично тому, как если бы вы сделали except Exception: в Python, он будет перехватывать все необработанные ошибки, включая все коды состояния HTTP. В большинстве случаев будет безопаснее зарегистрировать обработчики для более специфических исключений. Поскольку экземпляры HTTPException являются допустимыми ответами WSGI, вы также можете передавать их напрямую.

from werkzeug.exceptions import HTTPException

@app.errorhandler(Exception)
def handle_exception(e):
    # pass through HTTP errors
    if isinstance(e, HTTPException):
        return e

    # now you're handling non-HTTP exceptions only
    return render_template("500_generic.html", e=e), 500

Обработчики ошибок по-прежнему соблюдают иерархию классов исключений. Если вы зарегистрируете обработчики для HTTPException и Exception, обработчик Exception не будет обрабатывать подклассы HTTPException, поскольку обработчик HTTPException более специфичен.

Необработанные исключения¶

Если для исключения не зарегистрирован обработчик ошибок, вместо него будет возвращена внутренняя ошибка сервера 500. Информацию о таком поведении см. в flask.Flask.handle_exception().

Если для InternalServerError зарегистрирован обработчик ошибок, то будет вызван именно он. Начиная с версии Flask 1.1.0, этому обработчику ошибок всегда будет передаваться экземпляр InternalServerError, а не исходная необработанная ошибка. Исходная ошибка доступна в виде e.original_exception. До версии Werkzeug 1.0.0 этот атрибут будет существовать только для необработанных ошибок, для совместимости используйте getattr для получения доступа к нему.

@app.errorhandler(InternalServerError)
def handle_500(e):
    original = getattr(e, "original_exception", None)

    if original is None:
        # direct 500 error, such as abort(500)
        return render_template("500.html"), 500

    # wrapped unhandled error
    return render_template("500_unhandled.html", e=original), 500