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

Контекст приложения отслеживает данные приложения на уровне приложения во время запроса, команды CLI или другой активности. Вместо передачи приложения каждой функции, вместо этого используются прокси current_app и g.

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

Назначение контекста

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

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

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

Flask также автоматически подтолкнет контекст приложения при запуске команд CLI, зарегистрированных с помощью 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.

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

Контекст приложения — хорошее место для хранения общих данных во время запроса или команды 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.

Если вы пишете расширение, g следует резервировать для кода пользователя. Вы можете хранить внутренние данные в контексте, но обязательно используйте достаточно уникальное имя. Текущий контекст доступен с помощью _app_ctx_stack.top. Для получения дополнительной информации см. Разработка расширений Flask.

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

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

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