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

Журнал изменений

Новая версия 0.3.

Одна из причин, по которой все любят 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 *