API

Объект приложения

class flask.Flask(import_name, static_url_path=None, static_folder='static', static_host=None, host_matching=False, subdomain_matching=False, template_folder='templates', instance_path=None, instance_relative_config=False, root_path=None)

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

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

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

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

from flask import Flask
app = Flask(__name__)

О первом параметре

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

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

Например, если ваше приложение определено в yourapplication/app.py вы должны создать его с одной из двух версий ниже:

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

Почему это так? Приложение будет работать даже с __name__, благодаря тому, как ищутся ресурсы. Однако это усложнит отладку. Некоторые расширения могут делать предположения на основе имени импорта вашего приложения. Например, расширение Flask-SQLAlchemy будет искать код в вашем приложении, который вызвал запрос SQL в режиме отладки. Если имя импорта не настроено должным образом, эта информация для отладки теряется. (Например, он будет подбирать запросы SQL только в yourapplication.app и не в yourapplication.views.frontend).

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

В версии 1.0: Были добавлены параметры host_matching и static_host.

В версии 1.0: Был добавлен параметр subdomain_matching. Сопоставление по доменному имени теперь необходимо включать вручную. Установка SERVER_NAME не подразумевает его включения.

В версии 0.11: Был добавлен параметр root_path.

В версии 0.8: Были добавлены параметры instance_path и instance_relative_config.

В версии 0.7: Были добавлены параметры static_url_path, static_folder, и template_folder.

Параметры

• import_name (str) – имя пакета приложения
• static_url_path (Optional[str]) – может быть использован для указания другого пути для статических файлов в веб-приложении. По умолчанию используется имя папки static_folder.
• static_folder (Optional[Union[str, os.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[str]) – папка, содержащая шаблоны, которые должны использоваться приложением. По умолчанию папка 'templates' в корне приложения.
• instance_path (Optional[str]) – альтернативный путь к экземпляру приложения. По умолчанию предполагается, что папка 'instance' рядом с пакетом или модулем является путем к экземпляру.
• instance_relative_config (bool) – если установлено в True, предполагаются относительные имена файлов для загрузки конфигурации относительно пути к экземпляру, а не корня приложения.
• root_path (Optional[str]) – путь к корню файлов приложения. Это следует устанавливать вручную только в случае, если его невозможно определить автоматически, например, для пакетов имен.

add_template_filter(f, name=None)

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

Параметры

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

Тип возвращаемого значения

None

add_template_global(f, name=None)

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

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

В версии 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[Callable]) – Функция представления для связи с именем конечной точки.
• provide_automatic_options (Optional[bool]) – Добавить метод OPTIONS и автоматически обрабатывать запросы OPTIONS.
• options (Any) – Дополнительные параметры, передаваемые объекту Rule.

Тип возвращаемого значения

None

after_request(f)

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

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

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

Параметры

f (Callable[[Response], Response]) –

Тип возвращаемого значения

Callable[[Response], Response]

after_request_funcs: t.Dict[AppOrBlueprintKey, t.List[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.

Тип возвращаемого значения

flask.ctx.AppContext

app_ctx_globals_class

псевдоним flask.ctx._AppCtxGlobals

async_to_sync(func)

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

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)

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

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

Changelog

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

Параметры

f (Callable[[], None]) –

Тип возвращаемого значения

Callable[[], None]

before_first_request_funcs: t.List[BeforeFirstRequestCallable]

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

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, это значение обрабатывается так, как если бы это было возвращаемое значение из представления, и дальнейшая обработка запроса останавливается.

Параметры

f (Callable[[], Optional[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Dict[str, Union[str, List[str], Tuple[str, ...]]]], List[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Dict[str, Union[str, List[str], Tuple[str, ...]]], List[Tuple[str, Union[str,

Список[строка], Кортеж[строка, ...]]]]]], WSGIApplication]]]) –

Тип возвращаемого значения

Callable[[], Optional[Объединение[Response, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты], Кортеж[Объединение[Response, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], Кортеж[Объединение[Response, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое число], Кортеж[Объединение[Response, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое число, Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], WSGIApplication]]]

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

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

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

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

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

Сопоставление зарегистрированных имён blueprints с объектами blueprint. Словарь сохраняет порядок регистрации blueprints. Blueprints можно регистрировать несколько раз; этот словарь не отслеживает частоту их прикрепления.

Changelog

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

cli

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

config

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

config_class

Псевдоним для flask.config.Config

context_processor(f)

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

Параметры

f (Callable[[], Dict[str, Any]]) –

Тип возвращаемого значения

Callable[[], Dict[str, Any]]

create_global_jinja_loader()

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

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

Changelog

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

Тип возвращаемого значения

flask.templating.DispatchingJinjaLoader

create_jinja_environment()

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

Changelog

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

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

Тип возвращаемого значения

flask.templating.Environment

create_url_adapter(request)

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

Changelog

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

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

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

Параметры

request (Optional[flask.wrappers.Request]) –

Тип возвращаемого значения

Optional[werkzeug.routing.MapAdapter]

property debug: bool

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

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

Значение по умолчанию: True если env — 'development', или False в противном случае.

default_config = {'APPLICATION_ROOT': '/', 'DEBUG': None, 'ENV': None, 'EXPLAIN_TEMPLATE_LOADING': False, 'JSONIFY_MIMETYPE': 'application/json', 'JSONIFY_PRETTYPRINT_REGULAR': False, 'JSON_AS_ASCII': True, 'JSON_SORT_KEYS': True, 'MAX_CONTENT_LENGTH': None, 'MAX_COOKIE_SIZE': 4093, 'PERMANENT_SESSION_LIFETIME': datetime.timedelta(days=31), 'PREFERRED_URL_SCHEME': 'http', 'PRESERVE_CONTEXT_ON_EXCEPTION': None, '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[[flask.scaffold.F], flask.scaffold.F]

dispatch_request()

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

Изменения

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

Тип возвращаемого значения

Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое, Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], WSGIПриложение]

do_teardown_appcontext(exc=<object object>)

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

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

Это вызывает все функции, помеченные декоратором teardown_appcontext(). Затем отправляется сигнал appcontext_tearing_down.

Вызывается методом AppContext.pop().

Changelog

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

Parameters

exc (Optional[BaseException]) –

Return type

None

do_teardown_request(exc=<object object>)

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

Это вызывает все функции, помеченные декораторами teardown_request() и Blueprint.teardown_request(), если запрос обрабатывался планом. В заключение отправляется сигнал request_tearing_down.

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

Parameters

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

Return type

None

Changelog

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

endpoint(endpoint)

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

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

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

Parameters

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

Return type

Callable

ensure_sync(func)

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

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

Changelog

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

Parameters

func (Callable) –

Return type

Callable

env

Среда, в которой запущено приложение. Flask и расширения могут использовать поведение, основанное на среде, например, включение отладочного режима. Это сопоставляется с параметром конфигурации ENV. Устанавливается переменной среды FLASK_ENV, и может работать непредсказуемо, если установлена в коде.

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

Значение по умолчанию: 'production'

error_handler_spec: t.Dict[AppOrBlueprintKey, t.Dict[t.Optional[int], t.Dict[t.Type[Exception], '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

Changelog

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

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

Parameters

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

Return type

Callable[[ErrorHandlerCallable], ErrorHandlerCallable]

extensions: dict

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

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

Changelog

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

full_dispatch_request()

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

Changelog

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

Return type

flask.wrappers.Response

get(rule, **options)

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

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

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

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

get_send_file_max_age(filename)

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

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

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

Изменено в версии 2.0: Значение конфигурации по умолчанию None вместо 12 часов.

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

Параметры

filename (Optional[str]) –

Тип возвращаемого значения

Optional[int]

property got_first_request: bool

Этот атрибут установлен в True, если приложение начало обработку первого запроса.

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

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

handle_exception(e)

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

Всегда отправляет сигнал got_request_exception.

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

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

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

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

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

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

Параметры

e (Исключение) –

Тип возвращаемого значения

flask.wrappers.Response

handle_http_exception(e)

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

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

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

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

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

Параметры

e (werkzeug.exceptions.HTTPException) –

Тип возвращаемого значения

Union[werkzeug.exceptions.HTTPException, Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Dict[str, Union[str, List[str], Tuple[str, …]]], List[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Dict[str, Union[str, List[str], Tuple[str, …]]], List[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], WSGIApplication]

handle_url_build_error(error, endpoint, values)

Обработка BuildError при построении URL на url_for().

Параметры

• error (Исключение) –
• endpoint (строка) –
• values (словарь) –

Тип возвращаемого значения

строка

handle_user_exception(e)

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

Изменения

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

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

Параметры

e (Исключение) –

Тип возвращаемого значения

Union[werkzeug.exceptions.HTTPException, Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Dict[str, Union[str, List[str], Tuple[str, …]]], List[Tuple[str, Union[str, List[str], Tuple[str, …]]]]]], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Dict[str, Union[str, List[str], Tuple[str, …]]], List[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)

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

Changelog

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

Параметры

• endpoint (str) –
• values (dict) –

Тип возвращаемого значения

None

instance_path

Содержит путь к папке экземпляра.

Changelog

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

iter_blueprints()

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

Changelog

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

Тип возвращаемого значения

ValuesView[Blueprint]

property jinja_env: flask.templating.Environment

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

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

jinja_environment

псевдоним flask.templating.Environment

property jinja_loader: Optional[jinja2.loaders.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_decoder

псевдоним flask.json.JSONDecoder

json_encoder

псевдоним flask.json.JSONEncoder

log_exception(exc_info)

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

Changelog

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

Параметры

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

Тип возвращаемого значения

None

property logger: logging.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_config(instance_relative=False)

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

Changelog

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

Параметры

instance_relative (bool) –

Тип возвращаемого значения

flask.config.Config

make_default_options_response()

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

Changelog

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

Тип возвращаемого значения

flask.wrappers.Response

make_response(rv)

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

Параметры

rv (Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], Union[Headers, Dict[str, Union[str, List[str], Tuple[str, ...]]]], List[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int], Tuple[Union[Response, str, bytes, Dict[str, Any], Iterator[str], Iterator[bytes]], int, Union[Headers, Dict[str, Union[str, List[str], Tuple[str, ...]]], List[Tuple[str, Union[str, List[str], Tuple[str, ...]]]]]]]

Tuple[str, ...]]]]]], WSGIApplication]) –

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

str

Объект ответа создается со строкой, закодированной в UTF-8, в качестве тела.

bytes

Объект ответа создается с байтами в качестве тела.

dict

Словарь, который будет сериализован с помощью jsonify перед возвратом.

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. Результат используется для создания объекта ответа.

Тип возвращаемого значения

flask.wrappers.Response

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

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

make_shell_context()

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

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

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

Тип возвращаемого значения

dict

property name: str

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

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

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

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

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

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

permanent_session_lifetime

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

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

post(rule, **options)

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

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

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

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

preprocess_request()

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

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

Тип возвращаемого значения

Optional[Объединение[Response, str, bytes, Словарь[str, Любое], Итератор[str], Итератор[bytes], Кортеж[Объединение[Response, str, bytes, Словарь[str, Любое], Итератор[str], Итератор[bytes]], Объединение[Headers, Словарь[str, Объединение[str, Список[str], Кортеж[str, …]]], Список[Кортеж[str, Объединение[str, Список[str], Кортеж[str, …]]]]]], Кортеж[Объединение[Response, str, bytes, Словарь[str, Любое], Итератор[str], Итератор[bytes]], int], Кортеж[Объединение[Response, str, bytes, Словарь[str, Любое], Итератор[str], Итератор[bytes]], int, Объединение[Headers, Словарь[str, Объединение[str, Список[str], Кортеж[str, …]]], Список[Кортеж[str, Объединение[str, Список[str], Кортеж[str, …]]]]]], WSGIApplication]]

property preserve_context_on_exception: bool

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

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

Введено в версии 0.7.

process_response(response)

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

Changelog

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

Параметры

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

Возвращает

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

Тип возвращаемого значения

flask.wrappers.Response

property propagate_exceptions: bool

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

Changelog

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

put(rule, **options)

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

Changelog

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

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

register_blueprint(blueprint, **options)

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

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

Параметры

• blueprint (Blueprint) – Синий принтер для регистрации.
• url_prefix – Маршруты синего принтера будут иметь этот префикс.
• subdomain – Маршруты синего принтера будут соответствовать этому домену.
• url_defaults – Маршруты синего принтера будут использовать эти значения по умолчанию для аргументов представления.
• 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 (ErrorHandlerCallable) –

Тип возвращаемого значения

None

request_class

псевдоним для flask.wrappers.Request

request_context(environ)

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

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

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

Параметры

environ (dict) – среда WSGI

Тип возвращаемого значения

flask.ctx.RequestContext

response_class

псевдоним для flask.wrappers.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[[flask.scaffold.F], flask.scaffold.F]

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

Изменения

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

Если установлено, переменные окружения FLASK_ENV и FLASK_DEBUG переопределят env и debug.

Режим потоков включен по умолчанию.

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

secret_key

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

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

select_jinja_autoescape(filename)

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

Изменения

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

Параметры

filename (str) –

Тип возвращаемого значения

bool

send_file_max_age_default

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

Настраивается с помощью ключа конфигурации SEND_FILE_MAX_AGE_DEFAULT.

Изменения

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

send_static_file(filename)

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

Изменения

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

Параметры

filename (str) –

Тип возвращаемого значения

Response

session_cookie_name

Защищенные куки используют это имя для куки сессии.

Этот атрибут также можно настроить из конфигурации с помощью ключа конфигурации SESSION_COOKIE_NAME. По умолчанию 'session'

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

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

Изменения

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

shell_context_processor(f)

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

Изменения

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

Параметры

f (Callable) –

Тип возвращаемого значения

Callable

shell_context_processors: t.List[t.Callable[[], t.Dict[str, t.Any]]]

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

Изменения

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

should_ignore_error(error)

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

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

Новая функция в версии 0.10.

Параметры

error (Optional[BaseException]) –

Тип возвращаемого значения

bool

property static_folder: Optional[str]

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

property static_url_path: Optional[str]

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

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

teardown_appcontext(f)

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

Пример:

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

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

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

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

Значения возврата функций завершения игнорируются.

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

Новая функция в версии 0.9.

Параметры

f (Callable[[Optional[BaseException]], None]) –

Тип возвращаемого значения

Callable[[Optional[BaseException]], None]

teardown_appcontext_funcs: t.List[TeardownCallable]

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

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

Новая функция в версии 0.9.

teardown_request(f)

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

Пример:

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

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

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

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

Значения возврата функций завершения игнорируются.

Примечание для отладки

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

Параметры

f (Callable[[Optional[BaseException]], None]) –

Тип возвращаемого значения

Callable[[Optional[BaseException]], None]

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

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

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

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

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

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

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

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

template_filter(name=None)

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

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

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], Any]], Callable[[…], Any]]

template_folder

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

template_global(name=None)

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

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

Изменения

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

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], Any]], Callable[[…], Any]]

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

Изменения

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

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], bool]], Callable[[…], bool]]

property templates_auto_reload: bool

Перезагружать шаблоны при изменении. Используется create_jinja_environment().

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

Изменения

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

test_cli_runner(**kwargs)

Создать исполняемый файл командной строки для тестирования команд командной строки. См. Запуск команд с исполняемым файлом командной строки.

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

Изменения

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

Параметры

kwargs (Any) –

Тип возвращаемого значения

FlaskCliRunner

test_cli_runner_class: Optional[Type[FlaskCliRunner]] = None

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

Изменения

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

test_client(use_cookies=True, **kwargs)

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

Обратите внимание, что если вы тестируете утверждения или исключения в коде приложения, вы должны установить app.testing = True для распространения исключений на тестовый клиент. В противном случае исключение будет обработано приложением (невидимым для тестового клиента), и единственным указанием на ошибку утверждения или другое исключение будет ответ кода состояния 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 для получения дополнительной информации.

Изменения

Изменено в версии 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.

Изменения

Новая в версии 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()

Принимает те же аргументы, что и EnvironBuilder Werkzeug, с некоторыми значениями по умолчанию от приложения. Большинство доступных аргументов можно найти в документации 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.

Тип возвращаемого значения

flask.ctx.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.

Изменения

Изменено в версии 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, dict], str]]

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

Изменения

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

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

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

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

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

url_defaults(f)

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

Параметры

f (Callable[[str, dict], None]) –

Тип возвращаемого значения

Callable[[str, dict], None]

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

Псевдоним werkzeug.routing.Map

url_rule_class

Псевдоним werkzeug.routing.Rule

url_value_preprocessor(f)

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

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

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

Параметры

f (Callable[[Optional[str], Optional[dict]], None]) –

Тип возвращаемого значения

Callable[[Optional[str], Optional[dict]], None]

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

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

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

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

use_x_sendfile

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

Changelog

Новое в версии 0.2.

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

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

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

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

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

wsgi_app(environ, start_response)

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

app = MyMiddleware(app)

Лучше сделать так:

app.wsgi_app = MyMiddleware(app.wsgi_app)

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

Changelog

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

Параметры

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

Тип возвращаемого значения

Any

Объекты шаблонов

class flask.Blueprint(name, import_name, static_folder=None, static_url_path=None, template_folder=None, url_prefix=None, subdomain=None, url_defaults=None, root_path=None, cli_group=<object object>)

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

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

Декорирование функции шаблоном создаёт отложенную функцию, которая вызывается с BlueprintSetupState при регистрации шаблона в приложении.

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

Параметры

• name (str) – Имя шаблона. Будет добавлено к каждому имени конечной точки.
• import_name (str) – Имя пакета шаблона, обычно __name__. Это помогает найти root_path для шаблона.
• static_folder (Optional[Union[str, os.PathLike]]) – Папка со статическими файлами, которые должен обслуживать статический маршрут шаблона. Путь относительный к корню шаблона. Статические файлы шаблона по умолчанию отключены.
• static_url_path (Optional[str]) – URL для предоставления статических файлов. По умолчанию static_folder. Если у шаблона нет url_prefix, приоритет будет у статического маршрута приложения, и статические файлы шаблона будут недоступны.
• template_folder (Optional[str]) – Папка с шаблонами, которые должны быть добавлены в путь поиска шаблонов приложения. Путь относительный к корню шаблона. Шаблоны шаблона по умолчанию отключены. Шаблоны шаблона имеют более низкий приоритет, чем шаблоны в папке шаблонов приложения.
• url_prefix (Optional[str]) – Путь, который будет добавлен к всем URL шаблона, чтобы они отличались от маршрутов остальной части приложения.
• subdomain (Optional[str]) – Поддомен, по умолчанию соответствующий маршрутам шаблона.
• url_defaults (Optional[dict]) – Словарь значений по умолчанию, которые маршруты шаблона будут получать по умолчанию.
• root_path (Optional[str]) – По умолчанию шаблон автоматически устанавливает это значение на основе import_name. В некоторых ситуациях автоматическое определение может завершиться неудачно, поэтому путь можно указать вручную.
• cli_group (Optional[str]) –

Изменения

Изменено в версии 1.1.0: У шаблонов есть группа cli для регистрации вложенных команд CLI. Параметр cli_group управляет именем группы в рамках команды flask.

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

add_app_template_filter(f, name=None)

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

Параметры

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

Тип возвращаемого значения

None

add_app_template_global(f, name=None)

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

Изменения

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

Параметры

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

Тип возвращаемого значения

None

add_app_template_test(f, name=None)

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

Изменения

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

Параметры

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

Тип возвращаемого значения

None

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

Как Flask.add_url_rule(), но для шаблона. Конечная точка для функции url_for() имеет префикс с именем шаблона.

Параметры

• rule (str) –
• endpoint (Optional[str]) –
• view_func (Optional[Callable]) –
• provide_automatic_options (Optional[bool]) –
• options (Any) –

Тип возвращаемого значения

None

after_app_request(f)

Аналогично Flask.after_request(), но для шаблона. Такая функция выполняется после каждого запроса, даже если за пределами шаблона.

Параметры

f (Callable[[Response], Response]) –

Тип возвращаемого значения

Callable[[Response], Response]

after_request(f)

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

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

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

Параметры

f (Callable[[Response], Response]) –

Тип возвращаемого значения

Callable[[Response], Response]

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

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

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

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

app_context_processor(f)

Как Flask.context_processor(), но для шаблона. Такая функция выполняется каждый запрос, даже если за пределами шаблона.

Параметры

f (Callable[[], Dict[str, Any]]) –

Тип возвращаемого значения

Callable[[], Dict[str, Any]]

app_errorhandler(code)

Как Flask.errorhandler(), но для шаблона. Этот обработчик используется для всех запросов, даже если за пределами шаблона.

Параметры

code (Union[Type[Exception], int]) –

Тип возвращаемого значения

Callable

app_template_filter(name=None)

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

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], Any]], Callable[[…], Any]]

app_template_global(name=None)

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

Changelog

Новое в версии 0.10.

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], Any]], Callable[[…], Any]]

app_template_test(name=None)

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

Changelog

Новое в версии 0.10.

Параметры

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

Тип возвращаемого значения

Callable[[Callable[[…], bool]], Callable[[…], bool]]

app_url_defaults(f)

То же, что и url_defaults(), но применимо ко всему приложению.

Параметры

f (Callable[[str, dict], None]) –

Тип возвращаемого значения

Callable[[str, dict], None]

app_url_value_preprocessor(f)

То же, что и url_value_preprocessor(), но применимо ко всему приложению.

Параметры

f (Callable[[Optional[str], Optional[dict]], None]) –

Тип возвращаемого значения

Callable[[Optional[str], Optional[dict]], None]

before_app_first_request(f)

Как Flask.before_first_request(). Такая функция выполняется перед первым запросом к приложению.

Параметры

f (Callable[[], None]) –

Тип возвращаемого значения

Callable[[], None]

before_app_request(f)

Как Flask.before_request(). Такая функция выполняется перед каждым запросом, даже если она находится вне голубого плана.

Параметры

f (Callable[[], Optional[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]]]], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое число], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, любой], Итератор[строка], Итератор[байты]], целое число, Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]], Список[Кортеж[строка, Объединение[строка,

List[str], Tuple[str, ...]]]]]], WSGIApplication]]]) –

Тип возвращаемого значения

Callable[[], Optional[Объединение[Response, строка, байты, Словарь[строка, Любой], Итератор[строка], Итератор[байты], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любой], Итератор[строка], Итератор[байты]], Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любой], Итератор[строка], Итератор[байты]], целое число], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любой], Итератор[строка], Итератор[байты]], целое число, Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], WSGIApplication]]]

before_request(f)

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

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

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

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

Параметры

f (Callable[[], Optional[Объединение[Response, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]]]]], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], целое], Кортеж[Объединение[Response, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], целое, Объединение[Заголовки, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, ...]]], Список[Кортеж[строка, Объединение[строка,

List[str], Tuple[str, ...]]]]]], WSGIApplication]]]) –

Тип возвращаемого значения

Callable[[], Optional[Объединение[Ответ, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], целое число], Кортеж[Объединение[Ответ, строка, байты, Словарь[строка, Любое], Итератор[строка], Итератор[байты]], целое число, Объединение[Headers, Словарь[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]], Список[Кортеж[строка, Объединение[строка, Список[строка], Кортеж[строка, …]]]]]], WSGIApplication]]]

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

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

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

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

cli

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

context_processor(f)

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

Параметры

f (Callable[[], Dict[str, Any]]) –

Тип возвращаемого значения

Callable[[], Dict[str, Any]]

delete(rule, **options)

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

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

Введено в версии 2.0.

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

endpoint(endpoint)

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

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

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

Параметры

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

Тип возвращаемого значения

Callable

error_handler_spec: t.Dict[AppOrBlueprintKey, t.Dict[t.Optional[int], t.Dict[t.Type[Exception], '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

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

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

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

Параметры

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

Тип возвращаемого значения

Callable[[ErrorHandlerCallable], ErrorHandlerCallable]

get(rule, **options)

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

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

Введено в версии 2.0.

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

get_send_file_max_age(filename)

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

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

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

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

Введено в версии 0.9.

Параметры

filename (Optional[str]) –

Тип возвращаемого значения

Optional[int]

property has_static_folder: bool

True если static_folder задано.

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

Введено в версии 0.5.

import_name

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

property jinja_loader: Optional[jinja2.loaders.FileSystemLoader]

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

Changelog

Новое в версии 0.5.

json_decoder: t.Optional[t.Type[JSONDecoder]] = None

Локальный класс декодера JSON для использования в Blueprint. Установлено в None для использования декодера приложения json_decoder.

json_encoder: t.Optional[t.Type[JSONEncoder]] = None

Локальный класс кодировщика JSON для использования в Blueprint. Установлено в None для использования кодировщика приложения json_encoder.

make_setup_state(app, options, first_registration=False)

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

Параметры

• app (Flask) –
• options (dict) –
• first_registration (bool) –

Тип возвращаемого значения

flask.blueprints.BlueprintSetupState

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[[flask.scaffold.F], flask.scaffold.F]

post(rule, **options)

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

Changelog

Новое в версии 2.0.

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

put(rule, **options)

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

Changelog

Новое в версии 2.0.

Параметры

• rule (str) –
• options (Any) –

Тип возвращаемого значения

Callable[[flask.scaffold.F], flask.scaffold.F]

record(func)

Регистрирует функцию, которая вызывается при регистрации Blueprint в приложении. Эта функция вызывается с аргументом состояния, возвращаемым методом make_setup_state().

Параметры

func (Callable) –

Тип возвращаемого значения

None

record_once(func)

Работает подобно record(), но оборачивает функцию в другую функцию, гарантирующую, что функция вызывается только один раз. Если Blueprint регистрируется во второй раз в приложении, переданная функция не вызывается.

Параметры

func (Callable) –

Тип возвращаемого значения

None

register(app, options)

Вызывается методом Flask.register_blueprint() для регистрации всех представлений и обратных вызовов, зарегистрированных в модуле, в приложении. Создаёт объект BlueprintSetupState и вызывает каждый обратный вызов record() с ним.

Параметры

• app (Flask) – Приложение, с которым регистрируется этот модуль.
• options (dict) – Аргументы ключевого слова, переданные из register_blueprint().

Тип возвращаемого значения

None

Changelog

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

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

Изменено в версии 2.0.1: Регистрация одного и того же модуля с одинаковым именем несколько раз устарела и станет ошибкой в Flask 2.1.

register_blueprint(blueprint, **options)

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

Changelog

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

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

Параметры

• blueprint (flask.blueprints.Blueprint) –
• options (Any) –

Тип возвращаемого значения

None

register_error_handler(code_or_exception, f)

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

Changelog

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

Параметры

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

Тип возвращаемого значения

None

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[[flask.scaffold.F], flask.scaffold.F]

send_static_file(filename)

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

Changelog

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

Параметры

filename (str) –

Тип возвращаемого значения

Response

property static_folder: Optional[str]

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

property static_url_path: Optional[str]

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

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

teardown_app_request(f)

Аналогично Flask.teardown_request(), но для модуля. Такая функция выполняется при разборе каждого запроса, даже если она находится вне модуля.

Параметры

f (Callable[[Optional[BaseException]], None]) –

Тип возвращаемого значения

Callable[[Optional[BaseException]], None]

teardown_request(f)

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

Пример:

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

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

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

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

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

Debug Note

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

Параметры

f (Callable[[Optional[BaseException]], None]) –

Тип возвращаемого значения

Callable[[Optional[BaseException]], None]

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

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

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

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

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

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

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

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

template_folder

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

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

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

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

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

url_defaults(f)

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

Параметры

f (Callable[[str, dict], None]) –

Тип возвращаемого значения

Callable[[str, dict], None]

url_value_preprocessor(f)

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

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

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

Параметры

f (Callable[[Optional[str], Optional[dict]], None]) –

Тип возвращаемого значения

Callable[[Optional[str], Optional[dict]], None]

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

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

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

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

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

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

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

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

Данные входящего запроса

class flask.Request(environ, populate_request=True, shallow=False)

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

Он используется в качестве request. Если вы хотите заменить объект запроса, можно создать подкласс и установить request_class на ваш подкласс.

Объект запроса является подклассом Request и предоставляет все атрибуты, определенные Werkzeug, плюс несколько специфичных для Flask.

Параметры

• environ (WSGIEnvironment) –
• populate_request (bool) –
• shallow (bool) –

Тип возвращаемого значения

None

property accept_charsets: werkzeug.datastructures.CharsetAccept

Список кодировок символов, поддерживаемых клиентом в виде объекта CharsetAccept.

property accept_encodings: werkzeug.datastructures.Accept

Список кодировок, которые принимает клиент. Кодировки в терминологии HTTP представляют собой кодировки сжатия, такие как gzip. Для кодировок символов см. accept_charset.

property accept_languages: werkzeug.datastructures.LanguageAccept

Список языков, которые принимает клиент, в виде объекта LanguageAccept.

property accept_mimetypes: werkzeug.datastructures.MIMEAccept

Список MIME-типов, поддерживаемых клиентом в виде объекта MIMEAccept.

access_control_request_headers

Отправляется с запросом предварительного запроса для указания заголовков, которые будут отправлены с запросом к другому источнику. Установите access_control_allow_headers в ответе, чтобы указать разрешенные заголовки.

access_control_request_method

Отправляется с запросом предварительного запроса для указания метода, который будет использоваться для запроса к другому источнику. Установите access_control_allow_methods в ответе, чтобы указать разрешенные методы.

property access_route: List[str]

Если существует заголовок переадресации, это список всех IP-адресов от IP-адреса клиента до последнего прокси-сервера.

classmethod application(f)

Декорирует функцию как обработчик, который принимает запрос в качестве последнего аргумента. Это работает как декоратор responder(), но функции передаётся объект запроса в качестве последнего аргумента, и объект запроса будет закрыт автоматически:

@Request.application
def my_wsgi_app(request):
    return Response('Hello World!')

Начиная с Werkzeug 0.14, HTTP-исключения автоматически перехватываются и преобразуются в ответы вместо отказа.

Параметры

f (Callable[[Запрос], WSGIApplication]) – вызываемая WSGI-функция для декорирования

Возвращаемое значение

новая вызываемая WSGI-функция

Тип возвращаемого значения

WSGIApplication

property args: werkzeug.datastructures.MultiDict[str, str]

Анализированные параметры URL (часть URL после вопросительного знака).

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

property authorization: Optional[werkzeug.datastructures.Authorization]

Объект Authorization в проанализированной форме.

property base_url: str

Аналогично url, но без строки запроса.

property blueprint: Optional[str]

Зарегистрированное имя текущего проекта.

Будет None , если конечная точка не является частью проекта, или если сопоставление URL не выполнено или ещё не выполнено.

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

property blueprints: List[str]

Зарегистрированные имена текущего проекта и его родительских проектов.

Будет пустым списком, если текущий проект отсутствует или сопоставление URL не выполнено.

Изменения

Введено в версии 2.0.1.

property cache_control: werkzeug.datastructures.RequestCacheControl

Объект RequestCacheControl для входящих заголовков управления кэшем.

close()

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

Изменения

Введено в версии 0.9.

Тип возвращаемого значения

None

content_encoding

Поле заголовка сущности Content-Encoding используется как модификатор типа носителя. Если оно присутствует, его значение указывает, какие дополнительные кодировки содержимого были применены к телу сущности, и, следовательно, какие механизмы декодирования необходимо применить для получения типа носителя, указанного в поле заголовка Content-Type.

Изменения

Введено в версии 0.9.

property content_length: Optional[int]

Поле заголовка сущности Content-Length указывает размер тела сущности в байтах или, в случае метода HEAD, размер тела сущности, который был бы отправлен, если бы запрос был GET.

content_md5

Поле заголовка сущности Content-MD5, определенное в RFC 1864, является хэш-суммой MD5 тела сущности с целью обеспечения проверки целостности сообщения (MIC) тела сущности «от начала до конца». (Примечание: MIC подходит для обнаружения случайного изменения тела сущности во время передачи, но не является доказательством защиты от злонамеренных атак.)

Изменения

Введено в версии 0.9.

content_type

Поле заголовка сущности Content-Type указывает тип носителя тела сущности, отправляемого получателю, или, в случае метода HEAD, тип носителя, который был бы отправлен, если бы запрос был GET.

property cookies: werkzeug.datastructures.ImmutableMultiDict[str, str]

dict со содержимым всех cookie, переданных вместе с запросом.

property data: bytes

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

date

Поле заголовка Date обозначает дату и время, в которые было отправлено сообщение, имея такие же семантические значения, как и orig-date в RFC 822.

Изменения

Изменено в версии 2.0: Объект datetime имеет часовой пояс.

dict_storage_class

Псевдоним werkzeug.datastructures.ImmutableMultiDict

property endpoint: Optional[str]

Конечная точка, которая соответствует URL запроса.

Будет None в случае неудачного сопоставления или если оно ещё не выполнено.

В сочетании с view_args может быть использовано для восстановления исходного URL или его модифицированной версии.

environ: WSGIEnvironment

WSGI-среда, содержащая HTTP-заголовки и информацию от WSGI-сервера.

property files: werkzeug.datastructures.ImmutableMultiDict[str, werkzeug.datastructures.FileStorage]

MultiDict объект, содержащий все загруженные файлы. Каждый ключ в files — это имя из <input type="file" name="">. Каждое значение в files — это объект Werkzeug FileStorage.

По сути, он ведет себя как стандартный файловый объект из Python, за исключением наличия функции save(), которая позволяет сохранить файл на файловой системе.

Обратите внимание, что files будет содержать данные только если метод запроса был POST, PUT или PATCH, и отправленный в запрос <form> имел enctype="multipart/form-data". В противном случае он будет пустым.

Для получения дополнительной информации об используемой структуре данных см. документацию MultiDict / FileStorage.

property form: werkzeug.datastructures.ImmutableMultiDict[str, str]

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

Пожалуйста, учтите, что загрузки файлов не попадут сюда, а вместо этого окажутся в атрибуте files.

Изменения

Изменено в версии 0.9: Ранее в Werkzeug 0.9 это содержало данные формы только для запросов POST и PUT.

form_data_parser_class

Псевдоним для werkzeug.formparser.FormDataParser

classmethod from_values(*args, **kwargs)

Создает новый объект запроса на основе предоставленных значений. Если задан параметр environ, пропущенные значения заполняются из него. Этот метод полезен для небольших скриптов, когда вам нужно смоделировать запрос из URL. Не используйте этот метод для тестирования, есть полноценный объект клиента (Client), который позволяет создавать запросы multipart, обрабатывать куки и т.д.

Принимает те же опции, что и EnvironBuilder.

Изменения

Изменено в версии 0.5: Этот метод теперь принимает те же аргументы, что и EnvironBuilder. Из-за этого параметр environ теперь называется environ_overrides.

Возвращает

объект запроса

Параметры

• args (Any) –
• kwargs (Any) –

Тип возвращаемого значения

werkzeug.wrappers.request.Request

property full_path: str

Запрашиваемый путь, включая строку запроса.

get_data(cache=True, as_text=False, parse_form_data=False)

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

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

Обратите внимание, что если данные формы уже были обработаны, этот метод ничего не вернёт, так как обработка данных формы не кеширует данные так, как этот метод. Чтобы неявно вызвать функцию обработки данных формы, установите parse_form_data в True. В этом случае значение, возвращаемое этим методом, будет пустой строкой, если обработчик формы обрабатывает данные. Обычно это не требуется, так как если все данные кешированы (что является значением по умолчанию), обработчик форм будет использовать кешированные данные для обработки данных формы. В любом случае, всегда проверяйте длину содержимого перед вызовом этого метода, чтобы избежать исчерпания памяти сервера.

Если as_text установлено в True, возвращаемое значение будет декодированной строкой.

Изменения

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

Параметры

• cache (bool) –
• as_text (bool) –
• parse_form_data (bool) –

Тип возвращаемого значения

Union[bytes, str]

get_json(force=False, silent=False, cache=True)

Парсит data как JSON.

Если тип MIME не указывает JSON (application/json, см. is_json), или парсинг терпит неудачу, вызывается on_json_loading_failed(), и его возвращаемое значение используется как возвращаемое значение. По умолчанию это вызывает ошибку 400 Bad Request.

Параметры

• force (bool) – Игнорировать тип MIME и всегда пытаться распарсить JSON.
• silent (bool) – Безмолвно игнорировать ошибки типа MIME и парсинга и вернуть None вместо этого.
• cache (bool) – Сохранить распарсенный JSON для последующих вызовов.

Тип возвращаемого значения

Optional[Any]

Изменено в версии 2.1: Вызывать ошибку 400, если тип содержимого неверный.

headers

Заголовки, полученные с запросом.

property host: str

Имя хоста, к которому был обращён запрос, включая порт, если он нестандартный. Валидируется с помощью trusted_hosts.

property host_url: str

Схема и хост URL запроса.

property if_match: werkzeug.datastructures.ETags

Объект, содержащий все значения etag в заголовке If-Match.

Тип возвращаемого значения

ETags

property if_modified_since: Optional[datetime.datetime]

Разбор заголовка If-Modified-Since в виде объекта datetime.

Изменения

Изменено в версии 2.0: Объект datetime учитывает часовой пояс.

property if_none_match: werkzeug.datastructures.ETags

Объект, содержащий все значения etag в заголовке If-None-Match.

Тип возвращаемого значения

ETags

property if_range: werkzeug.datastructures.IfRange

Разбор заголовка If-Range.

Изменения

Изменено в версии 2.0: IfRange.date учитывает часовой пояс.

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

property if_unmodified_since: Optional[datetime.datetime]

Разбор заголовка If-Unmodified-Since в виде объекта datetime.

Изменения

Изменено в версии 2.0: Объект datetime учитывает часовой пояс.

input_stream

Поток ввода WSGI.

В целом, не рекомендуется использовать этот метод, так как можно легко выйти за пределы границ. Используйте stream вместо этого.

property is_json: bool

Проверка, соответствует ли тип содержимого данным JSON, либо application/json, либо application/*+json.

is_multiprocess

Булево значение, True, если приложение обслуживается сервером WSGI, запускающим несколько процессов.

is_multithread

Булево значение, True, если приложение обслуживается многопоточным сервером WSGI.

is_run_once

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

property is_secure: bool

True если запрос был выполнен с использованием защищенного протокола (HTTPS или WSS).

property json: Optional[Any]

Разбор данных JSON, если mimetype указывает на JSON (application/json, см. is_json).

Вызывает get_json() с аргументами по умолчанию.

Если тип содержимого запроса не application/json, будет возбуждено исключение 400 Bad Request.

Изменено в версии 2.1: Возбуждает ошибку 400, если тип содержимого некорректен.

list_storage_class

Псевдоним для werkzeug.datastructures.ImmutableList

make_form_data_parser()

Создает анализатор данных формы. Инициализирует form_data_parser_class с некоторыми параметрами.

Изменения

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

Тип возвращаемого значения

werkzeug.formparser.FormDataParser

property max_content_length: Optional[int]

Только для чтения представление конфигурационного ключа MAX_CONTENT_LENGTH.

max_forwards

Поле заголовка запроса Max-Forwards предоставляет механизм с методами TRACE и OPTIONS для ограничения количества прокси или шлюзов, которые могут пересылать запрос следующему серверу.

method

Метод, используемый для запроса, например, GET.

property mimetype: str

Аналогично content_type, но без параметров (например, без кодировки, типа и т. д.) и всегда в нижнем регистре. Например, если тип содержимого text/HTML; charset=utf-8, то mimetype будет 'text/html'.

property mimetype_params: Dict[str, str]

Параметры mimetype в виде словаря. Например, если тип содержимого text/html; charset=utf-8, то params будут {'charset': 'utf-8'}.

on_json_loading_failed(e)

Вызывается, если get_json() завершается с ошибкой и не подавляется.

Если этот метод возвращает значение, оно используется в качестве возвращаемого значения для get_json(). По умолчанию генерируется исключение BadRequest.

Параметры

e (Optional[ValueError]) – Если произошла ошибка при парсинге, это исключение. Оно будет None если тип содержимого не application/json.

Тип возвращаемого значения

Any

origin

Хост, откуда произошел запрос. Установите access_control_allow_origin в ответе, чтобы указать разрешенные источники.

parameter_storage_class

Псевдоним для werkzeug.datastructures.ImmutableMultiDict

path

Часть пути URL после root_path. Это путь, используемый для маршрутизации внутри приложения.

property pragma: werkzeug.datastructures.HeaderSet

Поле заголовка Pragma используется для включения реализующих специфических директив, которые могут применяться к любому получателю в цепочке запрос/ответ. Все директивы Pragma задают необязательное поведение с точки зрения протокола; однако, некоторые системы МОГУТ потребовать, чтобы это поведение соответствовало этим директивам.

query_string

Часть URL после символа “?”. Это значение в сыром виде, для парсированных значений используйте args.

property range: Optional[werkzeug.datastructures.Range]

Разбор заголовка Range.

Изменения

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

Тип возвращаемого значения

Range

referrer

Поле заголовка запроса Referer позволяет клиенту указать для сервера адрес (URI) ресурса, из которого был получен Request-URI (ссылка, хотя поле заголовка написано с ошибкой).

remote_addr

Адрес клиента, отправившего запрос.

remote_user

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

root_path

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

property root_url: str

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

routing_exception: Optional[Exception] = None

Если сопоставление URL не удалось, это исключение, которое будет возбуждено/было возбуждено в рамках обработки запроса. Обычно это исключение NotFound или что-то подобное.

scheme

Схема URL протокола, использованного запросом, например, https или wss.

property script_root: str

Псевдоним для self.root_path. environ["SCRIPT_ROOT"] без конечного слэша.

server

Адрес сервера. (host, port), (path, None) для сокетов Unix или None если неизвестно.

shallow: bool

Устанавливается при создании объекта запроса. Если True, чтение из тела запроса вызовет RuntimeException. Полезно для предотвращения изменения потока из middleware.

property stream: IO[bytes]

Если входные данные формы не были закодированы с известным типом MIME, данные хранятся в этом потоке без изменений для потребления. Чаще всего лучше использовать data, который предоставит эти данные в виде строки. Поток возвращает данные только один раз.

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

Changelog

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

property url: str

Полный URL запроса со схемой, хостом, корневым путем, путем и строкой запроса.

property url_charset: str

Кодировка символов, которая предполагается для URL. По умолчанию соответствует значению charset.

Changelog

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

property url_root: str

Псевдоним для root_url. URL со схемой, хостом и корневым путем. Например, https://example.com/app/.

url_rule: Optional[Rule] = None

Внутреннее правило URL, которое соответствовало запросу. Это может быть полезно для проверки разрешённых методов для URL из обработчика до/после (request.url_rule.methods) и т. п. Однако, если метод запроса был недопустим для правила URL, допустимый список доступен в routing_exception.valid_methods (атрибут исключения Werkzeug MethodNotAllowed), так как запрос никогда не был связан во внутренней среде.

Changelog

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

property user_agent: werkzeug.user_agent.UserAgent

Пользовательский агент. Используйте user_agent.string для получения значения заголовка. Установите user_agent_class на подкласс UserAgent, чтобы предоставить разбор для других свойств или других расширенных данных.

Changelog

Изменено в версии 2.0: Встроенный парсер устарел и будет удалён в Werkzeug 2.1. Необходимо установить подкласс UserAgent для разбора данных из строки.

user_agent_class

Псевдоним werkzeug.user_agent.UserAgent

property values: werkzeug.datastructures.CombinedMultiDict[str, str]

werkzeug.datastructures.CombinedMultiDict, которая объединяет args и form.

Для GET-запросов присутствуют только args, а не form.

Changelog

Изменено в версии 2.0: Для GET-запросов присутствуют только args, а не form.

view_args: Optional[Dict[str, Any]] = None

Словарь аргументов представления, которые соответствовали запросу. Если при сопоставлении произошла ошибка, это будет None.

property want_form_data_parsed: bool

True если метод запроса несёт содержимое. По умолчанию это true, если отправлен Content-Type.

Changelog

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

flask.request

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

Это прокси. Более подробную информацию см. в разделе Примечания по прокси.

Объект запроса является экземпляром Request.

Объекты ответа

class flask.Response(response=None, status=None, headers=None, mimetype=None, content_type=None, direct_passthrough=False)

Объект ответа, используемый по умолчанию в Flask. Работает как объект ответа из Werkzeug, но по умолчанию имеет тип MIME HTML. Часто вам не нужно создавать этот объект самостоятельно, так как make_response() сделает это за вас.

Если вы хотите заменить используемый объект ответа, вы можете создать подкласс и установить response_class на свой подкласс.

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

Изменено в версии 1.0: Поддержка JSON добавлена в ответ, как и в запросе. Это полезно при тестировании, чтобы получить данные ответа тестового клиента в формате JSON.

Изменено в версии 1.0: Добавлен max_cookie_size.

Параметры

• response (Union[Iterable[str], Iterable[bytes]]) –
• status (Optional[Union[int, str, http.HTTPStatus]]) –
• headers (werkzeug.datastructures.Headers) –
• mimetype (Optional[str]) –
• content_type (Optional[str]) –
• direct_passthrough (bool) –

Тип возвращаемого значения

None

accept_ranges

Заголовок Accept-Ranges. Несмотря на то, что имя указывает на поддержку нескольких значений, должно быть только одно строковое значение.

Общие значения 'bytes' и 'none'.

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

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

property access_control_allow_credentials: bool

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

access_control_allow_headers

Какие заголовки могут быть отправлены с запросом к другому источнику.

access_control_allow_methods

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

access_control_allow_origin

Происхождение или ‘*’ для любого происхождения, которое может делать запросы к другому источнику.

access_control_expose_headers

Какие заголовки могут быть разделены браузером с кодом JavaScript.

access_control_max_age

Максимальное время в секундах, на которое могут кешироваться настройки контроля доступа.

add_etag(overwrite=False, weak=False)

Добавить тег для текущего ответа, если его еще нет.

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

Изменено в версии 2.0: Для генерации значения используется SHA-1. MD5 может быть недоступен в некоторых средах.

Параметры

• overwrite (bool) –
• weak (bool) –

Тип возвращаемого значения

None

age

Поле заголовка ответа Age указывает оценку отправителем времени, прошедшего с момента создания ответа (или его перепроверки) на сервере происхождения.

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

property allow: werkzeug.datastructures.HeaderSet

Поле сущностного заголовка Allow перечисляет набор методов, поддерживаемых ресурсом, идентифицируемым Request-URI. Цель этого поля — информировать получателя о допустимых методах, связанных с ресурсом. Заголовок Allow ОБОЯЗАТЕЛЬНО должен присутствовать в ответе 405 (Method Not Allowed).

property cache_control: werkzeug.datastructures.ResponseCacheControl

Общий заголовок Cache-Control используется для указания директив, которые должны выполняться всеми механизмами кэширования в цепочке запроса/ответа.

calculate_content_length()

Возвращает длину содержимого, если она доступна, или None в противном случае.

Тип возвращаемого значения

Optional[int]

call_on_close(func)

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

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

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

Параметры

func (Callable[[], Any]) –

Тип возвращаемого значения

Callable[[], Any]

close()

Закрыть обернутый ответ, если это возможно. Вы также можете использовать объект в операторе with, который автоматически закроет его.

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

Добавлен в версии 0.9: Теперь может быть использован в операторе with.

Тип возвращаемого значения

None

content_encoding

Поле сущностного заголовка Content-Encoding используется как модификатор типа носителя. При наличии его значение указывает, какие дополнительные кодировки содержимого были применены к телу сущности, и, следовательно, какие механизмы декодирования должны быть применены для получения типа носителя, указанного в заголовке Content-Type.

property content_language: werkzeug.datastructures.HeaderSet

Поле сущностного заголовка Content-Language описывает естественный язык(и) целевой аудитории для включенной сущности. Обратите внимание, что это может не соответствовать всем языкам, используемым в теле сущности.

content_length

Поле сущностного заголовка Content-Length указывает размер тела сущности в десятичном количестве октетов, отправленных получателю, или, в случае метода HEAD, размер тела сущности, который был бы отправлен, если бы запрос был GET.

content_location

Поле заголовка сущности Content-Location МОЖЕТ использоваться для указания расположения ресурса для сущности, заключенной в сообщении, когда эта сущность доступна по адресу, отличному от URI запрашиваемого ресурса.

content_md5

Поле заголовка сущности Content-MD5, как определено в RFC 1864, представляет собой хэш-код MD5 тела сущности для обеспечения проверки целостности сообщения (MIC) тела сущности от начала до конца. (Примечание: MIC хорош для обнаружения случайных изменений тела сущности во время передачи, но не является доказательством защиты от злонамеренных атак.)

property content_range: werkzeug.datastructures.ContentRange

Заголовок Content-Range в виде объекта ContentRange. Доступен даже если заголовок не задан.

Changelog

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

property content_security_policy: werkzeug.datastructures.ContentSecurityPolicy

Заголовок Content-Security-Policy в виде объекта ContentSecurityPolicy. Доступен даже если заголовок не задан.

Заголовок Content-Security-Policy добавляет дополнительный уровень безопасности для обнаружения и смягчения определенных типов атак.

property content_security_policy_report_only: werkzeug.datastructures.ContentSecurityPolicy

Заголовок Content-Security-policy-report-only в виде объекта ContentSecurityPolicy. Доступен даже если заголовок не задан.

Заголовок Content-Security-Policy-Report-Only добавляет политику csp, которая не применяется, но отчитывается, тем самым помогая обнаруживать определенные типы атак.

content_type

Поле заголовка сущности Content-Type указывает тип носителя тела сущности, отправляемого получателю, или, в случае метода HEAD, тип носителя, который был бы отправлен, если бы запрос был GET.

cross_origin_embedder_policy

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

cross_origin_opener_policy

Позволяет управлять совместным использованием группы контекстов просмотра с документами сторонних источников. Значения должны быть членом перечисления werkzeug.http.COOP.

property data: Union[bytes, str]

Дескриптор, который вызывает get_data() и set_data().

date

Поле общего заголовка Date представляет дату и время, в которые было создано сообщение, имеющее такие же семантические значения, как и orig-date в RFC 822.

Changelog

Изменено в версии 2.0: Объект datetime имеет часовой пояс.

delete_cookie(key, path='/', domain=None, secure=False, httponly=False, samesite=None)

Удаляет cookie. Если ключ не существует, выполняется без ошибок.

Параметры

• ключ (str) – ключ (имя) cookie для удаления.
• путь (str) – если cookie, который нужно удалить, был ограничен путем, путь должен быть определен здесь.
• домен (Optional[str]) – если cookie, который нужно удалить, был ограничен доменом, этот домен должен быть определен здесь.
• безопасный (bool) – Если True, cookie будет доступен только по HTTPS.
• httponly (bool) – запретить доступ JavaScript к cookie.
• samesite (Optional[str]) – ограничить область действия cookie только запросами, которые являются "сайтом-в-сайту".

Тип возвращаемого значения

None

direct_passthrough

Передать тело ответа напрямую как WSGI итератор. Это можно использовать, когда тело является двоичным файлом или другим итератором байтов, чтобы пропустить некоторые ненужные проверки. Используйте send_file() вместо ручного задания этого.

expires

Поле заголовка сущности Expires указывает дату/время после которого ответ считается устаревшим. Устаревший кеш-запись, как правило, не возвращается кешем.

Changelog

Изменено в версии 2.0: Объект datetime имеет часовой пояс.

classmethod force_type(response, environ=None)

Принудительно сделать WSGI ответ объектом ответа текущего типа. Werkzeug будет использовать Response во многих ситуациях, таких как исключения. Если вы вызываете get_response() на исключение, вы получите обычный объект Response, даже если вы используете подкласс.

Этот метод может принудительно навязать определенный тип ответа, и он также преобразует произвольные WSGI вызываемые объекты в объекты ответов, если указана среда:

# convert a Werkzeug response object into an instance of the
# MyResponseClass subclass.
response = MyResponseClass.force_type(response)

# convert any WSGI application into a response object
response = MyResponseClass.force_type(response, environ)

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

Помните, что это может изменить объекты ответов на месте, если это возможно!

Параметры

• ответ (Ответ) – объект ответа или WSGI приложение.
• среда (Optional[WSGIEnvironment]) – объект среды WSGI.

Возвращает

объект ответа.

Тип возвращаемого значения

Ответ

freeze()

Подготовить объект ответа для сериализации. Выполняет следующие действия:

• Буферизует ответ в список, игнорируя implicity_sequence_conversion и direct_passthrough.
• Устанавливает заголовок Content-Length.
• Генерирует заголовок ETag если он не задан.

Изменено в версии 2.1: Параметр no_etag удален.

Changelog

Изменено в версии 2.0: Добавлен заголовок ETag, параметр no_etag устарел и будет удален в Werkzeug 2.1.

Изменено в версии 0.6: Устанавливается заголовок Content-Length.

Тип возвращаемого значения

None

classmethod from_app(app, environ, buffered=False)

Создайте новый объект ответа из выходных данных приложения. Это лучше всего работает, если вы передаёте ему приложение, которое постоянно возвращает генератор. Иногда приложения могут использовать вызываемый write() метод, возвращаемый функцией start_response. Это пытается автоматически разрешить такие граничные случаи. Но если вы не получаете ожидаемые выходные данные, вы должны установить buffered в значение True, что обеспечивает буферизацию.

Параметры

• app (WSGIApplication) – приложение WSGI для выполнения.
• environ (WSGIEnvironment) – среда WSGI для выполнения.
• buffered (bool) – установите в True для обеспечения буферизации.

Возвращает

объект ответа.

Тип возвращаемого значения

Response

get_app_iter(environ)

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

Если метод запроса равен HEAD или код состояния находится в диапазоне, где спецификация HTTP требует пустого ответа, возвращается пустая итерируемая последовательность.

Changelog

Новая функция в версии 0.6.

Параметры

environ (WSGIEnvironment) – среда WSGI запроса.

Возвращает

итерируемую последовательность ответа.

Тип возвращаемого значения

Iterable[bytes]

get_data(as_text=False)

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

Это поведение можно отключить, установив implicit_sequence_conversion в False.

Если as_text установлено в True, возвращаемое значение будет декодированной строкой.

Changelog

Новая функция в версии 0.9.

Параметры

as_text (bool) –

Тип возвращаемого значения

Union[bytes, str]

get_etag()

Возвращает кортеж в формате (etag, is_weak). Если ETag отсутствует, возвращаемое значение равно (None, None).

Тип возвращаемого значения

Union[Tuple[str, bool], Tuple[None, None]]

get_json(force=False, silent=False)

Разбор data как JSON. Полезно во время тестирования.

Если MIME-тип не указывает JSON (application/json, см. is_json), возвращается None.

В отличие от Request.get_json(), результат не кэшируется.

Параметры

• force (bool) – Игнорировать MIME-тип и всегда пытаться разобрать JSON.
• silent (bool) – Скрыть ошибки разбора и вернуть None вместо них.

Тип возвращаемого значения

Optional[Any]

get_wsgi_headers(environ)

Автоматически вызывается непосредственно перед запуском ответа и возвращает заголовки, изменённые для данной среды. Возвращает копию заголовков из ответа с внесёнными изменениями, если необходимо.

Например, заголовок расположения (если он есть) объединяется с корневым URL-адресом среды. Кроме того, длина содержимого автоматически устанавливается в ноль для определённых кодов состояния.

Changelog

Изменено в версии 0.6: Ранее эта функция называлась fix_headers и изменяла объект ответа непосредственно. Также начиная с версии 0.6, IRIs в заголовках расположения и расположения содержимого обрабатываются должным образом.

Также начиная с версии 0.6, Werkzeug попытается установить длину содержимого, если сможет это сделать самостоятельно. Это происходит в случае, если все строки в итерируемой последовательности ответа уже закодированы, а итерируемая последовательность буферизована.

Параметры

environ (WSGIEnvironment) – среда WSGI запроса.

Возвращает

возвращает новый объект Headers.

Тип возвращаемого значения

werkzeug.datastructures.Headers

get_wsgi_response(environ)

Возвращает окончательный ответ WSGI в виде кортежа. Первый элемент кортежа — итерируемая последовательность приложения, второй — код состояния, а третий — список заголовков. Возвращаемый ответ создаётся специально для данной среды. Например, если метод запроса в среде WSGI равен 'HEAD', ответ будет пустым, и будут присутствовать только заголовки и код состояния.

Changelog

Новая функция в версии 0.6.

Параметры

environ (WSGIEnvironment) – среда WSGI запроса.

Возвращает

кортеж (app_iter, status, headers).

Тип возвращаемого значения

Tuple[Iterable[bytes], str, List[Tuple[str, str]]]

property is_json: bool

Проверка, указывает ли MIME-тип данные JSON, либо application/json, либо application/*+json.

property is_sequence: bool

Если итерируемая последовательность буферизована, это свойство будет True. Объект ответа будет считать итерируемую последовательность буферизованной, если атрибут response является списком или кортежем.

Changelog

Новая функция в версии 0.6.

property is_streamed: bool

Если ответ передаётся потоком (ответ не является итерируемым объектом с информацией о длине), это свойство равно True. В этом случае потоковая передача означает, что нет информации о количестве итераций. Это обычно True если в объект ответа передаётся генератор.

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

iter_encoded()

Итерирование закодированного ответа с использованием кодировки ответа. Если объект ответа вызывается как WSGI-приложение, возвращаемое значение этого метода используется в качестве итератора приложения, если не был активирован direct_passthrough.

Тип возвращаемого значения

Iterator[байты]

property json: Optional[Any]

Разложенные данные JSON, если mimetype указывает на JSON (application/json, см. is_json).

Вызывает get_json() со стандартными аргументами.

last_modified

Поле заголовка сущности Last-Modified указывает дату и время, когда исходный сервер полагает, что вариант был в последний раз изменён.

Changelog

Изменено в версии 2.0: Объект datetime с учётом часового пояса.

location

Поле заголовка ответа Location используется для перенаправления получателя на местоположение, отличное от Request-URI, для завершения запроса или идентификации нового ресурса.

make_conditional(request_or_environ, accept_ranges=False, complete_length=None)

Устанавливает условие для ответа относительно запроса. Этот метод лучше всего работает, если для ответа уже определён etag. Метод add_etag можно использовать для этого. Если вызывается без etag, устанавливается только заголовок даты.

Не выполняет никаких действий, если метод запроса в запросе или окружении — не GET или HEAD.

Для оптимальной производительности при обработке запросов range рекомендуется, чтобы ваш объект данных ответа реализовывал методы seekable, seek и tell, как описано в io.IOBase. Объекты, возвращаемые wrap_file(), автоматически реализуют эти методы.

Не удаляет тело ответа, так как функция __call__() делает это автоматически.

Возвращает self, чтобы вы могли сделать return resp.make_conditional(req), но изменяет объект на месте.

Параметры

• request_or_environ (Объединение[WSGIEnvironment, Запрос]) – объект запроса или WSGI-среда, используемые для создания условия для ответа.
• accept_ranges (Объединение[bool, строка]) – Этот параметр определяет значение заголовка Accept-Ranges. Если False (по умолчанию), заголовок не устанавливается. Если True, он будет установлен в "bytes". Если None, он будет установлен в "none". Если это строка, она будет использоваться как значение.
• complete_length (Необязательный[целое число]) – Будет использоваться только в допустимых запросах Range. Он установит значение полной длины Content-Range и вычислит реальное значение Content-Length. Этот параметр обязателен для успешного завершения запросов Range.

Исключения

RequestedRangeNotSatisfiable, если заголовок Range не может быть проанализирован или удовлетворён.

Тип возвращаемого значения

Ответ

Changelog

Изменено в версии 2.0: Обработка диапазонов пропускается, если длина равна 0, вместо вывода ошибки 416 Range Not Satisfiable.

make_sequence()

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

Changelog

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

Тип возвращаемого значения

Ничего

property max_cookie_size: int

Только для чтения представление конфигурационного ключа MAX_COOKIE_SIZE.

См. max_cookie_size в документации Werkzeug.

property mimetype: Optional[str]

Тип MIME (тип содержимого без кодировки символов и т. д.).

property mimetype_params: Dict[str, str]

Параметры типа MIME в виде словаря. Например, если тип содержимого text/html; charset=utf-8, параметры будут {'charset': 'utf-8'}.

Changelog

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

response: t.Union[t.Iterable[str], t.Iterable[bytes]]

Тело ответа для отправки как WSGI-итерируемый объект. Список строк или байтов представляет ответ фиксированной длины, любой другой итерируемый объект — потоковый ответ. Строки кодируются в байты как UTF-8.

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

property retry_after: Optional[datetime.datetime]

Поле заголовка ответа Retry-After может использоваться с ответом 503 (Сервис недоступен) для указания того, как долго сервис будет недоступен для клиента, отправляющего запрос.

Время в секундах до истечения срока действия или дата.

Changelog

Изменено в версии 2.0: Объект datetime с учётом часового пояса.

set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite=None)

Устанавливает cookie.

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

Параметры

• ключ (str) – ключ (имя) устанавливаемого cookie.
• значение (str) – значение cookie.
• max_age (Optional[Union[datetime.timedelta, int]]) – должно быть количество секунд, или None (по умолчанию), если cookie должно действовать только в течение сессии браузера клиента.
• expires (Optional[Union[str, datetime.datetime, int, float]]) – должен быть объект datetime, или метка времени Unix.
• path (Optional[str]) – ограничивает cookie заданным путём, по умолчанию он будет охватывать весь домен.
• domain (Optional[str]) – если нужно установить cookie для другого домена. Например, domain=".example.com" установит cookie, доступный для домена www.example.com, foo.example.com и т. д. В противном случае cookie будет доступен только для домена, который его установил.
• secure (bool) – Если True, cookie будет доступен только по HTTPS.
• httponly (bool) – Запрещает доступ к cookie через JavaScript.
• samesite (Optional[str]) – Ограничивает область действия cookie, чтобы он присоединялся только к запросам «одного сайта».

Тип возвращаемого значения

None

set_data(value)

Устанавливает новую строку в качестве ответа. Значение должно быть строкой или байтами. Если установлена строка, она кодируется в кодировку набора символов ответа (по умолчанию utf-8).

Изменения

Введено в версии 0.9.

Параметры

значение (Union[bytes, str]) –

Тип возвращаемого значения

None

set_etag(etag, weak=False)

Устанавливает etag и перезаписывает предыдущее значение, если оно было.

Параметры

• etag (str) –
• weak (bool) –

Тип возвращаемого значения

None

property status: str

Код HTTP-статуса в виде строки.

property status_code: int

Код HTTP-статуса в виде числа.

property stream: werkzeug.wrappers.response.ResponseStream

Итерируемый объект ответа в виде потока только для записи.

property vary: werkzeug.datastructures.HeaderSet

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

property www_authenticate: werkzeug.datastructures.WWWAuthenticate

Заголовок WWW-Authenticate в обработанном виде.

Сессии

Если вы установили Flask.secret_key (или настраивали его из SECRET_KEY), вы можете использовать сессии в приложениях Flask. Сессия позволяет запоминать информацию от одного запроса к другому. Flask делает это, используя подписанный cookie. Пользователь может просмотреть содержимое сессии, но не может его изменить, если не знает секретный ключ, поэтому убедитесь, что он сложный и не поддаётся угадыванию.

Для доступа к текущей сессии вы можете использовать объект session:

class flask.session

Объект сессии работает почти как обычный словарь, с той разницей, что он отслеживает изменения.

Это прокси. Подробнее см. Замечания о прокси.

Следующие атрибуты представляют интерес:

new

True если сессия новая, False в противном случае.

modified

True если объект сессии обнаружил изменение. Обратите внимание, что изменения в изменяемых структурах не обнаруживаются автоматически, в этом случае вам нужно явным образом установить атрибут в True самостоятельно. Вот пример:

# this change is not picked up because a mutable object (here
# a list) is changed.
session['objects'].append(42)
# so mark it as modified yourself
session.modified = True

permanent

Если установлено в True, сессия сохраняется в течение permanent_session_lifetime секунд. По умолчанию 31 день. Если установлено в False (что по умолчанию), сессия будет удалена при закрытии браузера пользователем.

Интерфейс сессий

Интерфейс сессий предоставляет простой способ заменить реализацию сессий, используемую Flask.

class flask.sessions.SessionInterface

Базовый интерфейс, который необходимо реализовать для замены стандартного интерфейса сессий, использующего реализацию securecookie от Werkzeug. Вам нужно реализовать только методы open_session() и save_session(), остальные имеют полезные значения по умолчанию, которые вам не нужно менять.

Объект сессии, возвращаемый методом open_session(), должен предоставлять интерфейс, похожий на словарь, а также свойства и методы из SessionMixin. Рекомендуется просто создать подкласс словаря и добавить в него этот миксин:

class Session(dict, SessionMixin):
    pass

Если метод open_session() возвращает None, Flask вызовет make_null_session() для создания сессии-замены, если поддержка сессий не может работать из-за отсутствия какого-либо требования. По умолчанию создаваемый класс NullSession будет жаловаться на то, что закрытый ключ не задан.

Чтобы заменить интерфейс сессий в приложении, вам нужно просто назначить flask.Flask.session_interface:

app = Flask(__name__)
app.session_interface = MySessionInterface()

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

Изменения

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

get_cookie_domain(app)

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

Использует SESSION_COOKIE_DOMAIN, если он настроен, в противном случае возвращается к определению домена на основе SERVER_NAME.

После определения (или если он вообще не задан), SESSION_COOKIE_DOMAIN обновляется, чтобы избежать повторного выполнения логики.

Параметры

app (Flask) –

Тип возвращаемого значения

Optional[str]

get_cookie_httponly(app)

Возвращает True, если для куки сессии должен быть установлен httponly. В настоящее время возвращает значение конфигурационной переменной SESSION_COOKIE_HTTPONLY.

Параметры

app (Flask) –

Тип возвращаемого значения

bool

get_cookie_name(app)

Возвращает имя куки сессии.

Использует app.session_cookie_name, которое установлено в значение SESSION_COOKIE_NAME

Параметры

app (Flask) –

Тип возвращаемого значения

str

get_cookie_path(app)

Возвращает путь, для которого куки должна быть действительной. По умолчанию используется значение из конфигурационной переменной SESSION_COOKIE_PATH если она установлена, иначе используется APPLICATION_ROOT или /, если None.

Параметры

app (Flask) –

Тип возвращаемого значения

str

get_cookie_samesite(app)

Возвращает 'Strict' или 'Lax', если куки должна использовать атрибут SameSite . В настоящее время просто возвращает значение настройки SESSION_COOKIE_SAMESITE.

Параметры

app (Flask) –

Тип возвращаемого значения

str

get_cookie_secure(app)

Возвращает True, если куки должна быть защищенной. В настоящее время просто возвращает значение настройки SESSION_COOKIE_SECURE.

Параметры

app (Flask) –

Тип возвращаемого значения

bool

get_expiration_time(app, session)

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

Параметры

• app (Flask) –
• session (flask.sessions.SessionMixin) –

Тип возвращаемого значения

Optional[datetime.datetime]

is_null_session(obj)

Проверяет, является ли данный объект пустой сессией. Пустые сессии не запрашиваются для сохранения.

По умолчанию проверяет, является ли объект экземпляром null_session_class.

Параметры

obj (object) –

Тип возвращаемого значения

bool

make_null_session(app)

Создаёт пустую сессию, которая выступает в качестве заменяющего объекта, если реальная поддержка сессий не может быть загружена из-за ошибки конфигурации. В основном это помогает пользователю, потому что задача пустой сессии — поддерживать поиск без жалоб, но изменения сопровождаются полезным сообщением об ошибке, объясняющим, что не удалось.

По умолчанию создаёт экземпляр null_session_class.

Параметры

app (Flask) –

Тип возвращаемого значения

flask.sessions.NullSession

null_session_class

make_null_session() ищет здесь класс, который должен быть создан при запросе пустой сессии. Аналогично, метод is_null_session() выполняет проверку типа относительно этого типа.

псевдоним flask.sessions.NullSession

open_session(app, request)

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

Это должно вернуть объект, реализующий интерфейс словаря, а также интерфейс SessionMixin.

Это вернёт None для указания того, что загрузка не удалась по какой-то причине, которая не является непосредственной ошибкой. В этом случае контекст запроса вернёт make_null_session().

Параметры

• app (Flask) –
• request (Запрос) –

Тип возвращаемого значения

Optional[flask.sessions.SessionMixin]

pickle_based = False

Флаг, указывающий, использует ли интерфейс сессий механизм pickle. Это может быть использовано расширениями Flask для принятия решения о том, как обращаться с объектом сессии.

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

Новое в версии 0.10.

save_session(app, session, response)

Вызывается в конце каждого запроса после генерации ответа, перед удалением контекста запроса. Пропускается, если is_null_session() возвращает True.

Параметры

• app (Flask) –
• session (flask.sessions.SessionMixin) –
• response (Ответ) –

Тип возвращаемого значения

None

should_set_cookie(app, session)

Используется модулями сессий для определения, должен ли заголовок Set-Cookie устанавливаться для данного cookie сессии для данного ответа. Если сессия была изменена, cookie устанавливается. Если сессия постоянная и конфигурация SESSION_REFRESH_EACH_REQUEST имеет значение true, cookie всегда устанавливается.

Эта проверка обычно пропускается, если сессия была удалена.

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

Новое в версии 0.11.

Параметры

• app (Flask) –
• session (flask.sessions.SessionMixin) –

Тип возвращаемого значения

bool

class flask.sessions.SecureCookieSessionInterface

Стандартный интерфейс сессий, хранящий сессии в подписанных cookie через модуль itsdangerous.

static digest_method(string=b'', *, usedforsecurity=True)

Функция хэширования, используемая для подписи. По умолчанию это sha1

key_derivation = 'hmac'

Название поддерживаемого itsdangerous метода вывода ключа. По умолчанию это hmac.

open_session(app, request)

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

Это должно вернуть объект, реализующий интерфейс словаря, а также интерфейс SessionMixin.

Это вернёт None для указания того, что загрузка не удалась по какой-то причине, которая не является непосредственной ошибкой. В этом случае контекст запроса вернёт make_null_session().

Параметры

• app (Flask) –
• request (Запрос) –

Тип возвращаемого значения

Optional[flask.sessions.SecureCookieSession]

salt = 'cookie-session'

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

save_session(app, session, response)

Вызывается в конце каждого запроса после генерации ответа, перед удалением контекста запроса. Пропускается, если is_null_session() возвращает True.

Параметры

• app (Flask) –
• session (flask.sessions.SessionMixin) –
• response (Ответ) –

Тип возвращаемого значения

None

serializer = <flask.json.tag.TaggedJSONSerializer object>

Сериализатор Python для полезной нагрузки. По умолчанию используется компактный сериализатор JSON с поддержкой некоторых дополнительных типов Python, таких как объекты datetime или кортежи.

session_class

Псевдоним flask.sessions.SecureCookieSession

class flask.sessions.SecureCookieSession(initial=None)

Базовый класс для сессий, основанных на подписанных куках.

Этот бэкенд сессий установит атрибуты modified и accessed. Он не может надёжно отслеживать, является ли сессия новой (по сравнению с пустой), поэтому new остаётся жёстко закодированным в False.

Параметры

initial (Any) –

Тип возвращаемого значения

None

accessed = False

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

get(key, default=None)

Возвращает значение для ключа, если ключ есть в словаре, иначе возвращает значение по умолчанию.

Параметры

• key (str) –
• default (Optional[Any]) –

Тип возвращаемого значения

Any

modified = False

При изменении данных, это устанавливается в True. Отслеживается только сам словарь сессии; если сессия содержит изменяемые данные (например, вложенный словарь), то это значение необходимо установить в True вручную при изменении этих данных. Куки сессии будут записаны в ответ только в том случае, если это значение True.

setdefault(key, default=None)

Вставить ключ со значением по умолчанию, если ключ отсутствует в словаре.

Возвращает значение для ключа, если ключ есть в словаре, иначе возвращает значение по умолчанию.

Параметры

• key (str) –
• default (Optional[Any]) –

Тип возвращаемого значения

Any