The flask object implements a WSGI application and acts as the centralobject. It is passed the name of the module or package of theapplication. Once it is created it will act as a central registry forthe view functions, the URL rules, template configuration and much more.

The name of the package is used to resolve resources from inside thepackage or the folder the module is contained in depending on if thepackage parameter resolves to an actual python package (a folder withan__init__.py file inside) or a standard module (just a.py file).

For more information about resource loading, seeopen_resource().

Usually you create aFlask instance in your main module orin the__init__.py file of your package like this:

fromflaskimportFlaskapp=Flask(__name__)

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

パラメータ

• import_name (str) -- the name of the application package

• static_url_path (Optional[str]) -- can be used to specify a different path for thestatic files on the web. Defaults to the nameof thestatic_folder folder.

• static_folder (Optional[Union[str,os.PathLike]]) -- The folder with static files that is served atstatic_url_path. Relative to the applicationroot_pathor an absolute path. Defaults to'static'.

• static_host (Optional[str]) -- the host to use when adding the static route.Defaults to None. Required when usinghost_matching=Truewith astatic_folder configured.

• host_matching (bool) -- seturl_map.host_matching attribute.Defaults to False.

• subdomain_matching (bool) -- consider the subdomain relative toSERVER_NAME when matching routes. Defaults to False.

• template_folder (Optional[str]) -- the folder that contains the templates that shouldbe used by the application. Defaults to'templates' folder in the root path of theapplication.

• instance_path (Optional[str]) -- An alternative instance path for the application.By default the folder'instance' next to thepackage or module is assumed to be the instancepath.

• instance_relative_config (bool) -- if set toTrue relative filenamesfor loading the config are assumed tobe relative to the instance path insteadof the application root.

• root_path (Optional[str]) -- The path to the root of the application files.This should only be set manually when it can't be detectedautomatically, such as for namespace packages.

aborter¶

An instance ofaborter_class created bymake_aborter(). This is called byflask.abort()to raise HTTP errors, and can be called directly as well.

バージョン 2.2 で追加:Moved fromflask.abort, which calls this object.

aborter_class¶

:py:class:`werkzeug.exceptions.Aborter`の別名です。

add_template_filter(f,name=None)¶

Register a custom template filter. Works exactly like thetemplate_filter() decorator.

パラメータ

• name (Optional[str]) -- the optional name of the filter, otherwise thefunction name will be used.

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

戻り値の型

None

add_template_global(f,name=None)¶

Register a custom template global function. Works exactly like thetemplate_global() decorator.

Changelog

バージョン 0.10 で追加.

パラメータ

• name (Optional[str]) -- the optional name of the global function, otherwise thefunction name will be used.

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

戻り値の型

None

add_template_test(f,name=None)¶

Register a custom template test. Works exactly like thetemplate_test() decorator.

Changelog

バージョン 0.10 で追加.

パラメータ

• name (Optional[str]) -- the optional name of the test, otherwise thefunction name will be used.

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

戻り値の型

None

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

Register a rule for routing incoming requests and buildingURLs. Theroute() decorator is a shortcut to call thiswith theview_func argument. These are equivalent:

@app.route("/")defindex():...

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

SeeURL Route Registrations.

The endpoint name for the route defaults to the name of the viewfunction if theendpoint parameter isn't passed. An errorwill be raised if a function has already been registered for theendpoint.

Themethods parameter defaults to["GET"].HEAD isalways added automatically, andOPTIONS is addedautomatically by default.

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

app.add_url_rule("/",endpoint="index")@app.endpoint("index")defindex():...

Ifview_func has arequired_methods attribute, thosemethods are added to the passed and automatic methods. If ithas aprovide_automatic_methods attribute, it is used as thedefault if the parameter is not passed.

パラメータ

• rule (str) -- The URL rule string.

• endpoint (Optional[str]) -- The endpoint name to associate with the ruleand view function. Used when routing and building URLs.Defaults toview_func.__name__.

• view_func (Optional[Union[Callable[[...],Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int,Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],WSGIApplication]],Callable[[...],Awaitable[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int,Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],WSGIApplication]]]]]) -- The view function to associate with theendpoint name.

• provide_automatic_options (Optional[bool]) -- Add theOPTIONS method andrespond toOPTIONS requests automatically.

• options (Any) -- Extra options passed to theRule object.

戻り値の型

None

after_request(f)¶

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

The function is called with the response object, and must returna response object. This allows the functions to modify orreplace the response before it is sent.

If a function raises an exception, any remainingafter_request functions will not be called. Therefore, thisshould not be used for actions that must execute, such as toclose resources. Useteardown_request() for that.

パラメータ

f (flask.scaffold.T_after_request) --

戻り値の型

flask.scaffold.T_after_request

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

A data structure of functions to call at the end of eachrequest, in the format{scope:[functions]}. Thescope key is the name of a blueprint the functions areactive for, orNone for all requests.

To register a function, use theafter_request()decorator.

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

app_context()¶

Create anAppContext. Use as awithblock to push the context, which will makecurrent_apppoint at this application.

An application context is automatically pushed byRequestContext.push()when handling a request, and when running a CLI command. Usethis to manually create a context outside of these situations.

withapp.app_context():init_db()

Seeアプリケーションのコンテキスト（The Application Context）.

Changelog

バージョン 0.9 で追加.

戻り値の型

flask.ctx.AppContext

app_ctx_globals_class¶

:py:class:`flask.ctx._AppCtxGlobals`の別名です。

async_to_sync(func)¶

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 codeto be synchronously callable.

Changelog

バージョン 2.0 で追加.

パラメータ

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

戻り値の型

Callable[[...],Any]

auto_find_instance_path()¶

Tries to locate the instance path if it was not provided to theconstructor of the application class. It will basically calculatethe path to a folder namedinstance next to your main file orthe package.

Changelog

バージョン 0.8 で追加.

戻り値の型

str

before_first_request(f)¶

Registers a function to be run before the first request to thisinstance of the application.

The function will be called without any arguments and its returnvalue is ignored.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Run setup code when creatingthe application instead.

Changelog

バージョン 0.8 で追加.

パラメータ

f (flask.app.T_before_first_request) --

戻り値の型

flask.app.T_before_first_request

before_first_request_funcs:t.List[ft.BeforeFirstRequestCallable]¶

A list of functions that will be called at the beginning of thefirst request to this instance. To register a function, use thebefore_first_request() decorator.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Run setup code whencreating the application instead.

Changelog

バージョン 0.8 で追加.

before_request(f)¶

Register a function to run before each request.

For example, this can be used to open a database connection, orto load the logged in user from the session.

@app.before_requestdefload_user():if"user_id"insession:g.user=db.session.get(session["user_id"])

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

パラメータ

f (flask.scaffold.T_before_request) --

戻り値の型

flask.scaffold.T_before_request

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

A data structure of functions to call at the beginning ofeach request, in the format{scope:[functions]}. Thescope key is the name of a blueprint the functions areactive for, orNone for all requests.

To register a function, use thebefore_request()decorator.

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

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

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

Changelog

バージョン 0.7 で追加.

cli¶

The Click command group for registering CLI commands for thisobject. The commands are available from theflask commandonce the application has been discovered and blueprints havebeen registered.

config¶

The configuration dictionary asConfig. This behavesexactly like a regular dictionary but supports additional methodsto load a config from files.

config_class¶

:py:class:`flask.config.Config`の別名です。

context_processor(f)¶

Registers a template context processor function.

パラメータ

f (flask.scaffold.T_template_context_processor) --

戻り値の型

flask.scaffold.T_template_context_processor

create_global_jinja_loader()¶

Creates the loader for the Jinja2 environment. Can be used tooverride just the loader and keeping the rest unchanged. It'sdiscouraged to override this function. Instead one should overridethejinja_loader() function instead.

The global loader dispatches between the loaders of the applicationand the individual blueprints.

Changelog

バージョン 0.7 で追加.

戻り値の型

flask.templating.DispatchingJinjaLoader

create_jinja_environment()¶

Create the Jinja environment based onjinja_optionsand the various Jinja-related methods of the app. Changingjinja_options after this will have no effect. Also addsFlask-related globals and filters to the environment.

Changelog

バージョン 0.11 で変更:Environment.auto_reload set in accordance withTEMPLATES_AUTO_RELOAD configuration option.

バージョン 0.5 で追加.

戻り値の型

flask.templating.Environment

create_url_adapter(request)¶

Creates a URL adapter for the given request. The URL adapteris created at a point where the request context is not yet setup so the request is passed explicitly.

Changelog

バージョン 1.0 で変更:SERVER_NAME no longer implicitly enables subdomainmatching. Usesubdomain_matching instead.

バージョン 0.9 で変更:This can now also be called without a request object when theURL adapter is created for the application context.

バージョン 0.6 で追加.

パラメータ

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

戻り値の型

Optional[werkzeug.routing.map.MapAdapter]

propertydebug:bool¶

Whether debug mode is enabled. When usingflaskrun to start thedevelopment server, an interactive debugger will be shown for unhandledexceptions, and the server will be reloaded when code changes. This maps to theDEBUG config key. It may not behave as expected if set late.

Do not enable debug mode when deploying in production.

Default:False

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

Default configuration parameters.

delete(rule,**options)¶

Shortcut forroute() withmethods=["DELETE"].

Changelog

バージョン 2.0 で追加.

パラメータ

• rule (str) --

• options (Any) --

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

dispatch_request()¶

Does the request dispatching. Matches the URL and returns thereturn value of the view or error handler. This does not have tobe a response object. In order to convert the return value to aproper response object, callmake_response().

Changelog

バージョン 0.7 で変更:This no longer does the exception handling, this code wasmoved to the newfull_dispatch_request().

戻り値の型

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

do_teardown_appcontext(exc=<objectobject>)¶

Called right before the application context is popped.

When handling a request, the application context is poppedafter the request context. Seedo_teardown_request().

This calls all functions decorated withteardown_appcontext(). Then theappcontext_tearing_down signal is sent.

This is called byAppContext.pop().

Changelog

バージョン 0.9 で追加.

パラメータ

exc (Optional[BaseException]) --

戻り値の型

None

do_teardown_request(exc=<objectobject>)¶

Called after the request is dispatched and the response isreturned, right before the request context is popped.

This calls all functions decorated withteardown_request(), andBlueprint.teardown_request()if a blueprint handled the request. Finally, therequest_tearing_down signal is sent.

This is called byRequestContext.pop(),which may be delayed during testing to maintain access toresources.

パラメータ

exc (Optional[BaseException]) -- An unhandled exception raised while dispatching therequest. Detected from the current exception information ifnot passed. Passed to each teardown function.

戻り値の型

None

Changelog

バージョン 0.9 で変更:Added theexc argument.

endpoint(endpoint)¶

Decorate a view function to register it for the givenendpoint. Used if a rule is added without aview_func withadd_url_rule().

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

パラメータ

endpoint (str) -- The endpoint name to associate with the viewfunction.

戻り値の型

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

ensure_sync(func)¶

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

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

Changelog

バージョン 2.0 で追加.

パラメータ

func (Callable) --

戻り値の型

Callable

propertyenv:str¶

What environment the app is running in. This maps to theENV configkey.

Do not enable development when deploying in production.

Default:'production'

バージョン 2.2 で非推奨:Will be removed in Flask 2.3.

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

A data structure of registered error handlers, in the format{scope:{code:{class:handler}}}. Thescope key isthe name of a blueprint the handlers are active for, orNone for all requests. Thecode key is the HTTPstatus code forHTTPException, orNone forother exceptions. The innermost dictionary maps exceptionclasses to handler functions.

To register an error handler, use theerrorhandler()decorator.

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

errorhandler(code_or_exception)¶

Register a function to handle errors by code or exception class.

A decorator that is used to register a function given anerror code. Example:

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

You can also register handlers for arbitrary exceptions:

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

Changelog

バージョン 0.7 で追加:Useregister_error_handler() instead of modifyingerror_handler_spec directly, for application wide errorhandlers.

バージョン 0.7 で追加:One can now additionally also register custom exception typesthat do not necessarily have to be a subclass of theHTTPException class.

パラメータ

code_or_exception (Union[Type[Exception],int]) -- the code as integer for the handler, oran arbitrary exception

戻り値の型

Callable[[flask.scaffold.T_error_handler], flask.scaffold.T_error_handler]

extensions:dict¶

a place where extensions can store application specific state. Forexample this is where an extension could store database engines andsimilar things.

The key must match the name of the extension module. For example incase of a "Flask-Foo" extension inflask_foo, the key would be'foo'.

Changelog

バージョン 0.7 で追加.

full_dispatch_request()¶

Dispatches the request and on top of that performs requestpre and postprocessing as well as HTTP exception catching anderror handling.

Changelog

バージョン 0.7 で追加.

戻り値の型

flask.wrappers.Response

get(rule,**options)¶

Shortcut forroute() withmethods=["GET"].

Changelog

バージョン 2.0 で追加.

パラメータ

• rule (str) --

• options (Any) --

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

get_send_file_max_age(filename)¶

Used bysend_file() to determine themax_age cachevalue for a given file path if it wasn't passed.

By default, this returnsSEND_FILE_MAX_AGE_DEFAULT fromthe configuration ofcurrent_app. This defaultstoNone, which tells the browser to use conditional requestsinstead of a timed cache, which is usually preferable.

Changelog

バージョン 2.0 で変更:The default configuration isNone instead of 12 hours.

バージョン 0.9 で追加.

パラメータ

filename (Optional[str]) --

戻り値の型

Optional[int]

propertygot_first_request:bool¶

This attribute is set toTrue if the application startedhandling the first request.

Changelog

バージョン 0.8 で追加.

handle_exception(e)¶

Handle an exception that did not have an error handlerassociated with it, or that was raised from an error handler.This always causes a 500InternalServerError.

Always sends thegot_request_exception signal.

Ifpropagate_exceptions isTrue, such as in debugmode, the error will be re-raised so that the debugger candisplay it. Otherwise, the original exception is logged, andanInternalServerError is returned.

If an error handler is registered forInternalServerError or500, it will be used. For consistency, the handler willalways receive theInternalServerError. The originalunhandled exception is available ase.original_exception.

Changelog

バージョン 1.1.0 で変更:Always passes theInternalServerError instance to thehandler, settingoriginal_exception to the unhandlederror.

バージョン 1.1.0 で変更:after_request functions and other finalization is doneeven for the default 500 response when there is no handler.

バージョン 0.3 で追加.

パラメータ

e (Exception) --

戻り値の型

flask.wrappers.Response

handle_http_exception(e)¶

Handles an HTTP exception. By default this will invoke theregistered error handlers and fall back to returning theexception as response.

Changelog

バージョン 1.0.3 で変更:RoutingException, used internally for actions such as slash redirects during routing, is not passed to error handlers.

バージョン 1.0 で変更:Exceptions are looked up by codeand by MRO, soHTTPException subclasses can be handled with a catch-allhandler for the baseHTTPException.

バージョン 0.3 で追加.

パラメータ

e (werkzeug.exceptions.HTTPException) --

戻り値の型

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

handle_url_build_error(error,endpoint,values)¶

Called byurl_for() if aBuildError was raised. If this returnsa value, it will be returned byurl_for, otherwise the errorwill be re-raised.

Each function inurl_build_error_handlers is called witherror,endpoint andvalues. If a function returnsNone or raises aBuildError, it is skipped. Otherwise,its return value is returned byurl_for.

パラメータ

• error (werkzeug.routing.exceptions.BuildError) -- The activeBuildError being handled.

• endpoint (str) -- The endpoint being built.

• values (Dict[str,Any]) -- The keyword arguments passed tourl_for.

戻り値の型

str

handle_user_exception(e)¶

This method is called whenever an exception occurs thatshould be handled. A special case isHTTPException which is forwarded to thehandle_http_exception() method. This function will eitherreturn a response value or reraise the exception with the sametraceback.

Changelog

バージョン 1.0 で変更:Key errors raised from request data likeform show thebad key in debug mode rather than a generic bad requestmessage.

バージョン 0.7 で追加.

パラメータ

e (Exception) --

戻り値の型

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

propertyhas_static_folder:bool¶

True ifstatic_folder is set.

Changelog

バージョン 0.5 で追加.

import_name¶

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

inject_url_defaults(endpoint,values)¶

Injects the URL defaults for the given endpoint directly intothe values dictionary passed. This is used internally andautomatically called on URL building.

Changelog

バージョン 0.7 で追加.

パラメータ

• endpoint (str) --

• values (dict) --

戻り値の型

None

instance_path¶

Holds the path to the instance folder.

Changelog

バージョン 0.8 で追加.

iter_blueprints()¶

Iterates over all blueprints by the order they were registered.

Changelog

バージョン 0.11 で追加.

戻り値の型

ValuesView[Blueprint]

propertyjinja_env:flask.templating.Environment¶

The Jinja environment used to load templates.

The environment is created the first time this property isaccessed. Changingjinja_options after that will have noeffect.

jinja_environment¶

:py:class:`flask.templating.Environment`の別名です。

propertyjinja_loader:Optional[jinja2.loaders.FileSystemLoader]¶

The Jinja loader for this object's templates. By default thisis a classjinja2.loaders.FileSystemLoader totemplate_folder if it is set.

Changelog

バージョン 0.5 で追加.

jinja_options:dict={}¶

Options that are passed to the Jinja environment increate_jinja_environment(). Changing these options afterthe environment is created (accessingjinja_env) willhave no effect.

Changelog

バージョン 1.1.0 で変更:This is adict instead of anImmutableDict to alloweasier configuration.

json:JSONProvider¶

Provides access to JSON methods. Functions inflask.jsonwill call methods on this provider when the application contextis active. Used for handling JSON requests and responses.

An instance ofjson_provider_class. Can be customized bychanging that attribute on a subclass, or by assigning to thisattribute afterwards.

The default,DefaultJSONProvider,uses Python's built-injson library. A different providercan use a different JSON library.

バージョン 2.2 で追加.

propertyjson_decoder:Type[json.decoder.JSONDecoder]¶

The JSON decoder class to use. Defaults toJSONDecoder.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Customizejson_provider_class instead.

Changelog

バージョン 0.10 で追加.

propertyjson_encoder:Type[json.encoder.JSONEncoder]¶

The JSON encoder class to use. Defaults toJSONEncoder.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Customizejson_provider_class instead.

Changelog

バージョン 0.10 で追加.

json_provider_class¶

:py:class:`flask.json.provider.DefaultJSONProvider`の別名です。

log_exception(exc_info)¶

Logs an exception. This is called byhandle_exception()if debugging is disabled and right before the handler is called.The default implementation logs the exception as error on thelogger.

Changelog

バージョン 0.8 で追加.

パラメータ

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

戻り値の型

None

propertylogger:logging.Logger¶

A standard PythonLogger for the app, withthe same name asname.

In debug mode, the logger'slevel willbe set toDEBUG.

If there are no handlers configured, a default handler will beadded. Seeログ処理（Logging） for more information.

Changelog

バージョン 1.1.0 で変更:The logger takes the same name asname rather thanhard-coding"flask.app".

バージョン 1.0.0 で変更:Behavior was simplified. The logger is always named"flask.app". The level is only set during configuration,it doesn't checkapp.debug each time. Only one format isused, not different ones depending onapp.debug. Nohandlers are removed, and a handler is only added if nohandlers are already configured.

バージョン 0.3 で追加.

make_aborter()¶

Create the object to assign toaborter. That objectis called byflask.abort() to raise HTTP errors, and canbe called directly as well.

By default, this creates an instance ofaborter_class,which defaults towerkzeug.exceptions.Aborter.

バージョン 2.2 で追加.

戻り値の型

werkzeug.exceptions.Aborter

make_config(instance_relative=False)¶

Used to create the config attribute by the Flask constructor.Theinstance_relative parameter is passed in from the constructorof Flask (there namedinstance_relative_config) and indicates ifthe config should be relative to the instance path or the root pathof the application.

Changelog

バージョン 0.8 で追加.

パラメータ

instance_relative (bool) --

戻り値の型

flask.config.Config

make_default_options_response()¶

This method is called to create the defaultOPTIONS response.This can be changed through subclassing to change the defaultbehavior ofOPTIONS responses.

Changelog

バージョン 0.7 で追加.

戻り値の型

flask.wrappers.Response

make_response(rv)¶

Convert the return value from a view function to an instance ofresponse_class.

パラメータ

rv (Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int],Tuple[Union[Response,str,bytes,List[Any],Mapping[str,Any],Iterator[str],Iterator[bytes]],int,Union[Headers,Mapping[str,Union[str,List[str],Tuple[str,...]]],Sequence[Tuple[str,Union[str,List[str],Tuple[str,...]]]]]],WSGIApplication]) --

the return value from the view function. The view functionmust return a response. ReturningNone, or the view endingwithout returning, is not allowed. The following types are allowedforview_rv:

str

A response object is created with the string encoded to UTF-8as the body.

bytes

A response object is created with the bytes as the body.

dict

A dictionary that will be jsonify'd before being returned.

list

A list that will be jsonify'd before being returned.

generator oriterator

A generator that returnsstr orbytes to bestreamed as the response.

tuple

Either(body,status,headers),(body,status), or(body,headers), wherebody is any of the other typesallowed here,status is a string or an integer, andheaders is a dictionary or a list of(key,value)tuples. Ifbody is aresponse_class instance,status overwrites the exiting value andheaders areextended.

response_class

The object is returned unchanged.

otherResponse class

The object is coerced toresponse_class.

callable()

The function is called as a WSGI application. The result isused to create a response object.

戻り値の型

flask.wrappers.Response

バージョン 2.2 で変更:A generator will be converted to a streaming response.A list will be converted to a JSON response.

Changelog

バージョン 1.1 で変更:A dict will be converted to a JSON response.

バージョン 0.9 で変更:Previously a tuple was interpreted as the arguments for theresponse object.

make_shell_context()¶

Returns the shell context for an interactive shell for thisapplication. This runs all the registered shell contextprocessors.

Changelog

バージョン 0.11 で追加.

戻り値の型

dict

propertyname:str¶

The name of the application. This is usually the import namewith the difference that it's guessed from the run file if theimport name is main. This name is used as a display name whenFlask needs the name of the application. It can be set and overriddento change the value.

Changelog

バージョン 0.8 で追加.

open_instance_resource(resource,mode='rb')¶

Opens a resource from the application's instance folder(instance_path). Otherwise works likeopen_resource(). Instance resources can also be opened forwriting.

パラメータ

• resource (str) -- the name of the resource. To access resources withinsubfolders use forward slashes as separator.

• mode (str) -- resource file opening mode, default is 'rb'.

戻り値の型

IO

open_resource(resource,mode='rb')¶

Open a resource file relative toroot_path forreading.

For example, if the fileschema.sql is next to the fileapp.py where theFlask app is defined, it can be openedwith:

withapp.open_resource("schema.sql")asf:conn.executescript(f.read())

パラメータ

• resource (str) -- Path to the resource relative toroot_path.

• mode (str) -- Open the file in this mode. Only reading issupported, valid values are "r" (or "rt") and "rb".

戻り値の型

IO

patch(rule,**options)¶

Shortcut forroute() withmethods=["PATCH"].

Changelog

バージョン 2.0 で追加.

パラメータ

• rule (str) --

• options (Any) --

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

permanent_session_lifetime¶

Atimedelta which is used to set the expirationdate of a permanent session. The default is 31 days which makes apermanent session survive for roughly one month.

This attribute can also be configured from the config with thePERMANENT_SESSION_LIFETIME configuration key. Defaults totimedelta(days=31)

post(rule,**options)¶

Shortcut forroute() withmethods=["POST"].

Changelog

バージョン 2.0 で追加.

パラメータ

• rule (str) --

• options (Any) --

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

preprocess_request()¶

Called before the request is dispatched. Callsurl_value_preprocessors registered with the app and thecurrent blueprint (if any). Then callsbefore_request_funcsregistered with the app and the blueprint.

If anybefore_request() handler returns a non-None value, thevalue is handled as if it was the return value from the view, andfurther request handling is stopped.

戻り値の型

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

process_response(response)¶

Can be overridden in order to modify the response objectbefore it's sent to the WSGI server. By default this willcall all theafter_request() decorated functions.

Changelog

バージョン 0.5 で変更:As of Flask 0.5 the functions registered for after requestexecution are called in reverse order of registration.

パラメータ

response (flask.wrappers.Response) -- aresponse_class object.

戻り値

a new response object or the same, has to be aninstance ofresponse_class.

戻り値の型

flask.wrappers.Response

propertypropagate_exceptions:bool¶

Returns the value of thePROPAGATE_EXCEPTIONS configurationvalue in case it's set, otherwise a sensible default is returned.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3.

Changelog

バージョン 0.7 で追加.

put(rule,**options)¶

Shortcut forroute() withmethods=["PUT"].

Changelog

バージョン 2.0 で追加.

パラメータ

• rule (str) --

• options (Any) --

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

redirect(location,code=302)¶

Create a redirect response object.

This is called byflask.redirect(), and can be calleddirectly as well.

パラメータ

• location (str) -- The URL to redirect to.

• code (int) -- The status code for the redirect.

戻り値の型

werkzeug.wrappers.response.Response

バージョン 2.2 で追加:Moved fromflask.redirect, which calls this method.

register_blueprint(blueprint,**options)¶

Register aBlueprint on the application. Keywordarguments passed to this method will override the defaults set on theblueprint.

Calls the blueprint'sregister() method afterrecording the blueprint in the application'sblueprints.

パラメータ

• blueprint (Blueprint) -- The blueprint to register.

• url_prefix -- Blueprint routes will be prefixed with this.

• subdomain -- Blueprint routes will match on this subdomain.

• url_defaults -- Blueprint routes will use these default values forview arguments.

• options (Any) -- Additional keyword arguments are passed toBlueprintSetupState. They can beaccessed inrecord() callbacks.

戻り値の型

None

Changelog

バージョン 2.0.1 で変更:Thename option can be used to change the (pre-dotted)name the blueprint is registered with. This allows the sameblueprint to be registered multiple times with unique namesforurl_for.

バージョン 0.7 で追加.

register_error_handler(code_or_exception,f)¶

Alternative error attach function to theerrorhandler()decorator that is more straightforward to use for non decoratorusage.

Changelog

バージョン 0.7 で追加.

パラメータ

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

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

戻り値の型

None

request_class¶

:py:class:`flask.wrappers.Request`の別名です。

request_context(environ)¶

Create aRequestContext representing aWSGI environment. Use awith block to push the context,which will makerequest point at this request.

Seeリクエストのコンテキスト（The Request Context）.

Typically you should not call this from your own code. A requestcontext is automatically pushed by thewsgi_app() whenhandling a request. Usetest_request_context() to createan environment and context instead of this method.

パラメータ

environ (dict) -- a WSGI environment

戻り値の型

flask.ctx.RequestContext

response_class¶

:py:class:`flask.wrappers.Response`の別名です。

root_path¶

Absolute path to the package on the filesystem. Used to lookup resources contained in the package.

route(rule,**options)¶

Decorate a view function to register it with the given URLrule and options. Callsadd_url_rule(), which has moredetails about the implementation.

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

SeeURL Route Registrations.

The endpoint name for the route defaults to the name of the viewfunction if theendpoint parameter isn't passed.

Themethods parameter defaults to["GET"].HEAD andOPTIONS are added automatically.

パラメータ

• rule (str) -- The URL rule string.

• options (Any) -- Extra options passed to theRule object.

戻り値の型

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

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

Runs the application on a local development server.

Do not userun() in a production setting. It is not intended tomeet security and performance requirements for a production server.Instead, see本番環境への展開（Deployment to Production） for WSGI server recommendations.

If thedebug flag is set the server will automatically reloadfor code changes and show a debugger in case an exception happened.

If you want to run the application in debug mode, but disable thecode execution on the interactive debugger, you can passuse_evalex=False as parameter. This will keep the debugger'straceback screen active, but disable code execution.

It is not recommended to use this function for development withautomatic reloading as this is badly supported. Instead you shouldbe using theflask command line script'srun support.

Keep in Mind

Flask will suppress any server error with a generic error pageunless it is in debug mode. As such to enable just theinteractive debugger without the code reloading, you have toinvokerun() withdebug=True anduse_reloader=False.Settinguse_debugger toTrue without being in debug modewon't catch any exceptions because there won't be any tocatch.

パラメータ

• host (Optional[str]) -- the hostname to listen on. Set this to'0.0.0.0' tohave the server available externally as well. Defaults to'127.0.0.1' or the host in theSERVER_NAME config variableif present.

• port (Optional[int]) -- the port of the webserver. Defaults to5000 or theport defined in theSERVER_NAME config variable if present.

• debug (Optional[bool]) -- if given, enable or disable debug mode. Seedebug.

• load_dotenv (bool) -- Load the nearest.env and.flaskenvfiles to set environment variables. Will also change the workingdirectory to the directory containing the first file found.

• options (Any) -- the options to be forwarded to the underlying Werkzeugserver. Seewerkzeug.serving.run_simple() for moreinformation.

戻り値の型

None

Changelog

バージョン 1.0 で変更:If installed, python-dotenv will be used to load environmentvariables from.env and.flaskenv files.

TheFLASK_DEBUG environment variable will overridedebug.

Threaded mode is enabled by default.

バージョン 0.10 で変更:The default port is now picked from theSERVER_NAMEvariable.

secret_key¶

If a secret key is set, cryptographic components can use this tosign cookies and other things. Set this to a complex random valuewhen you want to use the secure cookie for instance.

This attribute can also be configured from the config with theSECRET_KEY configuration key. Defaults toNone.

select_jinja_autoescape(filename)¶

ReturnsTrue if autoescaping should be active for the giventemplate name. If no template name is given, returnsTrue.

Changelog

バージョン 0.5 で追加.

パラメータ

filename (str) --

戻り値の型

bool

propertysend_file_max_age_default:Optional[datetime.timedelta]¶

The default value formax_age forsend_file(). The defaultisNone, which tells the browser to use conditional requests instead of atimed cache.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Useapp.config["SEND_FILE_MAX_AGE_DEFAULT"] instead.

Changelog

バージョン 2.0 で変更:Defaults toNone instead of 12 hours.

send_static_file(filename)¶

The view function used to serve files fromstatic_folder. A route is automatically registered forthis view atstatic_url_path ifstatic_folder isset.

Changelog

バージョン 0.5 で追加.

パラメータ

filename (str) --

戻り値の型

Response

propertysession_cookie_name:str¶

The name of the cookie set by the session interface.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Useapp.config["SESSION_COOKIE_NAME"]instead.

session_interface:flask.sessions.SessionInterface=<flask.sessions.SecureCookieSessionInterfaceobject>¶

the session interface to use. By default an instance ofSecureCookieSessionInterface is used here.

Changelog

バージョン 0.8 で追加.

shell_context_processor(f)¶

Registers a shell context processor function.

Changelog

バージョン 0.11 で追加.

パラメータ

f (flask.app.T_shell_context_processor) --

戻り値の型

flask.app.T_shell_context_processor

shell_context_processors:t.List[ft.ShellContextProcessorCallable]¶

A list of shell context processor functions that should be runwhen a shell context is created.

Changelog

バージョン 0.11 で追加.

should_ignore_error(error)¶

This is called to figure out if an error should be ignoredor not as far as the teardown system is concerned. If thisfunction returnsTrue then the teardown handlers will not bepassed the error.

Changelog

バージョン 0.10 で追加.

パラメータ

error (Optional[BaseException]) --

戻り値の型

bool

propertystatic_folder:Optional[str]¶

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

propertystatic_url_path:Optional[str]¶

The URL prefix that the static route will be accessible from.

If it was not configured during init, it is derived fromstatic_folder.

teardown_appcontext(f)¶

Registers a function to be called when the applicationcontext is popped. The application context is typically poppedafter the request context for each request, at the end of CLIcommands, or after a manually pushed context ends.

withapp.app_context():...

When thewith block exits (orctx.pop() is called), theteardown functions are called just before the app context ismade inactive. Since a request context typically also manages anapplication context it would also be called when you pop arequest context.

When a teardown function was called because of an unhandledexception it will be passed an error object. If anerrorhandler() is registered, it will handle the exceptionand the teardown will not receive it.

Teardown functions must avoid raising exceptions. If theyexecute code that might fail they must surround that code with atry/except block and log any errors.

The return values of teardown functions are ignored.

Changelog

バージョン 0.9 で追加.

パラメータ

f (flask.app.T_teardown) --

戻り値の型

flask.app.T_teardown

teardown_appcontext_funcs:t.List[ft.TeardownCallable]¶

A list of functions that are called when the application contextis destroyed. Since the application context is also torn downif the request ends this is the place to store code that disconnectsfrom databases.

Changelog

バージョン 0.9 で追加.

teardown_request(f)¶

Register a function to be called when the request context ispopped. Typically this happens at the end of each request, butcontexts may be pushed manually as well during testing.

withapp.test_request_context():...

When thewith block exits (orctx.pop() is called), theteardown functions are called just before the request context ismade inactive.

When a teardown function was called because of an unhandledexception it will be passed an error object. If anerrorhandler() is registered, it will handle the exceptionand the teardown will not receive it.

Teardown functions must avoid raising exceptions. If theyexecute code that might fail they must surround that code with atry/except block and log any errors.

The return values of teardown functions are ignored.

パラメータ

f (flask.scaffold.T_teardown) --

戻り値の型

flask.scaffold.T_teardown

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

A data structure of functions to call at the end of eachrequest even if an exception is raised, in the format{scope:[functions]}. Thescope key is the name of ablueprint the functions are active for, orNone for allrequests.

To register a function, use theteardown_request()decorator.

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

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

A data structure of functions to call to pass extra contextvalues when rendering templates, in the format{scope:[functions]}. Thescope key is the name of ablueprint the functions are active for, orNone for allrequests.

To register a function, use thecontext_processor()decorator.

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

template_filter(name=None)¶

A decorator that is used to register custom template filter.You can specify a name for the filter, otherwise the functionname will be used. Example:

@app.template_filter()defreverse(s):returns[::-1]

パラメータ

name (Optional[str]) -- the optional name of the filter, otherwise thefunction name will be used.

戻り値の型

Callable[[flask.app.T_template_filter], flask.app.T_template_filter]

template_folder¶

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

template_global(name=None)¶

A decorator that is used to register a custom template global function.You can specify a name for the global function, otherwise the functionname will be used. Example:

@app.template_global()defdouble(n):return2*n

Changelog

バージョン 0.10 で追加.

パラメータ

name (Optional[str]) -- the optional name of the global function, otherwise thefunction name will be used.

戻り値の型

Callable[[flask.app.T_template_global], flask.app.T_template_global]

template_test(name=None)¶

A decorator that is used to register custom template test.You can specify a name for the test, otherwise the functionname will be used. Example:

@app.template_test()defis_prime(n):ifn==2:returnTrueforiinrange(2,int(math.ceil(math.sqrt(n)))+1):ifn%i==0:returnFalsereturnTrue

Changelog

バージョン 0.10 で追加.

パラメータ

name (Optional[str]) -- the optional name of the test, otherwise thefunction name will be used.

戻り値の型

Callable[[flask.app.T_template_test], flask.app.T_template_test]

propertytemplates_auto_reload:bool¶

Reload templates when they are changed. Used bycreate_jinja_environment(). It is enabled by default in debug mode.

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Useapp.config["TEMPLATES_AUTO_RELOAD"]instead.

Changelog

バージョン 1.0 で追加:This property was added but the underlying config and behavioralready existed.

test_cli_runner(**kwargs)¶

Create a CLI runner for testing CLI commands.SeeCLI実行プログラムを使ったコマンドの実行.

Returns an instance oftest_cli_runner_class, by defaultFlaskCliRunner. The Flask app object ispassed as the first argument.

Changelog

バージョン 1.0 で追加.

パラメータ

kwargs (Any) --

戻り値の型

FlaskCliRunner

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

TheCliRunner subclass, by defaultFlaskCliRunner that is used bytest_cli_runner(). Its__init__ method should take aFlask app object as the first argument.

Changelog

バージョン 1.0 で追加.

test_client(use_cookies=True,**kwargs)¶

Creates a test client for this application. For informationabout unit testing head over toFlaskアプリケーションのテスト.

Note that if you are testing for assertions or exceptions in yourapplication code, you must setapp.testing=True in order for theexceptions to propagate to the test client. Otherwise, the exceptionwill be handled by the application (not visible to the test client) andthe only indication of an AssertionError or other exception will be a500 status code response to the test client. See thetestingattribute. For example:

app.testing=Trueclient=app.test_client()

The test client can be used in awith block to defer the closing downof the context until the end of thewith block. This is useful ifyou want to access the context locals for testing:

withapp.test_client()asc:rv=c.get('/?vodka=42')assertrequest.args['vodka']=='42'

Additionally, you may pass optional keyword arguments that will thenbe passed to the application'stest_client_class constructor.For example:

fromflask.testingimportFlaskClientclassCustomClient(FlaskClient):def__init__(self,*args,**kwargs):self._authentication=kwargs.pop("authentication")super(CustomClient,self).__init__(*args,**kwargs)app.test_client_class=CustomClientclient=app.test_client(authentication='Basic ....')

SeeFlaskClient for more information.

Changelog

バージョン 0.11 で変更:Added**kwargs to support passing additional keyword arguments tothe constructor oftest_client_class.

バージョン 0.7 で追加:Theuse_cookies parameter was added as well as the abilityto override the client to be used by setting thetest_client_class attribute.

バージョン 0.4 で変更:added support forwith block usage for the client.

パラメータ

• use_cookies (bool) --

• kwargs (Any) --

戻り値の型

FlaskClient

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

Thetest_client() method creates an instance of this testclient class. Defaults toFlaskClient.

Changelog

バージョン 0.7 で追加.

test_request_context(*args,**kwargs)¶

Create aRequestContext for a WSGIenvironment created from the given values. This is mostly usefulduring testing, where you may want to run a function that usesrequest data without dispatching a full request.

Seeリクエストのコンテキスト（The Request Context）.

Use awith block to push the context, which will makerequest point at the request for the createdenvironment.

withtest_request_context(...):generate_report()

When using the shell, it may be easier to push and pop thecontext manually to avoid indentation.

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

Takes the same arguments as Werkzeug'sEnvironBuilder, with some defaults fromthe application. See the linked Werkzeug docs for most of theavailable arguments. Flask-specific behavior is listed here.

パラメータ

• path -- URL path being requested.

• base_url -- Base URL where the app is being served, whichpath is relative to. If not given, built fromPREFERRED_URL_SCHEME,subdomain,SERVER_NAME, andAPPLICATION_ROOT.

• subdomain -- Subdomain name to append toSERVER_NAME.

• url_scheme -- Scheme to use instead ofPREFERRED_URL_SCHEME.

• data -- The request body, either as a string or a dict ofform keys and values.

• json -- If given, this is serialized as JSON and passed asdata. Also defaultscontent_type toapplication/json.

• args (Any) -- other positional arguments passed toEnvironBuilder.

• kwargs (Any) -- other keyword arguments passed toEnvironBuilder.

戻り値の型

flask.ctx.RequestContext

testing¶

The testing flag. Set this toTrue to enable the test mode ofFlask extensions (and in the future probably also Flask itself).For example this might activate test helpers that have anadditional runtime cost which should not be enabled by default.

If this is enabled and PROPAGATE_EXCEPTIONS is not changed from thedefault it's implicitly enabled.

This attribute can also be configured from the config with theTESTING configuration key. Defaults toFalse.

trap_http_exception(e)¶

Checks if an HTTP exception should be trapped or not. By defaultthis will returnFalse for all exceptions except for a bad requestkey error ifTRAP_BAD_REQUEST_ERRORS is set toTrue. Italso returnsTrue ifTRAP_HTTP_EXCEPTIONS is set toTrue.

This is called for all HTTP exceptions raised by a view function.If it returnsTrue for any exception the error handler for thisexception is not called and it shows up as regular exception in thetraceback. This is helpful for debugging implicitly raised HTTPexceptions.

Changelog

バージョン 1.0 で変更:Bad request errors are not trapped by default in debug mode.

バージョン 0.8 で追加.

パラメータ

e (Exception) --

戻り値の型

bool

update_template_context(context)¶

Update the template context with some commonly used variables.This injects request, session, config and g into the templatecontext as well as everything template context processors wantto inject. Note that the as of Flask 0.6, the original valuesin the context will not be overridden if a context processordecides to return a value with the same key.

パラメータ

context (dict) -- the context as a dictionary that is updated in placeto add extra variables.

戻り値の型

None

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

A list of functions that are called byhandle_url_build_error() whenurl_for() raises aBuildError. Each function is calledwitherror,endpoint andvalues. If a functionreturnsNone or raises aBuildError, it is skipped.Otherwise, its return value is returned byurl_for.

Changelog

バージョン 0.9 で追加.

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

A data structure of functions to call to modify the keywordarguments when generating URLs, in the format{scope:[functions]}. Thescope key is the name of ablueprint the functions are active for, orNone for allrequests.

To register a function, use theurl_defaults()decorator.

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

url_defaults(f)¶

Callback function for URL defaults for all view functions of theapplication. It's called with the endpoint and values and shouldupdate the values passed in place.

パラメータ

f (flask.scaffold.T_url_defaults) --

戻り値の型

flask.scaffold.T_url_defaults

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

Generate a URL to the given endpoint with the given values.

This is called byflask.url_for(), and can be calleddirectly as well.

Anendpoint is the name of a URL rule, usually added with@app.route(), and usually the same name as theview function. A route defined in aBlueprintwill prepend the blueprint's name separated by a. to theendpoint.

In some cases, such as email messages, you want URLs to includethe scheme and domain, likehttps://example.com/hello. Whennot in an active request, URLs will be external by default, butthis requires settingSERVER_NAME so Flask knows whatdomain to use.APPLICATION_ROOT andPREFERRED_URL_SCHEME should also be configured asneeded. This config is only used when not in an active request.

Functions can be decorated withurl_defaults() to modifykeyword arguments before the URL is built.

If building fails for some reason, such as an unknown endpointor incorrect values, the app'shandle_url_build_error()method is called. If that returns a string, that is returned,otherwise aBuildError is raised.

パラメータ

• endpoint (str) -- The endpoint name associated with the URL togenerate. If this starts with a., the current blueprintname (if any) will be used.

• _anchor (Optional[str]) -- If given, append this as#anchor to the URL.

• _method (Optional[str]) -- If given, generate the URL associated with thismethod for the endpoint.

• _scheme (Optional[str]) -- If given, the URL will have this scheme if itis external.

• _external (Optional[bool]) -- If given, prefer the URL to be internal(False) or require it to be external (True). External URLsinclude the scheme and domain. When not in an activerequest, URLs are external by default.

• values (Any) -- Values to use for the variable parts of the URLrule. Unknown keys are appended as query string arguments,like?a=b&c=d.

戻り値の型

str

バージョン 2.2 で追加:Moved fromflask.url_for, which calls this method.

url_map¶

TheMap for this instance. You can usethis to change the routing converters after the class was createdbut before any routes are connected. Example:

fromwerkzeug.routingimportBaseConverterclassListConverter(BaseConverter):defto_python(self,value):returnvalue.split(',')defto_url(self,values):return','.join(super(ListConverter,self).to_url(value)forvalueinvalues)app=Flask(__name__)app.url_map.converters['list']=ListConverter

url_map_class¶

:py:class:`werkzeug.routing.map.Map`の別名です。

url_rule_class¶

:py:class:`werkzeug.routing.rules.Rule`の別名です。

url_value_preprocessor(f)¶

Register a URL value preprocessor function for all viewfunctions in the application. These functions will be called before thebefore_request() functions.

The function can modify the values captured from the matched url beforethey are passed to the view. For example, this can be used to pop acommon language code value and place it ing rather than pass it toevery view.

The function is passed the endpoint name and values dict. The returnvalue is ignored.

パラメータ

f (flask.scaffold.T_url_value_preprocessor) --

戻り値の型

flask.scaffold.T_url_value_preprocessor

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

A data structure of functions to call to modify the keywordarguments passed to the view function, in the format{scope:[functions]}. Thescope key is the name of ablueprint the functions are active for, orNone for allrequests.

To register a function, use theurl_value_preprocessor() decorator.

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

propertyuse_x_sendfile:bool¶

Enable this to use theX-Sendfile feature, assuming the server supportsit, fromsend_file().

バージョン 2.2 で非推奨:Will be removed in Flask 2.3. Useapp.config["USE_X_SENDFILE"] instead.

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

A dictionary mapping endpoint names to view functions.

To register a view function, use theroute() decorator.

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

wsgi_app(environ,start_response)¶

The actual WSGI application. This is not implemented in__call__() so that middlewares can be applied withoutlosing a reference to the app object. Instead of doing this:

app=MyMiddleware(app)

It's a better idea to do this instead:

app.wsgi_app=MyMiddleware(app.wsgi_app)

Then you still have the original application object around andcan continue to call methods on it.

Changelog

バージョン 0.7 で変更:Teardown events for the request and app contexts are calledeven if an unhandled error occurs. Other events may not becalled depending on when an error occurs during dispatch.Seeコールバックとエラー.

パラメータ

• environ (dict) -- A WSGI environment.

• start_response (Callable) -- A callable accepting a status code,a list of headers, and an optional exception context tostart the response.

戻り値の型

Any

Represents a blueprint, a collection of routes and otherapp-related functions that can be registered on a real applicationlater.

A blueprint is an object that allows defining application functionswithout requiring an application object ahead of time. It uses thesame decorators asFlask, but defers the need for anapplication by recording them for later registration.

Decorating a function with a blueprint creates a deferred functionthat is called withBlueprintSetupStatewhen the blueprint is registered on an application.

SeeBlueprintを使ったアプリケーションのモジュール化 for more information.

パラメータ

• name (str) -- The name of the blueprint. Will be prepended to eachendpoint name.

• import_name (str) -- The name of the blueprint package, usually__name__. This helps locate theroot_path for theblueprint.

• static_folder (Optional[Union[str,os.PathLike]]) -- A folder with static files that should beserved by the blueprint's static route. The path is relative tothe blueprint's root path. Blueprint static files are disabledby default.

• static_url_path (Optional[str]) -- The url to serve static files from.Defaults tostatic_folder. If the blueprint does not haveaurl_prefix, the app's static route will take precedence,and the blueprint's static files won't be accessible.

• template_folder (Optional[str]) -- A folder with templates that should be addedto the app's template search path. The path is relative to theblueprint's root path. Blueprint templates are disabled bydefault. Blueprint templates have a lower precedence than thosein the app's templates folder.

• url_prefix (Optional[str]) -- A path to prepend to all of the blueprint's URLs,to make them distinct from the rest of the app's routes.

• subdomain (Optional[str]) -- A subdomain that blueprint routes will match on bydefault.

• url_defaults (Optional[dict]) -- A dict of default values that blueprint routeswill receive by default.

• root_path (Optional[str]) -- By default, the blueprint will automatically setthis based onimport_name. In certain situations thisautomatic detection can fail, so the path can be specifiedmanually instead.

• cli_group (Optional[str]) --

add_app_template_filter(f,name=None)¶

Register a custom template filter, available application wide. LikeFlask.add_template_filter() but for a blueprint. Works exactlylike theapp_template_filter() decorator.

パラメータ

• name (Optional[str]) -- the optional name of the filter, otherwise thefunction name will be used.

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

戻り値の型

None

add_app_template_global(f,name=None)¶

Register a custom template global, available application wide. LikeFlask.add_template_global() but for a blueprint. Works exactlylike theapp_template_global() decorator.

Changelog

バージョン 0.10 で追加.

パラメータ

• name (Optional[str]) -- the optional name of the global, otherwise thefunction name will be used.

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

戻り値の型

None

add_app_template_test(f,name=None)¶

Register a custom template test, available application wide. LikeFlask.add_template_test() but for a blueprint. Works exactlylike theapp_template_test() decorator.

Changelog

バージョン 0.10 で追加.

パラメータ

• name (Optional[str]) -- the optional name of the test, otherwise thefunction name will be used.

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

戻り値の型

None

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

LikeFlask.add_url_rule() but for a blueprint. The endpoint fortheurl_for() function is prefixed with the name of the blueprint.

パラメータ

• rule (str) --

• endpoint (Optional[str]) --

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

• provide_automatic_options (Optional[bool]) --

• options (Any) --

戻り値の型

None