API¶

Объект flask реализует приложение WSGI и действует как центральный объект. Ему передается имя модуля или пакета приложения. После его создания он будет действовать как центральный реестр для функций представления, правил URL, конфигурации шаблонов и многого другого.

Имя пакета используется для разрешения ресурсов внутри пакета или папки, в которой находится модуль, в зависимости от того, разрешает ли параметр package фактический пакет python (папка с файлом __init__.py внутри) или стандартный модуль (просто файл .py).

Для получения дополнительной информации о загрузке ресурсов смотрите open_resource().

Обычно вы создаете экземпляр Flask в вашем главном модуле или в __init__.py файле вашего пакета следующим образом:

from flask import Flask
app = Flask(__name__)

app = Flask('yourapplication')
app = Flask(__name__.split('.')[0])

Параметры:

• import_name (str) – имя пакета приложений

• static_url_path (Optional[str]) – можно использовать для указания другого пути для статических файлов в сети. По умолчанию используется имя папки static_folder.

• static_folder (Optional[Union[str, PathLike]]) – Папка со статическими файлами, которая обслуживается по адресу static_url_path. Относительный к приложению root_path или абсолютный путь. По умолчанию 'static'.

• static_host (Optional[str]) – хост, который будет использоваться при добавлении статического маршрута. По умолчанию установлено значение None. Требуется при использовании host_matching=True с настроенным static_folder.

• host_matching (bool) – установить атрибут url_map.host_matching. По умолчанию имеет значение False.

• subdomain_matching (bool) – учитывать поддомен относительно SERVER_NAME при подборе маршрутов. По умолчанию имеет значение False.

• template_folder (Optional[Union[str, PathLike]]) – папка, содержащая шаблоны, которые должны использоваться приложением. По умолчанию это папка 'templates' в корневом пути приложения.

• instance_path (Optional[str]) – Альтернативный путь к экземпляру приложения. По умолчанию за путь к экземпляру принимается папка 'instance' рядом с пакетом или модулем.

• instance_relative_config (bool) – если установлено значение True относительные имена файлов для загрузки конфигурации считаются относительными к пути экземпляра, а не к корню приложения.

• root_path (Optional[str]) – Путь к корню файлов приложения. Его следует задавать вручную только в том случае, если он не может быть определен автоматически, например, для пакетов пространства имен.

aborter¶

Экземпляр aborter_class, созданный make_aborter(). Он вызывается flask.abort(), чтобы вызвать ошибки HTTP, а также может быть вызван напрямую.

Добавлено в версии 2.2: Перемещено из flask.abort, который вызывает этот объект.

aborter_class¶

alias of Aborter

add_template_filter(f, name=None)¶

Регистрация пользовательского фильтра шаблона. Работает точно так же, как декоратор template_filter().

Параметры:

• name (Optional[str]) – необязательное имя фильтра, иначе будет использовано имя функции.

• f (Callable[[...], Any]) –

Тип результата:

None

add_template_global(f, name=None)¶

Регистрация глобальной функции пользовательского шаблона. Работает точно так же, как декоратор template_global().

Changelog

Добавлено в версии 0.10.

Параметры:

• name (Optional[str]) – необязательное имя глобальной функции, иначе будет использовано имя функции.

• f (Callable[[...], Any]) –

Тип результата:

None

add_template_test(f, name=None)¶

Регистрация пользовательского шаблона теста. Работает точно так же, как декоратор template_test().

Changelog

Добавлено в версии 0.10.

Параметры:

• name (Optional[str]) – необязательное имя теста, иначе будет использовано имя функции.

• f (Callable[[...], bool]) –

Тип результата:

None

add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)¶

Зарегистрируйте правило для маршрутизации входящих запросов и построения URL. Декоратор route() является сокращением для вызова этого параметра с аргументом view_func. Это эквивалентно:

@app.route("/")
def index():
    ...

def index():
    ...

app.add_url_rule("/", view_func=index)

См. Регистрация маршрутов URL.

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

Параметр methods по умолчанию имеет значение ["GET"]. HEAD всегда добавляется автоматически, а OPTIONS добавляется автоматически по умолчанию.

view_func не обязательно передавать, но если правило должно участвовать в маршрутизации, имя конечной точки должно быть связано с функцией представления в какой-то момент с помощью декоратора endpoint().

app.add_url_rule("/", endpoint="index")

@app.endpoint("index")
def index():
    ...

Если view_func имеет атрибут required_methods, то эти методы добавляются к переданным и автоматическим методам. Если у него есть атрибут provide_automatic_methods, то он используется по умолчанию, если параметр не передан.

Параметры:

• rule (str) – Строка правила URL.

• endpoint (Optional[str]) – Имя конечной точки, которое нужно связать с правилом и функцией представления. Используется при маршрутизации и построении URL. По умолчанию имеет значение view_func.__name__.

• view_func (Optional[Union[Callable[[...], Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]], Callable[[...], Awaitable[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]]]]]) – Функция представления, которую нужно связать с именем конечной точки.

• provide_automatic_options (Optional[bool]) – Добавьте метод OPTIONS и отвечайте на запросы OPTIONS автоматически.

• options (Any) – Дополнительные параметры, передаваемые объекту Rule.

Тип результата:

None

after_request(f)¶

Зарегистрируйте функцию для запуска после каждого запроса к этому объекту.

Функция вызывается с объектом ответа и должна вернуть объект ответа. Это позволяет функции изменять или заменять ответ до его отправки.

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

Эта функция доступна как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция выполняется после каждого запроса. При использовании на blueprint, это выполняется после каждого запроса, который обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и выполнять после каждого запроса, используйте Blueprint.after_app_request().

Параметры:

f (T_after_request) –

Тип результата:

T_after_request

after_request_funcs: t.Dict[ft.AppOrBlueprintKey, t.List[ft.AfterRequestCallable]]¶

Структура данных функций для вызова в конце каждого запроса, в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор after_request().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

app_context()¶

Создайте AppContext. Используйте в качестве блока with, чтобы подтолкнуть контекст, который заставит current_app указывать на это приложение.

Контекст приложения автоматически подталкивается RequestContext.push() при обработке запроса и при выполнении команды CLI. Используйте этот параметр для ручного создания контекста вне этих ситуаций.

with app.app_context():
    init_db()

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

Changelog

Добавлено в версии 0.9.

Тип результата:

AppContext

app_ctx_globals_class¶

alias of _AppCtxGlobals

async_to_sync(func)¶

Возвращает функцию синхронизации, которая будет выполнять функцию coroutine.

result = app.async_to_sync(func)(*args, **kwargs)

Переопределите этот метод, чтобы изменить способ преобразования асинхронного кода в синхронно вызываемый.

Changelog

Добавлено в версии 2.0.

Параметры:

func (Callable[[...], Coroutine]) –

Тип результата:

Callable[[…], Any]

auto_find_instance_path()¶

Пытается найти путь к экземпляру, если он не был указан в конструкторе класса приложения. В основном вычисляется путь к папке с именем instance рядом с вашим главным файлом или пакетом.

Changelog

Добавлено в версии 0.8.

Тип результата:

str

before_first_request(f)¶

Регистрирует функцию для запуска перед первым запросом к данному экземпляру приложения.

Функция будет вызвана без аргументов, а ее возвращаемое значение будет проигнорировано.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого запускайте код настройки при создании приложения.

Changelog

Добавлено в версии 0.8.

Параметры:

f (T_before_first_request) –

Тип результата:

T_before_first_request

before_first_request_funcs: t.List[ft.BeforeFirstRequestCallable]¶

Список функций, которые будут вызываться в начале первого запроса к данному экземпляру. Чтобы зарегистрировать функцию, используйте декоратор before_first_request().

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого запускайте код настройки при создании приложения.

Changelog

Добавлено в версии 0.8.

before_request(f)¶

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

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

@app.before_request
def load_user():
    if "user_id" in session:
        g.user = db.session.get(session["user_id"])

Функция будет вызвана без каких-либо аргументов. Если она возвращает значение не``None``, оно обрабатывается так, как если бы это было возвращаемое значение из представления, и дальнейшая обработка запроса прекращается.

Это доступно как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция выполняется перед каждым запросом. При использовании на blueprint, это выполняется перед каждым запросом, который обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и выполнять перед каждым запросом, используйте Blueprint.before_app_request().

Параметры:

f (T_before_request) –

Тип результата:

T_before_request

before_request_funcs: t.Dict[ft.AppOrBlueprintKey, t.List[ft.BeforeRequestCallable]]¶

Структура данных функций для вызова в начале каждого запроса в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор before_request().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

blueprints: t.Dict[str, 'Blueprint']¶

Сопоставляет зарегистрированные имена чертежей с объектами чертежей. Диктант сохраняет порядок, в котором были зарегистрированы чертежи. Чертежи могут быть зарегистрированы несколько раз, этот дикт не отслеживает, как часто они были присоединены.

Changelog

Добавлено в версии 0.7.

cli¶

Группа команд Click для регистрации команд CLI для данного объекта. Команды доступны из команды flask после обнаружения приложения и регистрации чертежей.

config¶

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

config_class¶

alias of Config

context_processor(f)¶

Регистрирует функцию контекстного процессора шаблона. Эти функции запускаются перед отрисовкой шаблона. Ключи возвращаемого dict добавляются в качестве переменных, доступных в шаблоне.

Эта функция доступна как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция вызывается для каждого отрисованного шаблона. При использовании на blueprint, это вызывается для шаблонов, отрисованных из представлений blueprint. Чтобы зарегистрироваться в blueprint и повлиять на каждый шаблон, используйте Blueprint.app_context_processor().

Параметры:

f (T_template_context_processor) –

Тип результата:

T_template_context_processor

create_global_jinja_loader()¶

Создает загрузчик для среды Jinja2. Может быть использована для переопределения только загрузчика, а остальные функции остаются неизменными. Не рекомендуется переопределять эту функцию. Вместо этого следует переопределить функцию jinja_loader().

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

Changelog

Добавлено в версии 0.7.

Тип результата:

DispatchingJinjaLoader

create_jinja_environment()¶

Создайте окружение Jinja на основе jinja_options и различных методов приложения, связанных с Jinja. Изменение jinja_options после этого не будет иметь никакого эффекта. Также добавляет в окружение связанные с Flask глобальные файлы и фильтры.

Changelog

Изменено в версии 0.11: Environment.auto_reload устанавливается в соответствии с параметром конфигурации TEMPLATES_AUTO_RELOAD.

Добавлено в версии 0.5.

Тип результата:

Environment

create_url_adapter(request)¶

Создает адаптер URL для заданного запроса. URL-адаптер создается в тот момент, когда контекст запроса еще не установлен, поэтому запрос передается в явном виде.

Changelog

Изменено в версии 1.0: SERVER_NAME больше не включает неявное сопоставление поддоменов. Вместо этого используйте subdomain_matching.

Изменено в версии 0.9: Теперь его можно вызывать и без объекта запроса, когда URL-адаптер создается для контекста приложения.

Добавлено в версии 0.6.

Параметры:

request (Optional[Request]) –

Тип результата:

Optional[MapAdapter]

property debug: bool¶

Включен ли режим отладки. При использовании flask run для запуска сервера разработки, интерактивный отладчик будет показан для необработанных исключений, и сервер будет перезагружен при изменении кода. Этот параметр соответствует ключу конфигурации DEBUG. Она может вести себя не так, как ожидается, если установлена с опозданием.

Не включайте режим отладки при развертывании в производстве..

По умолчанию: False

default_config = {'APPLICATION_ROOT': '/', 'DEBUG': None, 'ENV': None, 'EXPLAIN_TEMPLATE_LOADING': False, 'JSONIFY_MIMETYPE': None, 'JSONIFY_PRETTYPRINT_REGULAR': None, 'JSON_AS_ASCII': None, 'JSON_SORT_KEYS': None, 'MAX_CONTENT_LENGTH': None, 'MAX_COOKIE_SIZE': 4093, 'PERMANENT_SESSION_LIFETIME': datetime.timedelta(days=31), 'PREFERRED_URL_SCHEME': 'http', 'PROPAGATE_EXCEPTIONS': None, 'SECRET_KEY': None, 'SEND_FILE_MAX_AGE_DEFAULT': None, 'SERVER_NAME': None, 'SESSION_COOKIE_DOMAIN': None, 'SESSION_COOKIE_HTTPONLY': True, 'SESSION_COOKIE_NAME': 'session', 'SESSION_COOKIE_PATH': None, 'SESSION_COOKIE_SAMESITE': None, 'SESSION_COOKIE_SECURE': False, 'SESSION_REFRESH_EACH_REQUEST': True, 'TEMPLATES_AUTO_RELOAD': None, 'TESTING': False, 'TRAP_BAD_REQUEST_ERRORS': None, 'TRAP_HTTP_EXCEPTIONS': False, 'USE_X_SENDFILE': False}¶

Параметры конфигурации по умолчанию.

delete(rule, **options)¶

Сокращение для route() с methods=["DELETE"].

Changelog

Добавлено в версии 2.0.

Параметры:

• rule (str) –

• options (Any) –

Тип результата:

Callable[[T_route], T_route]

dispatch_request()¶

Выполняет диспетчеризацию запроса. Сопоставляет URL и возвращает возвращаемое значение представления или обработчика ошибок. Это не обязательно должен быть объект ответа. Чтобы преобразовать возвращаемое значение в соответствующий объект ответа, вызовите make_response().

Changelog

Изменено в версии 0.7: Здесь больше не выполняется обработка исключений, этот код был перенесен в новый full_dispatch_request().

Тип результата:

Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], WSGIApplication]

do_teardown_appcontext(exc=<object object>)¶

Вызывается непосредственно перед разворачиванием контекста приложения.

При обработке запроса контекст приложения открывается после контекста запроса. См. do_teardown_request().

При этом вызываются все функции, украшенные teardown_appcontext(). Затем посылается сигнал appcontext_tearing_down.

Это вызывается командой AppContext.pop().

Changelog

Добавлено в версии 0.9.

Параметры:

exc (Optional[BaseException]) –

Тип результата:

None

do_teardown_request(exc=<object object>)¶

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

При этом вызываются все функции, украшенные символом teardown_request(), и Blueprint.teardown_request(), если запрос обработал блюпринт. Наконец, посылается сигнал request_tearing_down.

Это вызывается командой RequestContext.pop(), которая может быть задержана во время тестирования для поддержания доступа к ресурсам.

Параметры:

exc (Optional[BaseException]) – Необработанное исключение, возникшее при диспетчеризации запроса. Определяется из текущей информации об исключении, если она не передана. Передается каждой функции завершения работы.

Тип результата:

None

Changelog

Изменено в версии 0.9: Добавлен аргумент exc.

endpoint(endpoint)¶

Украсьте функцию представления, чтобы зарегистрировать ее для заданной конечной точки. Используется, если правило добавляется без view_func с add_url_rule().

app.add_url_rule("/ex", endpoint="example")

@app.endpoint("example")
def example():
    ...

Параметры:

endpoint (str) – Имя конечной точки, которую нужно связать с функцией представления.

Тип результата:

Callable[[F], F]

ensure_sync(func)¶

Убедитесь, что функция является синхронной для рабочих WSGI. Простые функции def возвращаются как есть. Функции async def оборачиваются для запуска и ожидания ответа.

Переопределите этот метод, чтобы изменить способ выполнения асинхронных представлений в приложении.

Changelog

Добавлено в версии 2.0.

Параметры:

func (Callable) –

Тип результата:

Callable

property env: str¶

В какой среде работает приложение. Это соответствует ключу конфигурации ENV.

Не включайте разработку при развертывании в производстве..

По умолчанию: 'production'

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3.

error_handler_spec: t.Dict[ft.AppOrBlueprintKey, t.Dict[t.Optional[int], t.Dict[t.Type[Exception], ft.ErrorHandlerCallable]]]¶

Структура данных зарегистрированных обработчиков ошибок в формате {scope: {code: {class: handler}}}. Ключ scope - это имя чертежа, для которого активны обработчики, или None для всех запросов. Ключ code - это код статуса HTTP для HTTPException, или None для других исключений. Внутренний словарь сопоставляет классы исключений с функциями обработчиков.

Чтобы зарегистрировать обработчик ошибок, используйте декоратор errorhandler().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

errorhandler(code_or_exception)¶

Зарегистрируйте функцию для обработки ошибок по коду или классу исключений.

Декоратор, который используется для регистрации функции с кодом ошибки. Пример:

@app.errorhandler(404)
def page_not_found(error):
    return 'This page does not exist', 404

Вы также можете зарегистрировать обработчики для произвольных исключений:

@app.errorhandler(DatabaseError)
def special_exception_handler(error):
    return 'Database connection failed', 500

Эта функция доступна как для приложений, так и для объектов blueprint. При использовании в приложении он может обрабатывать ошибки каждого запроса. При использовании на blueprint, это может обрабатывать ошибки запросов, которые обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и влиять на каждый запрос, используйте Blueprint.app_errorhandler().

Changelog

Добавлено в версии 0.7: Используйте register_error_handler() вместо модификации error_handler_spec напрямую, для обработчиков ошибок для всего приложения.

Добавлено в версии 0.7: Теперь можно дополнительно регистрировать пользовательские типы исключений, которые не обязательно должны быть подклассом класса HTTPException.

Параметры:

code_or_exception (Union[Type[Exception], int]) – код как целое число для обработчика, или произвольное исключение

Тип результата:

Callable[[T_error_handler], T_error_handler]

extensions: dict¶

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

Ключ должен совпадать с именем модуля расширения. Например, в случае расширения «Flask-Foo» в flask_foo, ключ будет 'foo'.

Changelog

Добавлено в версии 0.7.

full_dispatch_request()¶

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

Changelog

Добавлено в версии 0.7.

Тип результата:

Response

get(rule, **options)¶

Сокращение для route() с methods=["GET"].

Changelog

Добавлено в версии 2.0.

Параметры:

• rule (str) –

• options (Any) –

Тип результата:

Callable[[T_route], T_route]

get_send_file_max_age(filename)¶

Используется send_file() для определения значения кэша max_age для данного пути к файлу, если он не был передан.

По умолчанию это возвращает SEND_FILE_MAX_AGE_DEFAULT из конфигурации current_app. По умолчанию это значение равно None, что говорит браузеру использовать условные запросы вместо таймерного кэша, что обычно предпочтительнее.

Changelog

Изменено в версии 2.0: По умолчанию вместо 12 часов используется None.

Добавлено в версии 0.9.

Параметры:

filename (Optional[str]) –

Тип результата:

Optional[int]

property got_first_request: bool¶

Этот атрибут имеет значение True, если приложение начало обрабатывать первый запрос.

Changelog

Добавлено в версии 0.8.

handle_exception(e)¶

Обработать исключение, которое не имеет обработчика ошибок, связанного с ним, или которое было вызвано из обработчика ошибок. Это всегда вызывает ошибку 500 InternalServerError.

Всегда посылает сигнал got_request_exception.

Если propagate_exceptions равно True, например, в режиме отладки, ошибка будет повторно поднята, чтобы отладчик мог ее отобразить. В противном случае исходное исключение регистрируется, и возвращается InternalServerError.

Если обработчик ошибок зарегистрирован для InternalServerError или 500, он будет использоваться. Для согласованности обработчик всегда будет получать InternalServerError. Исходное необработанное исключение доступно как e.original_exception.

Changelog

Изменено в версии 1.1.0: Всегда передает обработчику экземпляр InternalServerError, устанавливая original_exception на необработанную ошибку.

Изменено в версии 1.1.0: after_request функции и другая финализация выполняется даже для ответа 500 по умолчанию, когда обработчик отсутствует.

Добавлено в версии 0.3.

Параметры:

e (Exception) –

Тип результата:

Response

handle_http_exception(e)¶

Обрабатывает исключение HTTP. По умолчанию вызываются зарегистрированные обработчики ошибок и возвращается исключение в качестве ответа.

Changelog

Изменено в версии 1.0.3: RoutingException, используемый внутренне для таких действий, как перенаправление косой черты при маршрутизации, не передается обработчикам ошибок.

Изменено в версии 1.0: Исключения ищутся в коде и в MRO, поэтому подклассы HTTPException можно обрабатывать с помощью обработчика для базового HTTPException.

Добавлено в версии 0.3.

Параметры:

e (HTTPException) –

Тип результата:

Union[HTTPException, Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], WSGIApplication]

handle_url_build_error(error, endpoint, values)¶

Вызывается командой url_for(), если была вызвана ошибка BuildError. Если эта функция возвращает значение, оно будет возвращено командой url_for, в противном случае ошибка будет вызвана повторно.

Каждая функция в url_build_error_handlers вызывается с помощью error, endpoint и values. Если функция возвращает None или вызывает BuildError, она пропускается. В противном случае ее возвращаемое значение возвращается командой url_for.

Параметры:

• error (BuildError) – Активный BuildError, который обрабатывается.

• endpoint (str) – Строящаяся конечная точка.

• values (Dict[str, Any]) – Аргументы ключевых слов, переданные в url_for.

Тип результата:

str

handle_user_exception(e)¶

Этот метод вызывается всякий раз, когда возникает исключение, которое необходимо обработать. Особым случаем является HTTPException, которое передается методу handle_http_exception(). Эта функция либо вернет значение ответа, либо повторно вызовет исключение с тем же возвратом.

Changelog

Изменено в версии 1.0: Ошибки ключа, вызванные данными запроса типа form, показывают плохой ключ в режиме отладки, а не общее сообщение о плохом запросе.

Добавлено в версии 0.7.

Параметры:

e (Exception) –

Тип результата:

Union[HTTPException, Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], WSGIApplication]

property has_static_folder: bool¶

True, если установлено static_folder.

Changelog

Добавлено в версии 0.5.

import_name¶

Имя пакета или модуля, к которому принадлежит данный объект. Не изменяйте это значение, если оно задано конструктором.

inject_url_defaults(endpoint, values)¶

Вставляет значения URL по умолчанию для данной конечной точки непосредственно в переданный словарь значений. Это используется внутри и автоматически вызывается при построении URL.

Changelog

Добавлено в версии 0.7.

Параметры:

• endpoint (str) –

• values (dict) –

Тип результата:

None

instance_path¶

Указывает путь к папке экземпляра.

Changelog

Добавлено в версии 0.8.

iter_blueprints()¶

Итерация по всем чертежам в порядке их регистрации.

Changelog

Добавлено в версии 0.11.

Тип результата:

ValuesView[Blueprint]

property jinja_env: Environment¶

Среда Jinja, используемая для загрузки шаблонов.

Среда создается при первом обращении к этому свойству. Изменение jinja_options после этого не будет иметь никакого эффекта.

jinja_environment¶

alias of Environment

property jinja_loader: Optional[FileSystemLoader]¶

Загрузчик Jinja для шаблонов этого объекта. По умолчанию это класс jinja2.loaders.FileSystemLoader в template_folder, если он установлен.

Changelog

Добавлено в версии 0.5.

jinja_options: dict = {}¶

Параметры, которые передаются в среду Jinja в create_jinja_environment(). Изменение этих параметров после создания окружения (обращение к jinja_env) не будет иметь никакого эффекта.

Changelog

Изменено в версии 1.1.0: Это dict вместо ImmutableDict для более простой настройки.

json: JSONProvider¶

Предоставляет доступ к методам JSON. Функции в flask.json будут вызывать методы этого провайдера, когда контекст приложения активен. Используется для обработки запросов и ответов JSON.

Экземпляр json_provider_class. Может быть настроен путем изменения этого атрибута в подклассе или путем последующего присвоения этому атрибуту.

По умолчанию, DefaultJSONProvider, используется встроенная библиотека Python json. Другой провайдер может использовать другую библиотеку JSON.

Добавлено в версии 2.2.

property json_decoder: Type[JSONDecoder]¶

Класс декодера JSON, который будет использоваться. По умолчанию JSONDecoder.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого настройте json_provider_class.

Changelog

Добавлено в версии 0.10.

property json_encoder: Type[JSONEncoder]¶

Класс кодировщика JSON, который будет использоваться. По умолчанию используется JSONEncoder.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого настройте json_provider_class.

Changelog

Добавлено в версии 0.10.

json_provider_class¶

alias of DefaultJSONProvider

log_exception(exc_info)¶

Записывает исключение в журнал. Вызывается handle_exception(), если отладка отключена, и непосредственно перед вызовом обработчика. Реализация по умолчанию регистрирует исключение как ошибку на logger.

Changelog

Добавлено в версии 0.8.

Параметры:

exc_info (Union[Tuple[type, BaseException, TracebackType], Tuple[None, None, None]]) –

Тип результата:

None

property logger: Logger¶

Стандартный Python Logger для приложения, с тем же именем, что и name.

В режиме отладки значение level регистратора будет установлено на DEBUG.

Если обработчики не настроены, будет добавлен обработчик по умолчанию. Для получения дополнительной информации смотрите Ведение журнала.

Changelog

Изменено в версии 1.1.0: Регистратор принимает то же имя, что и name, вместо жесткого кодирования "flask.app".

Изменено в версии 1.0.0: Поведение было упрощено. Регистратор всегда имеет имя "flask.app". Уровень устанавливается только во время конфигурации, он не проверяет app.debug каждый раз. Используется только один формат, а не разные в зависимости от app.debug. Никакие обработчики не удаляются, а добавляется обработчик только в том случае, если ни один из них еще не сконфигурирован.

Добавлено в версии 0.3.

make_aborter()¶

Создайте объект, который будет присвоен aborter. Этот объект вызывается flask.abort(), чтобы поднять ошибки HTTP, а также может быть вызван напрямую.

По умолчанию создается экземпляр aborter_class, который по умолчанию равен werkzeug.exceptions.Aborter.

Добавлено в версии 2.2.

Тип результата:

Aborter

make_config(instance_relative=False)¶

Используется для создания атрибута config конструктором Flask. Параметр instance_relative передается из конструктора Flask (там он называется instance_relative_config) и указывает, должен ли конфиг быть относительным к пути экземпляра или корневому пути приложения.

Changelog

Добавлено в версии 0.8.

Параметры:

instance_relative (bool) –

Тип результата:

Config

make_default_options_response()¶

Этот метод вызывается для создания ответа по умолчанию OPTIONS. Его можно изменить с помощью подклассов, чтобы изменить поведение ответов по умолчанию OPTIONS.

Changelog

Добавлено в версии 0.7.

Тип результата:

Response

make_response(rv)¶

Преобразование возвращаемого значения из функции представления в экземпляр response_class.

Параметры:

rv (Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]) – возвращаемое значение из функции представления. Функция представления должна возвращать ответ. Возврат None или завершение представления без возврата не допускается. Для view_rv допускаются следующие типы: str Создается объект ответа со строкой, закодированной в UTF-8 в качестве тела. bytes Создается объект ответа с байтами в качестве тела. dict Словарь, который будет преобразован в jsonify перед возвратом. list Список, который будет подвергнут jsonify’s перед возвратом. generator или iterator Генератор, который возвращает str или bytes для потоковой передачи в качестве ответа. tuple Либо (body, status, headers), (body, status), либо (body, headers), где body - любой из других типов, разрешенных здесь, status - строка или целое число, а headers - словарь или список кортежей (key, value). Если body является экземпляром response_class, status перезаписывает выходящее значение и headers расширяется. response_class Объект возвращается без изменений. other Response class Объект принуждается к response_class. callable() Функция вызывается как приложение WSGI. Результат используется для создания объекта ответа.

Тип результата:

Response

Изменено в версии 2.2: Генератор будет преобразован в потоковый ответ. Список будет преобразован в ответ в формате JSON.

Changelog

Изменено в версии 1.1: Диктант будет преобразован в ответ в формате JSON.

Изменено в версии 0.9: Ранее кортеж интерпретировался как аргументы для объекта ответа.

make_shell_context()¶

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

Changelog

Добавлено в версии 0.11.

Тип результата:

dict

property name: str¶

Имя приложения. Обычно это имя импорта с той разницей, что оно угадывается из файла запуска, если имя импорта - main. Это имя используется в качестве отображаемого имени, когда Flask требуется имя приложения. Его можно установить и переопределить, чтобы изменить значение.

Changelog

Добавлено в версии 0.8.

open_instance_resource(resource, mode='rb')¶

Открывает ресурс из папки экземпляра приложения (instance_path). В остальном работает как open_resource(). Ресурсы экземпляра также могут быть открыты для записи.

Параметры:

• resource (str) – имя ресурса. Для доступа к ресурсам во вложенных папках используйте прямые косые черты в качестве разделителя.

• mode (str) – режим открытия файла ресурса, по умолчанию „rb“.

Тип результата:

IO

open_resource(resource, mode='rb')¶

Открыть для чтения файл ресурсов относительно root_path.

Например, если файл schema.sql находится рядом с файлом app.py, в котором определено приложение Flask, его можно открыть с помощью:

with app.open_resource("schema.sql") as f:
    conn.executescript(f.read())

Параметры:

• resource (str) – Путь к ресурсу относительно root_path.

• mode (str) – Открыть файл в данном режиме. Поддерживается только чтение, допустимые значения - «r» (или «rt») и «rb».

Тип результата:

IO

patch(rule, **options)¶

Сокращение для route() с methods=["PATCH"].

Changelog

Добавлено в версии 2.0.

Параметры:

• rule (str) –

• options (Any) –

Тип результата:

Callable[[T_route], T_route]

permanent_session_lifetime¶

timedelta, который используется для установки даты истечения срока действия постоянной сессии. По умолчанию это 31 день, что позволяет постоянной сессии существовать примерно один месяц.

Этот атрибут также может быть настроен из конфигурации с помощью ключа конфигурации PERMANENT_SESSION_LIFETIME. По умолчанию установлено значение timedelta(days=31).

post(rule, **options)¶

Сокращение для route() с methods=["POST"].

Changelog

Добавлено в версии 2.0.

Параметры:

• rule (str) –

• options (Any) –

Тип результата:

Callable[[T_route], T_route]

preprocess_request()¶

Вызывается перед диспетчеризацией запроса. Вызывает url_value_preprocessors, зарегистрированный в приложении, и текущий blueprint (если есть). Затем вызывает before_request_funcs, зарегистрированный в приложении и блюпринте.

Если какой-либо обработчик before_request() возвращает значение не None, это значение обрабатывается так, как если бы это было возвращаемое значение из представления, и дальнейшая обработка запроса прекращается.

Тип результата:

Optional[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, …]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], WSGIApplication]]

process_response(response)¶

Может быть переопределена для изменения объекта ответа перед его отправкой на сервер WSGI. По умолчанию будут вызываться все декорированные функции after_request().

Changelog

Изменено в версии 0.5: Начиная с версии Flask 0.5 функции, зарегистрированные для выполнения после запроса, вызываются в обратном порядке регистрации.

Параметры:

response (Response) – объект response_class.

Результат:

новый объект ответа или тот же самый, должен быть экземпляром response_class.

Тип результата:

Response

property propagate_exceptions: bool¶

Возвращает значение конфигурационного значения PROPAGATE_EXCEPTIONS в случае, если оно установлено, иначе возвращается разумное значение по умолчанию.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3.

Changelog

Добавлено в версии 0.7.

put(rule, **options)¶

Сокращение для route() с methods=["PUT"].

Changelog

Добавлено в версии 2.0.

Параметры:

• rule (str) –

• options (Any) –

Тип результата:

Callable[[T_route], T_route]

redirect(location, code=302)¶

Создайте объект ответа перенаправления.

Она вызывается командой flask.redirect(), а также может быть вызвана напрямую.

Параметры:

• location (str) – URL-адрес для перенаправления.

• code (int) – Код состояния для перенаправления.

Тип результата:

Response

Добавлено в версии 2.2: Перемещено из flask.redirect, который вызывает этот метод.

register_blueprint(blueprint, **options)¶

Зарегистрировать Blueprint в приложении. Аргументы ключевых слов, переданные в этот метод, переопределяют значения по умолчанию, установленные в чертеже.

Вызывает метод register() blueprint после записи blueprint в blueprints приложения.

Параметры:

• blueprint (Blueprint) – Чертеж для регистрации.

• url_prefix – Маршруты чертежей будут иметь этот префикс.

• subdomain – Маршруты Blueprint будут соответствовать этому поддомену.

• url_defaults – Маршруты Blueprint будут использовать эти значения по умолчанию для аргументов представления.

• options (Any) – Дополнительные аргументы ключевых слов передаются в BlueprintSetupState. К ним можно получить доступ в обратных вызовах record().

Тип результата:

None

Changelog

Изменено в версии 2.0.1: Опция name может быть использована для изменения (предварительно начертанного) имени, под которым зарегистрирован чертеж. Это позволяет регистрировать один и тот же чертеж несколько раз с уникальными именами url_for.

Добавлено в версии 0.7.

register_error_handler(code_or_exception, f)¶

Альтернативная функция присоединения ошибки к декоратору errorhandler(), более простая для использования без декоратора.

Changelog

Добавлено в версии 0.7.

Параметры:

• code_or_exception (Union[Type[Exception], int]) –

• f (Callable[[Any], Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]]) –

Тип результата:

None

request_class¶

alias of Request

request_context(environ)¶

Создайте RequestContext, представляющий среду WSGI. Используйте блок with для толчка контекста, который заставит request указывать на этот запрос.

См. Контекст запроса.

Обычно не следует вызывать этот контекст из собственного кода. Контекст запроса автоматически подталкивается wsgi_app() при обработке запроса. Используйте test_request_context() для создания среды и контекста вместо этого метода.

Параметры:

environ (dict) – среда WSGI

Тип результата:

RequestContext

response_class¶

alias of Response

root_path¶

Абсолютный путь к пакету в файловой системе. Используется для поиска ресурсов, содержащихся в пакете.

route(rule, **options)¶

Украшает функцию представления, чтобы зарегистрировать ее с заданным правилом URL и опциями. Вызывает add_url_rule(), в котором есть более подробная информация о реализации.

@app.route("/")
def index():
    return "Hello, World!"

См. Регистрация маршрутов URL.

Имя конечной точки маршрута по умолчанию соответствует имени функции представления, если не передан параметр endpoint.

Параметр methods по умолчанию имеет значение ["GET"]. HEAD и OPTIONS добавляются автоматически.

Параметры:

• rule (str) – Строка правила URL.

• options (Any) – Дополнительные параметры, передаваемые объекту Rule.

Тип результата:

Callable[[T_route], T_route]

run(host=None, port=None, debug=None, load_dotenv=True, **options)¶

Запускает приложение на локальном сервере разработки.

Не используйте run() в производственных условиях. Он не предназначен для удовлетворения требований безопасности и производительности производственного сервера. Вместо этого смотрите Развертывание в производство для рекомендаций по использованию сервера WSGI.

Если установлен флаг debug, сервер будет автоматически перезагружаться при изменении кода и показывать отладчик в случае возникновения исключения.

Если вы хотите запустить приложение в режиме отладки, но отключить выполнение кода в интерактивном отладчике, вы можете передать use_evalex=False в качестве параметра. Это сохранит экран трассировки отладчика активным, но отключит выполнение кода.

Не рекомендуется использовать эту функцию для разработки с автоматической перезагрузкой, так как она плохо поддерживается. Вместо этого следует использовать поддержку flask скрипта командной строки run.

Имейте в виду

Flask будет подавлять любую ошибку сервера с помощью обычной страницы ошибок, если только он не находится в режиме отладки. Таким образом, чтобы включить только интерактивный отладчик без перезагрузки кода, необходимо вызвать run() с debug=True и use_reloader=False. Установка use_debugger на True без режима отладки не приведет к перехвату исключений, потому что их просто не будет.

Параметры:

• host (Optional[str]) – имя хоста для прослушивания. Установите значение '0.0.0.0', чтобы сервер был доступен и извне. По умолчанию установлено значение '127.0.0.1' или хост в конфигурационной переменной SERVER_NAME, если она присутствует.

• port (Optional[int]) – порт веб-сервера. По умолчанию равен 5000 или порту, определенному в конфигурационной переменной SERVER_NAME, если она присутствует.

• debug (Optional[bool]) – если задан, включает или выключает режим отладки. См. debug.

• load_dotenv (bool) – Загружает ближайшие файлы .env и .flaskenv для установки переменных окружения. Также изменит рабочий каталог на каталог, содержащий первый найденный файл.

• options (Any) – опции, которые должны быть переданы базовому серверу Werkzeug. Дополнительную информацию см. в разделе werkzeug.serving.run_simple().

Тип результата:

None

Changelog

Изменено в версии 1.0: Если он установлен, python-dotenv будет использоваться для загрузки переменных окружения из файлов .env и .flaskenv.

Переменная окружения FLASK_DEBUG будет переопределять debug.

По умолчанию включен многопоточный режим.

Изменено в версии 0.10: Порт по умолчанию теперь выбирается из переменной SERVER_NAME.

secret_key¶

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

Этот атрибут также может быть настроен из конфигурации с помощью ключа конфигурации SECRET_KEY. По умолчанию установлено значение None.

select_jinja_autoescape(filename)¶

Возвращает True, если для заданного имени шаблона должна быть активна автозамена. Если имя шаблона не задано, возвращается True.

Изменено в версии 2.2: Автозавершение теперь включено по умолчанию для файлов .svg.

Changelog

Добавлено в версии 0.5.

Параметры:

filename (str) –

Тип результата:

bool

property send_file_max_age_default: Optional[timedelta]¶

Значение по умолчанию для max_age для send_file(). По умолчанию используется значение None, которое указывает браузеру использовать условные запросы вместо таймерного кэша.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого используйте app.config["SEND_FILE_MAX_AGE_DEFAULT"].

Changelog

Изменено в версии 2.0: По умолчанию вместо 12 часов установлено значение None.

send_static_file(filename)¶

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

Changelog

Добавлено в версии 0.5.

Параметры:

filename (str) –

Тип результата:

Response

property session_cookie_name: str¶

Имя файла cookie, установленного интерфейсом сеанса.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого используйте app.config["SESSION_COOKIE_NAME"].

session_interface: SessionInterface = <flask.sessions.SecureCookieSessionInterface object>¶

используемый интерфейс сеанса. По умолчанию здесь используется экземпляр SecureCookieSessionInterface.

Changelog

Добавлено в версии 0.8.

shell_context_processor(f)¶

Регистрирует функцию контекстного процессора оболочки.

Changelog

Добавлено в версии 0.11.

Параметры:

f (T_shell_context_processor) –

Тип результата:

T_shell_context_processor

shell_context_processors: t.List[ft.ShellContextProcessorCallable]¶

Список функций процессора контекста оболочки, которые должны быть запущены при создании контекста оболочки.

Changelog

Добавлено в версии 0.11.

should_ignore_error(error)¶

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

Changelog

Добавлено в версии 0.10.

Параметры:

error (Optional[BaseException]) –

Тип результата:

bool

property static_folder: Optional[str]¶

Абсолютный путь к настроенной статической папке. None, если статическая папка не задана.

property static_url_path: Optional[str]¶

Префикс URL, с которого будет доступен статический маршрут.

Если он не был настроен во время init, он берется из static_folder.

teardown_appcontext(f)¶

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

with app.app_context():
    ...

Когда блок with завершается (или вызывается ctx.pop()), функции разрыва вызываются непосредственно перед тем, как контекст приложения становится неактивным. Поскольку контекст запроса обычно также управляет контекстом приложения, он также будет вызван при разрыве контекста запроса.

Если функция разрыва была вызвана из-за необработанного исключения, ей будет передан объект ошибки. Если зарегистрирован errorhandler(), он обработает исключение, и функция разрыва не получит его.

Функции разрушения должны избегать создания исключений. Если они выполняют код, который может завершиться неудачей, они должны окружить этот код блоком try/except и регистрировать все ошибки.

Возвращаемые значения функций разрыва игнорируются.

Changelog

Добавлено в версии 0.9.

Параметры:

f (T_teardown) –

Тип результата:

T_teardown

teardown_appcontext_funcs: t.List[ft.TeardownCallable]¶

Список функций, которые вызываются при разрушении контекста приложения. Поскольку контекст приложения также разрушается при завершении запроса, это место для хранения кода, который отсоединяется от баз данных.

Changelog

Добавлено в версии 0.9.

teardown_request(f)¶

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

with app.test_request_context():
    ...

Когда блок with завершается (или вызывается ctx.pop()), функции разрыва вызываются непосредственно перед тем, как контекст запроса становится неактивным.

Если функция разрыва была вызвана из-за необработанного исключения, ей будет передан объект ошибки. Если зарегистрирован errorhandler(), он обработает исключение, и функция разрыва не получит его.

Функции разрушения должны избегать создания исключений. Если они выполняют код, который может завершиться неудачей, они должны окружить этот код блоком try/except и регистрировать все ошибки.

Возвращаемые значения функций разрыва игнорируются.

Эта функция доступна как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция выполняется после каждого запроса. При использовании на blueprint, это выполняется после каждого запроса, который обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и выполнять после каждого запроса, используйте Blueprint.teardown_app_request().

Параметры:

f (T_teardown) –

Тип результата:

T_teardown

teardown_request_funcs: t.Dict[ft.AppOrBlueprintKey, t.List[ft.TeardownCallable]]¶

Структура данных функций для вызова в конце каждого запроса, даже если возникло исключение, в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None - для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор teardown_request().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

template_context_processors: t.Dict[ft.AppOrBlueprintKey, t.List[ft.TemplateContextProcessorCallable]]¶

Структура данных функций, вызываемых для передачи дополнительных значений контекста при рендеринге шаблонов, в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None - для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор context_processor().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

template_filter(name=None)¶

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

@app.template_filter()
def reverse(s):
    return s[::-1]

Параметры:

name (Optional[str]) – необязательное имя фильтра, иначе будет использовано имя функции.

Тип результата:

Callable[[T_template_filter], T_template_filter]

template_folder¶

Путь к папке templates, относительно root_path, для добавления в загрузчик шаблонов. None, если шаблоны не должны добавляться.

template_global(name=None)¶

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

@app.template_global()
def double(n):
    return 2 * n

Changelog

Добавлено в версии 0.10.

Параметры:

name (Optional[str]) – необязательное имя глобальной функции, иначе будет использовано имя функции.

Тип результата:

Callable[[T_template_global], T_template_global]

template_test(name=None)¶

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

@app.template_test()
def is_prime(n):
    if n == 2:
        return True
    for i in range(2, int(math.ceil(math.sqrt(n))) + 1):
        if n % i == 0:
            return False
    return True

Changelog

Добавлено в версии 0.10.

Параметры:

name (Optional[str]) – необязательное имя теста, иначе будет использовано имя функции.

Тип результата:

Callable[[T_template_test], T_template_test]

property templates_auto_reload: bool¶

Перезагрузка шаблонов при их изменении. Используется командой create_jinja_environment(). По умолчанию включена в режиме отладки.

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого используйте app.config["TEMPLATES_AUTO_RELOAD"].

Changelog

Добавлено в версии 1.0: Это свойство было добавлено, но базовая конфигурация и поведение уже существовали.

test_cli_runner(**kwargs)¶

Создайте CLI runner для тестирования команд CLI. Смотрите Выполнение команд с помощью программы CLI Runner.

Возвращает экземпляр test_cli_runner_class, по умолчанию FlaskCliRunner. В качестве первого аргумента передается объект приложения Flask.

Changelog

Добавлено в версии 1.0.

Параметры:

kwargs (Any) –

Тип результата:

FlaskCliRunner

test_cli_runner_class: Optional[Type[FlaskCliRunner]] = None¶

Подкласс CliRunner, по умолчанию FlaskCliRunner, который используется test_cli_runner(). Его метод __init__ должен принимать в качестве первого аргумента объект Flask app.

Changelog

Добавлено в версии 1.0.

test_client(use_cookies=True, **kwargs)¶

Создает тестовый клиент для этого приложения. Для получения информации о модульном тестировании перейдите по ссылке Тестирование приложений Flask.

Обратите внимание, что если вы тестируете утверждения или исключения в коде вашего приложения, вы должны установить app.testing = True для того, чтобы исключения распространялись на тестовый клиент. В противном случае исключение будет обрабатываться приложением (не видимым для тестового клиента), и единственным признаком ошибки AssertionError или другого исключения будет ответ с кодом состояния 500 на тестовом клиенте. См. атрибут testing. Например:

app.testing = True
client = app.test_client()

Тестовый клиент можно использовать в блоке with, чтобы отложить закрытие контекста до конца блока with. Это полезно, если вы хотите получить доступ к локалям контекста для тестирования:

with app.test_client() as c:
    rv = c.get('/?vodka=42')
    assert request.args['vodka'] == '42'

Кроме того, вы можете передать необязательные ключевые аргументы, которые затем будут переданы в конструктор приложения test_client_class. Например:

from flask.testing import FlaskClient

class CustomClient(FlaskClient):
    def __init__(self, *args, **kwargs):
        self._authentication = kwargs.pop("authentication")
        super(CustomClient,self).__init__( *args, **kwargs)

app.test_client_class = CustomClient
client = app.test_client(authentication='Basic ....')

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

Changelog

Изменено в версии 0.11: Добавлено **kwargs для поддержки передачи дополнительных аргументов ключевых слов в конструктор test_client_class.

Добавлено в версии 0.7: Был добавлен параметр use_cookies, а также возможность переопределения используемого клиента путем установки атрибута test_client_class.

Изменено в версии 0.4: добавлена поддержка использования блока with для клиента.

Параметры:

• use_cookies (bool) –

• kwargs (Any) –

Тип результата:

FlaskClient

test_client_class: Optional[Type[FlaskClient]] = None¶

Метод test_client() создает экземпляр данного класса тестового клиента. По умолчанию имеет значение FlaskClient.

Changelog

Добавлено в версии 0.7.

test_request_context(*args, **kwargs)¶

Создайте RequestContext для среды WSGI, созданной из заданных значений. Это в основном полезно при тестировании, когда вы можете захотеть запустить функцию, которая использует данные запроса без отправки полного запроса.

См. Контекст запроса.

Используйте блок with для выталкивания контекста, который заставит request указать на запрос созданного окружения.

with test_request_context(...):
    generate_report()

При использовании оболочки может быть проще нажимать и разворачивать контекст вручную, чтобы избежать отступов.

ctx = app.test_request_context(...)
ctx.push()
...
ctx.pop()

Принимает те же аргументы, что и Werkzeug’s EnvironBuilder, с некоторыми значениями по умолчанию от приложения. Большинство доступных аргументов см. в документации Werkzeug по ссылке. Поведение, специфичное для Flask, перечислено здесь.

Параметры:

• path – Запрашиваемый путь URL.

• base_url – Базовый URL, по которому обслуживается приложение, который path является относительным. Если не указан, строится из PREFERRED_URL_SCHEME, subdomain, SERVER_NAME и APPLICATION_ROOT.

• subdomain – Имя субдомена для добавления к SERVER_NAME.

• url_scheme – Схема для использования вместо PREFERRED_URL_SCHEME.

• data – Тело запроса, либо в виде строки, либо в виде диктанта ключей и значений формы.

• json – Если задано, это сериализуется как JSON и передается как data. Также по умолчанию content_type имеет значение application/json.

• args (Any) – другие позиционные аргументы, переданные в EnvironBuilder.

• kwargs (Any) – другие аргументы ключевых слов, переданные в EnvironBuilder.

Тип результата:

RequestContext

testing¶

Флаг тестирования. Установите это значение True, чтобы включить режим тестирования расширений Flask (а в будущем, возможно, и самой Flask). Например, это может активировать тестовые помощники, которые имеют дополнительные затраты времени выполнения и не должны быть включены по умолчанию.

Если это включено, а PROPAGATE_EXCEPTIONS не изменен по умолчанию, то он неявно включен.

Этот атрибут также может быть настроен из конфигурации с помощью ключа конфигурации TESTING. По умолчанию установлено значение False.

trap_http_exception(e)¶

Проверяет, следует ли перехватывать исключение HTTP или нет. По умолчанию возвращает False для всех исключений, кроме ошибки плохого ключа запроса, если TRAP_BAD_REQUEST_ERRORS имеет значение True. Он также возвращает True, если TRAP_HTTP_EXCEPTIONS имеет значение True.

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

Changelog

Изменено в версии 1.0: Ошибки плохого запроса не отлавливаются по умолчанию в режиме отладки.

Добавлено в версии 0.8.

Параметры:

e (Exception) –

Тип результата:

bool

update_template_context(context)¶

Обновление контекста шаблона с некоторыми часто используемыми переменными. При этом в контекст шаблона вводятся request, session, config и g, а также все, что хотят ввести обработчики контекста шаблона. Обратите внимание, что начиная с версии Flask 0.6, исходные значения в контексте не будут отменены, если обработчик контекста решит вернуть значение с тем же ключом.

Параметры:

context (dict) – контекст в виде словаря, который обновляется на месте для добавления дополнительных переменных.

Тип результата:

None

url_build_error_handlers: t.List[t.Callable[[Exception, str, t.Dict[str, t.Any]], str]]¶

Список функций, которые вызываются handle_url_build_error(), когда url_for() вызывает BuildError. Каждая функция вызывается с помощью error, endpoint и values. Если функция возвращает None или вызывает BuildError, она пропускается. В противном случае ее возвращаемое значение возвращается с помощью url_for.

Changelog

Добавлено в версии 0.9.

url_default_functions: t.Dict[ft.AppOrBlueprintKey, t.List[ft.URLDefaultCallable]]¶

Структура данных функций, вызываемых для изменения аргументов ключевых слов при генерации URL, в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None - для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор url_defaults().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

url_defaults(f)¶

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

Эта функция доступна как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция вызывается для каждого запроса. При использовании на blueprint, это вызывается для запросов, которые обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и влиять на каждый запрос, используйте Blueprint.app_url_defaults().

Параметры:

f (T_url_defaults) –

Тип результата:

T_url_defaults

url_for(endpoint, *, _anchor=None, _method=None, _scheme=None, _external=None, **values)¶

Генерирует URL-адрес к заданной конечной точке с заданными значениями.

Она вызывается командой flask.url_for(), а также может быть вызвана напрямую.

Конечная точка* - это имя правила URL, обычно добавляемое с помощью @app.route() и обычно совпадающее с именем функции представления. Маршрут, определенный в Blueprint, добавит к конечной точке имя чертежа, разделенное ..

В некоторых случаях, например, в сообщениях электронной почты, вы хотите, чтобы URL включали схему и домен, например https://example.com/hello. Когда нет активного запроса, URL по умолчанию будут внешними, но для этого нужно настроить SERVER_NAME, чтобы Flask знал, какой домен использовать. APPLICATION_ROOT и PREFERRED_URL_SCHEME также должны быть настроены по мере необходимости. Эта конфигурация используется только тогда, когда нет активного запроса.

Функции могут быть украшены url_defaults() для изменения аргументов ключевых слов до построения URL.

Если сборка не удается по какой-то причине, например, неизвестная конечная точка или неверные значения, вызывается метод приложения handle_url_build_error(). Если этот метод возвращает строку, то она возвращается, в противном случае возникает ошибка BuildError.

Параметры:

• endpoint (str) – Имя конечной точки, связанное с генерируемым URL. Если оно начинается с ., будет использовано текущее имя чертежа (если оно есть).

• _anchor (Optional[str]) – Если задано, добавьте это как #anchor к URL.

• _method (Optional[str]) – Если задано, генерирует URL, связанный с этим методом, для конечной точки.

• _scheme (Optional[str]) – Если задано, то URL будет иметь эту схему, если он является внешним.

• _external (Optional[bool]) – Если задано, предпочтительно, чтобы URL был внутренним (False) или требуется, чтобы он был внешним (True). Внешние URL включают схему и домен. Когда URL не находится в активном запросе, он по умолчанию является внешним.

• values (Any) – Значения, используемые для переменных частей правила URL. Неизвестные ключи добавляются в качестве аргументов строки запроса, например ?a=b&c=d.

Тип результата:

str

Добавлено в версии 2.2: Перемещено из flask.url_for, который вызывает этот метод.

url_map¶

Значение Map для данного экземпляра. Вы можете использовать его для изменения конвертеров маршрутизации после создания класса, но до подключения каких-либо маршрутов. Пример:

from werkzeug.routing import BaseConverter

class ListConverter(BaseConverter):
    def to_python(self, value):
        return value.split(',')
    def to_url(self, values):
        return ','.join(super(ListConverter, self).to_url(value)
                        for value in values)

app = Flask(__name__)
app.url_map.converters['list'] = ListConverter

url_map_class¶

alias of Map

url_rule_class¶

alias of Rule

url_value_preprocessor(f)¶

Зарегистрируйте функцию препроцессора значений URL для всех функций представления в приложении. Эти функции будут вызываться перед функциями before_request().

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

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

Эта функция доступна как для объектов приложения, так и для объектов чертежа. При использовании в приложении эта функция вызывается для каждого запроса. При использовании на blueprint, это вызывается для запросов, которые обрабатывает blueprint. Чтобы зарегистрироваться в blueprint и влиять на каждый запрос, используйте Blueprint.app_url_value_preprocessor().

Параметры:

f (T_url_value_preprocessor) –

Тип результата:

T_url_value_preprocessor

url_value_preprocessors: t.Dict[ft.AppOrBlueprintKey, t.List[ft.URLValuePreprocessorCallable]]¶

Структура данных функций, вызываемых для изменения аргументов ключевых слов, переданных функции представления, в формате {scope: [functions]}. Ключ scope - это имя чертежа, для которого активны функции, или None для всех запросов.

Чтобы зарегистрировать функцию, используйте декоратор url_value_preprocessor().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

property use_x_sendfile: bool¶

Включите эту опцию, чтобы использовать функцию X-Sendfile, если сервер поддерживает ее, с send_file().

Не рекомендуется, начиная с версии 2.2: Будет удалена в версии Flask 2.3. Вместо этого используйте app.config["USE_X_SENDFILE"].

view_functions: t.Dict[str, t.Callable]¶

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

Чтобы зарегистрировать функцию представления, используйте декоратор route().

Эта структура данных является внутренней. Ее не следует изменять напрямую, и ее формат может измениться в любое время.

wsgi_app(environ, start_response)¶

Собственно приложение WSGI. Это не реализовано в __call__(), чтобы промежуточные модули можно было применять без потери ссылки на объект app. Вместо этого можно сделать следующее:

app = MyMiddleware(app)

Вместо этого лучше сделать следующее:

app.wsgi_app = MyMiddleware(app.wsgi_app)

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

Changelog

Изменено в версии 0.7: События Teardown для контекстов запроса и приложения вызываются, даже если произошла необработанная ошибка. Другие события могут не вызываться в зависимости от того, когда произошла ошибка во время диспетчеризации. См. Обратные вызовы и ошибки.

Параметры:

• environ (dict) – Среда WSGI.

• start_response (Callable) – Вызываемый объект, принимающий код состояния, список заголовков и необязательный контекст исключения для начала ответа.

Тип результата:

Any

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

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

Украшение функции чертежом создает отложенную функцию, которая вызывается с помощью BlueprintSetupState, когда чертеж регистрируется в приложении.

Для получения дополнительной информации см. раздел Модульные приложения с чертежами.

Параметры:

• name (str) – Имя чертежа. Будет добавлено к имени каждой конечной точки.

• import_name (str) – Имя пакета чертежа, обычно __name__. Это помогает найти root_path для чертежа.

• static_folder (Optional[Union[str, PathLike]]) – Папка со статическими файлами, которые должны обслуживаться статическим маршрутом чертежа. Путь является относительным к корневому пути blueprint’а. По умолчанию статические файлы чертежа отключены.

• static_url_path (Optional[str]) – url для обслуживания статических файлов. По умолчанию используется значение static_folder. Если у чертежа нет url_prefix, статический маршрут приложения будет иметь приоритет, и статические файлы чертежа будут недоступны.

• template_folder (Optional[Union[str, PathLike]]) – Папка с шаблонами, которые должны быть добавлены в путь поиска шаблонов приложения. Путь является относительным к корневому пути чертежа. По умолчанию шаблоны чертежей отключены. Шаблоны чертежей имеют более низкий приоритет, чем шаблоны в папке шаблонов приложения.

• url_prefix (Optional[str]) – Путь, который добавляется ко всем URL-адресам чертежа, чтобы они отличались от остальных маршрутов приложения.

• subdomain (Optional[str]) – Поддомен, с которым маршруты blueprint будут сопоставляться по умолчанию.

• url_defaults (Optional[dict]) – Диктант значений по умолчанию, которые маршруты blueprint будут получать по умолчанию.

• root_path (Optional[str]) – По умолчанию чертеж автоматически определяет этот путь на основе import_name. В некоторых ситуациях это автоматическое определение может не сработать, поэтому путь можно указать вручную.

• cli_group (Optional[str]) –

add_app_template_filter(f, name=None)¶

Регистрация фильтра шаблона, доступного в любом шаблоне, отображаемом приложением. Работает аналогично декоратору app_template_filter(). Эквивалентен Flask.add_template_filter().

Параметры:

• name (Optional[str]) – необязательное имя фильтра, иначе будет использовано имя функции.

• f (Callable[[...], Any]) –

Тип результата:

None

add_app_template_global(f, name=None)¶

Регистрирует глобальный шаблон, доступный в любом шаблоне, отображаемом приложением. Работает аналогично декоратору app_template_global(). Эквивалентен Flask.add_template_global().

Changelog

Добавлено в версии 0.10.

Параметры:

• name (Optional[str]) – необязательное имя глобала, иначе будет использовано имя функции.

• f (Callable[[...], Any]) –

Тип результата:

None

add_app_template_test(f, name=None)¶

Регистрация теста шаблона, доступного в любом шаблоне, отображаемом приложением. Работает аналогично декоратору app_template_test(). Эквивалентен Flask.add_template_test().

Changelog

Добавлено в версии 0.10.

Параметры:

• name (Optional[str]) – необязательное имя теста, иначе будет использовано имя функции.

• f (Callable[[...], bool]) –

Тип результата:

None

add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)¶

Зарегистрируйте правило URL в чертеже. Смотрите Flask.add_url_rule() для получения полной документации.

Правило URL имеет префикс URL чертежа. Имя конечной точки, используемое с url_for(), имеет префикс имени чертежа.

Параметры:

• rule (str) –

• endpoint (Optional[str]) –

• view_func (Optional[Union[Callable[[...], Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]], Callable[[...], Awaitable[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, List[Any], Mapping[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Mapping[str, Union[str, List[str], Tuple[str, ...]]], Sequence[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], WSGIApplication]]]]]) –

• provide_automatic_options (Optional[bool]) –

• options (Any) –

Тип результата:

None