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

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

Добавлен в версии 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 *