Работа с оболочкой

Одна из причин, по которой все любят Python, — интерактивная оболочка. Она позволяет вам выполнять команды Python в реальном времени и немедленно получать результаты. Flask сам по себе не поставляется с интерактивной оболочкой, так как ему не требуется предварительная настройка, достаточно импортировать приложение и начать экспериментировать.

Однако есть несколько полезных помощников, которые сделают работу в оболочке более приятной. Основная проблема с интерактивными сессиями консоли заключается в том, что вы не инициируете запрос, как это делает браузер, что означает, что g, request и другие не доступны. Но код, который вы хотите протестировать, может зависеть от них, так что что можно сделать?

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

В целом рекомендуется сначала ознакомиться с главой Контекст запроса документации.

Интерфейс командной строки

Начиная с Flask 0.11, рекомендуемый способ работы с оболочкой — команда flask shell, которая выполняет многое из этого автоматически. Например, оболочка автоматически инициализируется с загруженным контекстом приложения.

Для получения дополнительной информации см. Интерфейс командной строки.

Создание контекста запроса

Самый простой способ создать правильный контекст запроса из оболочки — использовать метод test_request_context, который создаёт нам RequestContext:

>>> ctx = app.test_request_context()

Обычно вы бы использовали оператор with, чтобы сделать этот объект запроса активным, но в оболочке проще использовать методы push() и pop() вручную:

>>> ctx.push()

После этого вы можете работать с объектом запроса, пока не вызовете pop:

>>> ctx.pop()

Выполнение перед/после запроса

Просто создав контекст запроса, вы все равно не выполнили код, который обычно выполняется перед запросом. Это может привести к тому, что база данных станет недоступной, если вы подключаетесь к базе данных в обратном вызове перед запросом, или текущий пользователь не будет сохранён в объекте g и т. д.

Однако это можно легко сделать самостоятельно. Просто вызовите preprocess_request():

>>> ctx = app.test_request_context()
>>> ctx.push()
>>> app.preprocess_request()

Помните, что функция preprocess_request() может возвращать объект ответа, в этом случае просто проигнорируйте его.

Чтобы остановить запрос, вам нужно немного обмануть перед функциями после запроса (вызываемыми process_response()), которые работают с объектом ответа:

>>> app.process_response(app.response_class())
<Response 0 bytes [200 OK]>
>>> ctx.pop()

Функции, зарегистрированные как teardown_request(), автоматически вызываются при снятии контекста. Поэтому это идеальное место для автоматической разборки ресурсов, которые были необходимы контексту запроса (таких как подключения к базе данных).

Дальнейшее улучшение работы оболочки

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

Просто поместите их в модуль (например, shelltools) и импортируйте оттуда:

>>> from shelltools import *