Контекст приложения

Цель контекста

Объект приложения Flask имеет атрибуты, такие как config, которые полезны для доступа в представлениях и командах командной строки. Однако импорт экземпляра app в модули вашего проекта подвержен проблемам циклических импортов. При использовании шаблона фабрики приложений или написании многократно используемых blueprints или расширений, экземпляра app для импорта может не быть вовсе.

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

Flask автоматически подталкивает контекст приложения при обработке запроса. Функции представлений, обработчики ошибок и другие функции, выполняемые во время запроса, будут иметь доступ к current_app.

Flask также автоматически подтолкнет контекст приложения при выполнении команд командной строки, зарегистрированных с помощью Flask.cli с использованием @app.cli.command().

Срок жизни контекста

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

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

Ручное подталкивание контекста

Если вы попытаетесь получить доступ к current_app или чему-либо, использующему его, вне контекста приложения, вы получите следующее сообщение об ошибке:

RuntimeError: Working outside of application context.

This typically means that you attempted to use functionality that
needed to interface with the current application object in some way.
To solve this, set up an application context with app.app_context().

Если вы видите эту ошибку при настройке приложения, например, при инициализации расширения, вы можете вручную подтолкнуть контекст, так как у вас есть прямой доступ к app. Используйте app_context() в блоке with, и все, что выполняется в блоке, будет иметь доступ к current_app.

def create_app():
    app = Flask(__name__)

    with app.app_context():
        init_db()

    return app

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

Хранение данных

Контекст приложения — хорошее место для хранения общих данных во время запроса или команды командной строки. Flask предоставляет g object для этой цели. Это простой объект пространства имен, который имеет тот же срок жизни, что и контекст приложения.

Частое использование g заключается в управлении ресурсами во время запроса.

1. get_X() создает ресурс X, если он не существует, кэшируя его как g.X.
2. teardown_X() закрывает или иным образом освобождает ресурс, если он существует. Он зарегистрирован как обработчик teardown_appcontext().

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

from flask import g

def get_db():
    if 'db' not in g:
        g.db = connect_to_database()

    return g.db

@app.teardown_appcontext
def teardown_db(exception):
    db = g.pop('db', None)

    if db is not None:
        db.close()

Во время запроса каждый вызов get_db() вернет то же самое подключение, и оно будет закрыто автоматически в конце запроса.

Вы можете использовать LocalProxy, чтобы создать новый контекстно-локальный объект из get_db():

from werkzeug.local import LocalProxy
db = LocalProxy(get_db)

Обращение к db вызовет get_db внутри, так же, как работает current_app.

События и сигналы

При извлечении контекста приложения приложение вызовет функции, зарегистрированные в teardown_appcontext().

Если signals_available имеет значение true, отправляются следующие сигналы: appcontext_pushed, appcontext_tearing_down и appcontext_popped.