API¶

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

class flask.Flask(import_name: str, static_url_path: Optional[str] = None, static_folder: Optional[Union[str, os.PathLike]] = 'static', static_host: Optional[str] = None, host_matching: bool = False, subdomain_matching: bool = False, template_folder: Optional[str] = 'templates', instance_path: Optional[str] = None, instance_relative_config: bool = False, root_path: Optional[str] = None)¶

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

Имя пакета используется для разрешения ресурсов внутри пакета или папки, в которой находится модуль, в зависимости от того, разрешает ли параметр package фактический пакет 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).

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

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

Добавлено в версии 0.11: Добавлен параметр root_path.

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

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

Параметры

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

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

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

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

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

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

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

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

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

• root_path – The path to the root of the application files. This should only be set manually when it can’t be detected automatically, such as for namespace packages.

add_template_filter(f: Callable[[...], Any], name: Optional[str] = None) → None¶

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

Параметры

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

add_template_global(f: Callable[[...], Any], name: Optional[str] = None) → None¶

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

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

Параметры

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

add_template_test(f: Callable[[...], bool], name: Optional[str] = None) → None¶

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

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

Параметры

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

add_url_rule(rule: str, endpoint: Optional[str] = None, view_func: Optional[Callable] = None, provide_automatic_options: Optional[bool] = None, **options: Any) → None¶

Register a rule for routing incoming requests and building URLs. The route() decorator is a shortcut to call this with the view_func argument. These are equivalent:

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

def index():
    ...

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

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

The endpoint name for the route defaults to the name of the view function if the endpoint parameter isn’t passed. An error will be raised if a function has already been registered for the endpoint.

The methods parameter defaults to ["GET"]. HEAD is always added automatically, and OPTIONS is added automatically by default.

view_func does not necessarily need to be passed, but if the rule should participate in routing an endpoint name must be associated with a view function at some point with the endpoint() decorator.

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

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

If view_func has a required_methods attribute, those methods are added to the passed and automatic methods. If it has a provide_automatic_methods attribute, it is used as the default if the parameter is not passed.

Параметры

• rule – The URL rule string.

• endpoint – The endpoint name to associate with the rule and view function. Used when routing and building URLs. Defaults to view_func.__name__.

• view_func – The view function to associate with the endpoint name.

• provide_automatic_options – Add the OPTIONS method and respond to OPTIONS requests automatically.

• options – Extra options passed to the Rule object.

after_request(f: Callable[[Response], Response]) → Callable[[Response], Response]¶

Register a function to run after each request to this object.

The function is called with the response object, and must return a response object. This allows the functions to modify or replace the response before it is sent.

If a function raises an exception, any remaining after_request functions will not be called. Therefore, this should not be used for actions that must execute, such as to close resources. Use teardown_request() for that.

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

A data structure of functions to call at the end of each request, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the after_request() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

app_context() → flask.ctx.AppContext¶

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

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

with app.app_context():
    init_db()

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

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

app_ctx_globals_class¶

alias of flask.ctx._AppCtxGlobals

async_to_sync(func: Callable[[...], Coroutine]) → Callable[[...], Any]¶

Return a sync function that will run the coroutine function.

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

Override this method to change how the app converts async code to be synchronously callable.

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

auto_find_instance_path() → str¶

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

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

before_first_request(f: Callable[[], None]) → Callable[[], None]¶

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

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

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

before_first_request_funcs: t.List[BeforeFirstRequestCallable]¶

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

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

before_request(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, List[str], Tuple[str, ...]]]]]], WSGIApplication]]]) → 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, List[str], Tuple[str, ...]]]]]], WSGIApplication]]]¶

Register a function to run before each request.

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

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

The function will be called without any arguments. If it returns a non-None value, the value is handled as if it was the return value from the view, and further request handling is stopped.

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

A data structure of functions to call at the beginning of each request, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the before_request() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

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

Maps registered blueprint names to blueprint objects. The dict retains the order the blueprints were registered in. Blueprints can be registered multiple times, this dict does not track how often they were attached.

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

cli¶

The Click command group for registering CLI commands for this object. The commands are available from the flask command once the application has been discovered and blueprints have been registered.

config¶

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

config_class¶

alias of flask.config.Config

context_processor(f: Callable[[], Dict[str, Any]]) → Callable[[], Dict[str, Any]]¶

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

create_global_jinja_loader() → flask.templating.DispatchingJinjaLoader¶

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

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

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

create_jinja_environment() → flask.templating.Environment¶

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

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

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

create_url_adapter(request: Optional[flask.wrappers.Request]) → Optional[werkzeug.routing.MapAdapter]¶

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

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

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

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

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: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Shortcut for route() with methods=["DELETE"].

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

dispatch_request() → 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, ...]]]]]], WSGIApplication]¶

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

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

do_teardown_appcontext(exc: typing.Optional[BaseException] = <object object>) → None¶

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

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

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

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

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

do_teardown_request(exc: typing.Optional[BaseException] = <object object>) → None¶

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

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

T

Параметры

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

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

endpoint(endpoint: str) → Callable¶

Decorate a view function to register it for the given endpoint. Used if a rule is added without a view_func with add_url_rule().

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

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

Параметры

endpoint – The endpoint name to associate with the view function.

ensure_sync(func: Callable) → Callable¶

Ensure that the function is synchronous for WSGI workers. Plain def functions are returned as-is. async def functions are wrapped to run and wait for the response.

Override this method to change how the app runs async views.

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

env¶

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

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

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

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

A data structure of registered error handlers, in the format {scope: {code: {class: handler}}}`. The scope key is the name of a blueprint the handlers are active for, or None for all requests. The code key is the HTTP status code for HTTPException, or None for other exceptions. The innermost dictionary maps exception classes to handler functions.

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

This data structure is internal. It should not be modified directly and its format may change at any time.

errorhandler(code_or_exception: Union[Type[Exception], int]) → Callable[[ErrorHandlerCallable], ErrorHandlerCallable]¶

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

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

@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 – код как целое число для обработчика, или произвольное исключение

extensions: dict¶

a place where extensions can store application specific state. For example this is where an extension could store database engines and similar things.

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

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

full_dispatch_request() → flask.wrappers.Response¶

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

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

get(rule: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Shortcut for route() with methods=["GET"].

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

get_send_file_max_age(filename: Optional[str]) → Optional[int]¶

Used by send_file() to determine the max_age cache value for a given file path if it wasn’t passed.

By default, this returns SEND_FILE_MAX_AGE_DEFAULT from the configuration of current_app. This defaults to None, which tells the browser to use conditional requests instead of a timed cache, which is usually preferable.

Изменено в версии 2.0: The default configuration is None instead of 12 hours.

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

property got_first_request: bool¶

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

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

handle_exception(e: Exception) → flask.wrappers.Response¶

Обработать исключение, которое не имеет обработчика ошибок, связанного с ним, или которое было вызвано из обработчика ошибок. Это всегда вызывает ошибку 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.

handle_http_exception(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]¶

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

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

Изменено в версии 1.0: Exceptions are looked up by code and by MRO, so HTTPException subclasses can be handled with a catch-all handler for the base HTTPException.

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

handle_url_build_error(error: Exception, endpoint: str, values: dict) → str¶

Обращение BuildError к url_for().

handle_user_exception(e: Exception) → 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]¶

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

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

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

property has_static_folder: bool¶

True if static_folder is set.

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

import_name¶

The name of the package or module that this object belongs to. Do not change this once it is set by the constructor.

inject_url_defaults(endpoint: str, values: dict) → None¶

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

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

instance_path¶

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

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

iter_blueprints() → ValuesView[Blueprint]¶

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

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

property jinja_env: flask.templating.Environment¶

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

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

jinja_environment¶

alias of flask.templating.Environment

property jinja_loader: Optional[jinja2.loaders.FileSystemLoader]¶

The Jinja loader for this object’s templates. By default this is a class jinja2.loaders.FileSystemLoader to template_folder if it is set.

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

jinja_options: dict = {}¶

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

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

json_decoder¶

alias of flask.json.JSONDecoder

json_encoder¶

alias of flask.json.JSONEncoder

log_exception(exc_info: Union[Tuple[type, BaseException, types.TracebackType], Tuple[None, None, None]]) → None¶

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

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

property logger: logging.Logger¶

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

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

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

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

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

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

make_config(instance_relative: bool = False) → flask.config.Config¶

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

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

make_default_options_response() → flask.wrappers.Response¶

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

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

make_response(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, ...]]]]]], WSGIApplication]) → flask.wrappers.Response¶

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

Параметры

rv –

возвращаемое значение из функции представления. Функция представления должна возвращать ответ. Возврат 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

Объект возвращается без изменений.

другой Response класс

Объект принудительно переводится в состояние response_class.

callable()

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

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

make_shell_context() → dict¶

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

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

property name: str¶

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

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

open_instance_resource(resource: str, mode: str = 'rb') → IO¶

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

Параметры

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

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

open_resource(resource: str, mode: str = 'rb') → IO¶

Open a resource file relative to root_path for reading.

For example, if the file schema.sql is next to the file app.py where the Flask app is defined, it can be opened with:

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

Параметры

• resource – Path to the resource relative to root_path.

• mode – Open the file in this mode. Only reading is supported, valid values are «r» (or «rt») and «rb».

patch(rule: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Shortcut for route() with methods=["PATCH"].

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

permanent_session_lifetime¶

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

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

post(rule: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Shortcut for route() with methods=["POST"].

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

preprocess_request() → 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, List[str], Tuple[str, ...]]]]]], WSGIApplication]]¶

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

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

property preserve_context_on_exception: bool¶

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

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

process_response(response: flask.wrappers.Response) → flask.wrappers.Response¶

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

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

Параметры

response – объект response_class.

Результат

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

property propagate_exceptions: bool¶

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

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

put(rule: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Shortcut for route() with methods=["PUT"].

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

register_blueprint(blueprint: Blueprint, **options: Any) → None¶

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

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

Параметры

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

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

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

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

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

Изменено в версии 2.0.1: The name option can be used to change the (pre-dotted) name the blueprint is registered with. This allows the same blueprint to be registered multiple times with unique names for url_for.

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

register_error_handler(code_or_exception: Union[Type[Exception], int], f: ErrorHandlerCallable) → None¶

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

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

request_class¶

alias of flask.wrappers.Request

request_context(environ: dict) → flask.ctx.RequestContext¶

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

См. T.

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

Параметры

environ – среда WSGI

response_class¶

alias of flask.wrappers.Response

root_path¶

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

route(rule: str, **options: Any) → Callable[[flask.scaffold.F], flask.scaffold.F]¶

Decorate a view function to register it with the given URL rule and options. Calls add_url_rule(), which has more details about the implementation.

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

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

The endpoint name for the route defaults to the name of the view function if the endpoint parameter isn’t passed.

The methods parameter defaults to ["GET"]. HEAD and OPTIONS are added automatically.

Параметры

• rule – The URL rule string.

• options – Extra options passed to the Rule object.

run(host: Optional[str] = None, port: Optional[int] = None, debug: Optional[bool] = None, load_dotenv: bool = True, **options: Any) → None¶

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

Do not use run() in a production setting. It is not intended to meet security and performance requirements for a production server. Instead, see Варианты развертывания for WSGI server recommendations.

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

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

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

Имейте в виду

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

Параметры

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

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

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

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

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

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

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

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

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

secret_key¶

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

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

select_jinja_autoescape(filename: str) → bool¶

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

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

send_file_max_age_default¶

A timedelta or number of seconds which is used as the default max_age for send_file(). The default is None, which tells the browser to use conditional requests instead of a timed cache.

Configured with the SEND_FILE_MAX_AGE_DEFAULT configuration key.

Изменено в версии 2.0: Defaults to None instead of 12 hours.

send_static_file(filename: str) → Response¶

The view function used to serve files from static_folder. A route is automatically registered for this view at static_url_path if static_folder is set.

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

session_cookie_name¶

Безопасный файл cookie использует это имя для имени сеансового файла cookie.

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

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

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

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

shell_context_processor(f: Callable) → Callable¶

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

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

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

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

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

should_ignore_error(error: Optional[BaseException]) → bool¶

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

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

property static_folder: Optional[str]¶

The absolute path to the configured static folder. None if no static folder is set.

property static_url_path: Optional[str]¶

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

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

teardown_appcontext(f: Callable[[Optional[BaseException]], None]) → Callable[[Optional[BaseException]], None]¶

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

Пример:

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

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

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

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

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

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

teardown_appcontext_funcs: t.List[TeardownCallable]¶

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

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

teardown_request(f: Callable[[Optional[BaseException]], None]) → Callable[[Optional[BaseException]], None]¶

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

Пример:

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

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

Teardown functions must avoid raising exceptions. If they execute code that might fail they will have to surround the execution of that code with try/except statements and log any errors.

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

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

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

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

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

A data structure of functions to call at the end of each request even if an exception is raised, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the teardown_request() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

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

A data structure of functions to call to pass extra context values when rendering templates, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the context_processor() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

template_filter(name: Optional[str] = None) → Callable[[Callable[[...], Any]], Callable[[...], Any]]¶

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

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

Параметры

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

template_folder¶

The path to the templates folder, relative to root_path, to add to the template loader. None if templates should not be added.

template_global(name: Optional[str] = None) → Callable[[Callable[[...], Any]], Callable[[...], Any]]¶

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

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

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

Параметры

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

template_test(name: Optional[str] = None) → Callable[[Callable[[...], bool]], Callable[[...], bool]]¶

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

@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 – необязательное имя теста, иначе будет использовано имя функции.

property templates_auto_reload: bool¶

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

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

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

test_cli_runner(**kwargs: Any) → FlaskCliRunner¶

Создайте программу запуска CLI для тестирования команд CLI. Смотрите Тестирование команд CLI.

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

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

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

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

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

test_client(use_cookies: bool = True, **kwargs: Any) → FlaskClient¶

Creates a test client for this application. For information about unit testing head over to Тестирование приложений Flask.

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

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

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

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

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

from flask.testing import FlaskClient

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

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

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

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

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

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

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

The test_client() method creates an instance of this test client class. Defaults to FlaskClient.

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

test_request_context(*args: Any, **kwargs: Any) → flask.ctx.RequestContext¶

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

См. T.

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

with test_request_context(...):
    generate_report()

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

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

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

Параметры

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

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

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

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

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

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

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

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

testing¶

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

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

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

trap_http_exception(e: Exception) → bool¶

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

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

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

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

update_template_context(context: dict) → None¶

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

Параметры

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

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]]¶

A data structure of functions to call to modify the keyword arguments when generating URLs, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the url_defaults() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

url_defaults(f: Callable[[str, dict], None]) → Callable[[str, dict], None]¶

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

url_map¶

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

from werkzeug.routing import BaseConverter

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

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

url_map_class¶

alias of werkzeug.routing.Map

url_rule_class¶

alias of werkzeug.routing.Rule

url_value_preprocessor(f: Callable[[Optional[str], Optional[dict]], None]) → Callable[[Optional[str], Optional[dict]], None]¶

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

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

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

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

A data structure of functions to call to modify the keyword arguments passed to the view function, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests.

To register a function, use the url_value_preprocessor() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

use_x_sendfile¶

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

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

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

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

A dictionary mapping endpoint names to view functions.

To register a view function, use the route() decorator.

This data structure is internal. It should not be modified directly and its format may change at any time.

wsgi_app(environ: dict, start_response: Callable) → Any¶

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

app = MyMiddleware(app)

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

app.wsgi_app = MyMiddleware(app.wsgi_app)

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

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

Параметры

• environ – Среда WSGI.

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