Обработка ошибок приложения

Инструменты ведения журналов ошибок

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

Для использования Sentry вам необходимо установить клиент sentry-sdk с дополнительными flask зависимостями.

$ pip install sentry-sdk[flask]

А затем добавьте это в ваше приложение Flask:

import sentry_sdk
from sentry_sdk.integrations.flask import FlaskIntegration

sentry_sdk.init('YOUR_DSN_HERE', integrations=[FlaskIntegration()])

Значение YOUR_DSN_HERE необходимо заменить значением DSN, полученным из вашей установки Sentry.

После установки сбои, приводящие к ошибке «Внутренняя ошибка сервера», автоматически сообщаются в Sentry, и оттуда вы можете получать уведомления об ошибках.

См. также:

• Sentry также поддерживает перехват ошибок из очереди задач (RQ, Celery и т. д.) аналогичным образом. Более подробная информация в документации Python SDK.
• Начало работы с Sentry
• Документация, специфичная для Flask

Обработчики ошибок

При возникновении ошибки в Flask будет возвращен соответствующий код состояния HTTP. 400-499 указывают на ошибки в данных запроса клиента или о запрошенных данных. 500-599 указывают на ошибки на стороне сервера или самого приложения.

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

Обработчик ошибок — это функция, которая возвращает ответ при возникновении типа ошибки, аналогично тому, как представление — это функция, которая возвращает ответ при совпадении URL-адреса запроса. Ей передается экземпляр обрабатываемой ошибки, которая, скорее всего, является HTTPException.

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

@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)

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

app.register_error_handler(InsufficientStorage, handle_507)

raise InsufficientStorage()

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

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

Настраиваемые страницы ошибок

Иногда при создании приложения Flask вам может потребоваться выбросить HTTPException, чтобы сообщить пользователю о проблеме в запросе. К счастью, Flask предоставляет удобную функцию abort(), которая прерывает запрос с ошибкой HTTP из Werkzeug, как требуется. Она также предоставит простую черно-белую страницу ошибки с базовым описанием, но ничего fancy.

Вероятность отображения такой ошибки для пользователя зависит от кода ошибки.

Рассмотрим код ниже. У нас может быть маршрут профиля пользователя, и если пользователь не передаёт имя пользователя, мы можем выбросить ошибку «400 Bad Request». Если пользователь передаёт имя пользователя, и мы не можем его найти, мы выбросим ошибку «404 Not Found».

from flask import abort, render_template, request

# a username needs to be supplied in the query args
# a successful request would be like /profile?username=jack
@app.route("/profile")
def user_profile():
    username = request.arg.get("username")
    # if a username isn't supplied in the request, return a 400 bad request
    if username is None:
        abort(400)

    user = get_user(username=username)
    # if a user can't be found by their username, return 404 not found
    if user is None:
        abort(404)

    return render_template("profile.html", user=user)

Вот ещё один пример реализации исключения «404 Page Not Found»:

from flask import render_template

@app.errorhandler(404)
def page_not_found(e):
    # note that we set the 404 status explicitly
    return render_template('404.html'), 404

При использовании Фабрик приложений:

from flask import Flask, render_template

def page_not_found(e):
  return render_template('404.html'), 404

def create_app(config_filename):
    app = Flask(__name__)
    app.register_error_handler(404, page_not_found)
    return app

Пример шаблона может быть таким:

{% extends "layout.html" %}
{% block title %}Page Not Found{% endblock %}
{% block body %}
  <h1>Page Not Found</h1>
  <p>What you were looking for is just not there.
  <p><a href="{{ url_for('index') }}">go somewhere nice</a>
{% endblock %}

{% extends "layout.html" %}
{% block title %}Internal Server Error{% endblock %}
{% block body %}
  <h1>Internal Server Error</h1>
  <p>Oops... we seem to have made a mistake, sorry!</p>
  <p><a href="{{ url_for('index') }}">Go somewhere nice instead</a>
{% endblock %}

from flask import render_template

@app.errorhandler(500)
def internal_server_error(e):
    # note that we set the 500 status explicitly
    return render_template('500.html'), 500

from flask import Flask, render_template

def internal_server_error(e):
  return render_template('500.html'), 500

def create_app():
    app = Flask(__name__)
    app.register_error_handler(500, internal_server_error)
    return app

from flask import Blueprint

blog = Blueprint('blog', __name__)

# as a decorator
@blog.errorhandler(500)
def internal_server_error(e):
    return render_template('500.html'), 500

# or with register_error_handler
blog.register_error_handler(500, internal_server_error)

Обработчики ошибок Blueprint

В Модульных приложениях с планами большинство обработчиков ошибок будут работать как ожидается. Однако есть нюанс, касающийся обработчиков исключений 404 и 405. Эти обработчики вызываются только из соответствующего raise оператора или вызова abort в другой функции представления плана; они не вызываются, например, при доступе по некорректному URL.

Это происходит потому, что план не «владеет» определённым пространством URL, поэтому экземпляр приложения не может знать, какой обработчик ошибок плана он должен запустить, если ему предоставлен некорректный URL. Если вам нужно выполнить различные стратегии обработки для этих ошибок на основе префиксов URL, они могут быть определены на уровне приложения с помощью объекта прокси request.

from flask import jsonify, render_template

# at the application level
# not the blueprint level
@app.errorhandler(404)
def page_not_found(e):
    # if a request is in our blog URL space
    if request.path.startswith('/blog/'):
        # we return a custom blog 404 page
        return render_template("blog/404.html"), 404
    else:
        # otherwise we return our generic site-wide 404 page
        return render_template("404.html"), 404

@app.errorhandler(405)
def method_not_allowed(e):
    # if a request has the wrong method to our API
    if request.path.startswith('/api/'):
        # we return a json saying so
        return jsonify(message="Method Not Allowed"), 405
    else:
        # otherwise we return a generic site-wide 405 page
        return render_template("405.html"), 405

Возврат ошибок API в формате JSON

При разработке API в Flask некоторые разработчики понимают, что встроенные исключения недостаточно выразительны для API, и что тип содержимого text/html, который они передают, не очень полезен для потребителей API.

Используя те же методы, что и выше, и jsonify(), мы можем возвращать JSON-ответы для ошибок API. abort() вызывается с параметром description. Обработчик ошибок будет использовать его как сообщение об ошибке в формате JSON и установить код состояния в 404.

from flask import abort, jsonify

@app.errorhandler(404)
def resource_not_found(e):
    return jsonify(error=str(e)), 404

@app.route("/cheese")
def get_one_cheese():
    resource = get_resource()

    if resource is None:
        abort(404, description="Resource not found")

    return jsonify(resource)

Мы также можем создавать пользовательские классы исключений. Например, мы можем ввести новый пользовательский класс исключения для API, который может принимать надлежащее читаемое человеком сообщение, код состояния для ошибки и некоторые необязательные данные для предоставления большего контекста для ошибки.

Вот простой пример:

from flask import jsonify, request

class InvalidAPIUsage(Exception):
    status_code = 400

    def __init__(self, message, status_code=None, payload=None):
        super().__init__()
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload

    def to_dict(self):
        rv = dict(self.payload or ())
        rv['message'] = self.message
        return rv

@app.errorhandler(InvalidAPIUsage)
def invalid_api_usage(e):
    return jsonify(e.to_dict()), e.status_code

# an API app route for getting user information
# a correct request might be /api/user?user_id=420
@app.route("/api/user")
def user_api(user_id):
    user_id = request.arg.get("user_id")
    if not user_id:
        raise InvalidAPIUsage("No user id provided!")

    user = get_user(user_id=user_id)
    if not user:
        raise InvalidAPIUsage("No such user!", status_code=404)

    return jsonify(user.to_dict())

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

Ведение журнала

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

Отладка

См. Отладка ошибок приложения для получения информации о том, как отлаживать ошибки в режиме разработки и производства.