/usr/local/lib64/python3.6/site-packages/flask/__pycache__
Edit: /usr/local/lib64/python3.6/site-packages/flask/__pycache__/app.cpython-36.pyc (62838B)
3
^TBg7@ @ s d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z d dl m
Z
d dlmZ d dlmZ d dlmZ d dlmZ d d lmZ d d
lmZ d d lmZ d d lmZ d d
lmZ d dlm Z d dlm Z d dlm Z d dlm Z d dlm Z d dl!m"Z# ddl$m%Z% ddl$m&Z& ddl'm(Z( ddl'm)Z) ddl*m+Z+ ddl*m,Z, ddl*m-Z- dd l.m/Z/ dd l.m0Z0 dd l.m1Z1 dd l.m2Z2 dd l3m4Z4 dd!l3m5Z5 dd"l3m6Z6 dd#l3m7Z7 dd$l3m8Z8 dd%l3m9Z9 dd&l3m:Z: dd'l&m;Z; dd(lm
Z> dd*l=m?Z? dd+l=m@Z@ dd,l=mAZA dd-l=mBZB dd.lCmDZD dd/lEmFZF dd0lEmGZG dd1lEmHZH dd2lEmIZI dd3lEmJZJ dd4lKmLZL dd5lKmMZM dd6lmNZN dd7lmOZO dd8lmPZP dd9lmQZQ dd:lmRZR dd;lmSZS ddl[m\Z\ dd?l[m]Z] dd@lm^Z^ ej_dKkrPej`Z`nejaebdCdDdEZ`ejce ejce dFdGdHZdG dIdJ dJeAZedS )L N) timedelta)chain)Lock)
TracebackType)Headers)
ImmutableDict)
BadRequest)BadRequestKeyError)
HTTPException)InternalServerError)
ContextVar)
BuildError)Map)
MapAdapter)RequestRedirect)RoutingException)Rule)Response )cli)json)Config)ConfigAttribute)_AppCtxGlobals)
AppContext)RequestContext)_request_ctx_stack)g)request)session)_split_blueprint_path)get_debug_flag)get_env)get_flashed_messages)get_load_dotenv)locked_cached_property)url_for)jsonify)
create_logger)_endpoint_from_view_func) _sentinel) find_package)Scaffold) setupmethod) SecureCookieSessionInterface)appcontext_tearing_down)got_request_exception)request_finished)request_started)request_tearing_down)DispatchingJinjaLoader) Environment)BeforeFirstRequestCallable)ResponseReturnValue)TeardownCallable)TemplateFilterCallable)TemplateGlobalCallable)TemplateTestCallable)Request) Blueprint) FlaskClient)FlaskCliRunner)ErrorHandlerCallable )funcreturnc C s8 xt j| r| j} qW xt| tjr,| j} qW t j| S )N)inspectZismethod__func__
isinstance functoolspartialrC iscoroutinefunction)rC rK */tmp/pip-build-0s3hx122/flask/flask/app.pyrJ Q s
rJ )valuerD c C s | d kst | tr| S t| dS )N)seconds)rG r )rM rK rK rL _make_timedelta[ s rO c s e Zd ZU dZeZeZeZ e
Z e Z
edZedZedZededZededZedZejZejZi Ze e d d d
d d d e d d d
d d
dd d dd
d dd d d d
d
dddd
dd dd Z e Z!e"Z#d Z$e%j&e%j'd $d Z(e%j&e%j'd (e) Z*de+e%j&e+ e%j&e%j,e+e-j.f e%j&e+ e/e/e%j&e+ e%j&e+ e/e%j&e+ d
fdd
Z0e/dd d Z1e2e+dd d Z3e4e/dd d!Z5e4e/dd"d#Z6e2e7j8dd$d%Z9e2edd&d'Z:e4e/dd(d)Z;de/e d*d+d,Ze%j? d0d1d2Z@e4e/dd3d4ZAeAjBe/d d5d6d4ZAedd7d8ZCeDdd9d:ZEe+e/d;dd?d@ZGe ddAdBZHedCZIe4e/ddDdEZJeJjBe/d d5dFdEZJde%j&e+ e%j&eK e%j&e/ e/e%jLd dGdHdIZMde/e%jLddJdKdLZNe%jLddMdNdOZOePdPe%jLd dQdRdSZQe%jRdP ddTdUZSePde+e%j&e+ e%j&e%jT e%j&e/ e%jLd dVdWdXZUePde%j&e+ e%jTeVgeVf dYdZd[ZWePdeVe%j&e+ d d\d]d^ZXePde%j&e+ e%jTeYgeYf dYd_d`ZZePdeYe%j&e+ d d\dadbZ[ePde%j&e+ e%jTe\ge\f dYdcddZ]ePde\e%j&e+ d d\dedfZ^ePe_e_dgdhdiZ`ePeaeadgdjdkZbePe%jTe%jTdgdldmZcede%j&dn dodpdqZeefe%j,efegf dodrdsZhede/dodtduZiede%j,efegf dodvdwZjededodxdyZke%j,e%jlemeneof e%jld f d dzd{d|Zped}d~ddZqegdddZredddZsde%j,egeff e/edddZtd dddZuedddZve%j&en e/dddZwe%jTe%jTdddZxe%jTde%jyf e%jTde%jLf dddZzegedddZ{e%j&e e%j&e| d~ddZ}e+e d dddZ~ede+e e+dddZe%j&eg dddZeedddZefe%j&en d dddZefe%j&en d dddZedddZe edddZe%jLe%jLedddZe e%jTe%jLdddZe e%jTe%jLdddZ ZS )Flaska The flask object implements a WSGI application and acts as the central
object. It is passed the name of the module or package of the
application. Once it is created it will act as a central registry for
the view functions, the URL rules, template configuration and much more.
The name of the package is used to resolve resources from inside the
package or the folder the module is contained in depending on if the
package parameter resolves to an actual python package (a folder with
an :file:`__init__.py` file inside) or a standard module (just a ``.py`` file).
For more information about resource loading, see :func:`open_resource`.
Usually you create a :class:`Flask` instance in your main module or
in the :file:`__init__.py` file of your package like this::
from flask import Flask
app = Flask(__name__)
.. admonition:: About the First Parameter
The idea of the first parameter is to give Flask an idea of what
belongs to your application. This name is used to find resources
on the filesystem, can be used by extensions to improve debugging
information and a lot more.
So it's important what you provide there. If you are using a single
module, `__name__` is always the correct value. If you however are
using a package, it's usually recommended to hardcode the name of
your package there.
For example if your application is defined in :file:`yourapplication/app.py`
you should create it with one of the two versions below::
app = Flask('yourapplication')
app = Flask(__name__.split('.')[0])
Why is that? The application will work even with `__name__`, thanks
to how resources are looked up. However it will make debugging more
painful. Certain extensions can make assumptions based on the
import name of your application. For example the Flask-SQLAlchemy
extension will look for the code in your application that triggered
an SQL query in debug mode. If the import name is not properly set
up, that debugging information is lost. (For example it would only
pick up SQL queries in `yourapplication.app` and not
`yourapplication.views.frontend`)
.. versionadded:: 0.7
The `static_url_path`, `static_folder`, and `template_folder`
parameters were added.
.. versionadded:: 0.8
The `instance_path` and `instance_relative_config` parameters were
added.
.. versionadded:: 0.11
The `root_path` parameter was added.
.. versionadded:: 1.0
The ``host_matching`` and ``static_host`` parameters were added.
.. versionadded:: 1.0
The ``subdomain_matching`` parameter was added. Subdomain
matching needs to be enabled manually now. Setting
:data:`SERVER_NAME` does not implicitly enable it.
:param import_name: the name of the application package
:param static_url_path: can be used to specify a different path for the
static files on the web. Defaults to the name
of the `static_folder` folder.
:param static_folder: The folder with static files that is served at
``static_url_path``. Relative to the application ``root_path``
or an absolute path. Defaults to ``'static'``.
:param static_host: the host to use when adding the static route.
Defaults to None. Required when using ``host_matching=True``
with a ``static_folder`` configured.
:param host_matching: set ``url_map.host_matching`` attribute.
Defaults to False.
:param subdomain_matching: consider the subdomain relative to
:data:`SERVER_NAME` when matching routes. Defaults to False.
:param template_folder: the folder that contains the templates that should
be used by the application. Defaults to
``'templates'`` folder in the root path of the
application.
:param instance_path: An alternative instance path for the application.
By default the folder ``'instance'`` next to the
package or module is assumed to be the instance
path.
:param instance_relative_config: if set to ``True`` relative filenames
for loading the config are assumed to
be relative to the instance path instead
of the application root.
:param 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.
TESTING
SECRET_KEYSESSION_COOKIE_NAMEPERMANENT_SESSION_LIFETIME)Z
get_converterSEND_FILE_MAX_AGE_DEFAULTUSE_X_SENDFILENF )days/r Thttpzapplication/jsoni ) ENVDEBUGrQ PROPAGATE_EXCEPTIONS PRESERVE_CONTEXT_ON_EXCEPTIONrR rT rV SERVER_NAMEAPPLICATION_ROOTrS ZSESSION_COOKIE_DOMAINZSESSION_COOKIE_PATHZSESSION_COOKIE_HTTPONLYZSESSION_COOKIE_SECUREZSESSION_COOKIE_SAMESITEZ SESSION_REFRESH_EACH_REQUESTZMAX_CONTENT_LENGTHrU TRAP_BAD_REQUEST_ERRORSTRAP_HTTP_EXCEPTIONSZEXPLAIN_TEMPLATE_LOADINGPREFERRED_URL_SCHEMEZ
JSON_AS_ASCIIZJSON_SORT_KEYSZJSONIFY_PRETTYPRINT_REGULARZJSONIFY_MIMETYPETEMPLATES_AUTO_RELOADZMAX_COOKIE_SIZEr> r? static templates)
import_namestatic_url_path
static_folder static_host
host_matchingsubdomain_matchingtemplate_folder
instance_pathinstance_relative_config root_pathc s t j|||||
d |d kr(| j }ntjj|sre c s j f | S )N)Zsend_static_file)kw)self_refrK rL s z Flask.__init__..)endpointhost view_func) super__init__auto_find_instance_pathospathisabs
ValueErrorrn make_configconfigurl_build_error_handlersbefore_first_request_funcsteardown_appcontext_funcsshell_context_processors
blueprints
extensions
url_map_classurl_maprk rl _got_first_requestr _before_request_lockZhas_static_folderboolAssertionErrorweakrefref add_url_rulerh namer ) selfrg rh ri rj rk rl rm rn ro rp ) __class__)rr rL rx sD
zFlask.__init__)rD c C s | j o
| jS )N)debugr )r rK rK rL _is_setup_finished
s zFlask._is_setup_finishedc C sF | j dkr@ttjd dd}|dkr(dS tjjtjj|d S | j S )a_ The name of the application. This is usually the import name
with the difference that it's guessed from the run file if the
import name is main. This name is used as a display name when
Flask needs the name of the application. It can be set and overridden
to change the value.
.. versionadded:: 0.8
__main____file__Nr )rg getattrsysmodulesrz r{ splitextbasename)r fnrK rK rL r
s
z
Flask.namec C s" | j d }|dk r|S | jp | jS )zReturns the value of the ``PROPAGATE_EXCEPTIONS`` configuration
value in case it's set, otherwise a sensible default is returned.
.. versionadded:: 0.7
r] N)r testingr )r rvrK rK rL propagate_exceptions s
zFlask.propagate_exceptionsc C s | j d }|dk r|S | jS )zReturns the value of the ``PRESERVE_CONTEXT_ON_EXCEPTION``
configuration value in case it's set, otherwise a sensible default
is returned.
.. versionadded:: 0.7
r^ N)r r )r r rK rK rL preserve_context_on_exception* s
z#Flask.preserve_context_on_exceptionc C s t | S )a A standard Python :class:`~logging.Logger` for the app, with
the same name as :attr:`name`.
In debug mode, the logger's :attr:`~logging.Logger.level` will
be set to :data:`~logging.DEBUG`.
If there are no handlers configured, a default handler will be
added. See :doc:`/logging` for more information.
.. versionchanged:: 1.1.0
The logger takes the same name as :attr:`name` rather than
hard-coding ``"flask.app"``.
.. versionchanged:: 1.0.0
Behavior was simplified. The logger is always named
``"flask.app"``. The level is only set during configuration,
it doesn't check ``app.debug`` each time. Only one format is
used, not different ones depending on ``app.debug``. No
handlers are removed, and a handler is only added if no
handlers are already configured.
.. versionadded:: 0.3
)r( )r rK rK rL logger7 s z Flask.loggerc C s | j S )zThe Jinja environment used to load templates.
The environment is created the first time this property is
accessed. Changing :attr:`jinja_options` after that will have no
effect.
)create_jinja_environment)r rK rK rL jinja_envR s zFlask.jinja_envc C s | j S )zThis attribute is set to ``True`` if the application started
handling the first request.
.. versionadded:: 0.8
)r )r rK rK rL got_first_request\ s zFlask.got_first_request)instance_relativerD c C s: | j }|r| j}t| j}t |d< t |d< | j||S )ad Used to create the config attribute by the Flask constructor.
The `instance_relative` parameter is passed in from the constructor
of Flask (there named `instance_relative_config`) and indicates if
the config should be relative to the instance path or the root path
of the application.
.. versionadded:: 0.8
r[ r\ )rp rn dictdefault_configr" r! config_class)r r rp defaultsrK rK rL r~ e s
zFlask.make_configc C s< t | j\}}|dkr$tjj|dS tjj|d| j dS )a Tries to locate the instance path if it was not provided to the
constructor of the application class. It will basically calculate
the path to a folder named ``instance`` next to your main file or
the package.
.. versionadded:: 0.8
Ninstancevarz -instance)r+ rg rz r{ joinr )r prefixZ package_pathrK rK rL ry v s z Flask.auto_find_instance_pathrb)resourcemoderD c C s t tjj| j||S )a Opens a resource from the application's instance folder
(:attr:`instance_path`). Otherwise works like
:meth:`open_resource`. Instance resources can also be opened for
writing.
:param resource: the name of the resource. To access resources within
subfolders use forward slashes as separator.
:param mode: resource file opening mode, default is 'rb'.
)openrz r{ r rn )r r r rK rK rL open_instance_resource s
z Flask.open_instance_resourcec C s | j d }|dk r|S | jS )am Reload templates when they are changed. Used by
:meth:`create_jinja_environment`.
This attribute can be configured with :data:`TEMPLATES_AUTO_RELOAD`. If
not set, it will be enabled in debug mode.
.. versionadded:: 1.0
This property was added but the underlying config and behavior
already existed.
rd N)r r )r r rK rK rL templates_auto_reload s
zFlask.templates_auto_reload)rM rD c C s || j d< d S )Nrd )r )r rM rK rK rL r s c C sf t | j}d|kr | j|d< d|kr.| j|d< | j| f|}|jjtt| j t
t t d t
j|jd< |S )a Create the Jinja environment based on :attr:`jinja_options`
and the various Jinja-related methods of the app. Changing
:attr:`jinja_options` after this will have no effect. Also adds
Flask-related globals and filters to the environment.
.. versionchanged:: 0.11
``Environment.auto_reload`` set in accordance with
``TEMPLATES_AUTO_RELOAD`` configuration option.
.. versionadded:: 0.5
Z
autoescape auto_reload)r& r# r r r r zjson.dumps_function)r
jinja_optionsselect_jinja_autoescaper jinja_environmentglobalsupdater& r# r r r r r dumpsZpolicies)r optionsr rK rK rL r s
z Flask.create_jinja_environmentc C s t | S )a Creates the loader for the Jinja2 environment. Can be used to
override just the loader and keeping the rest unchanged. It's
discouraged to override this function. Instead one should override
the :meth:`jinja_loader` function instead.
The global loader dispatches between the loaders of the application
and the individual blueprints.
.. versionadded:: 0.7
)r4 )r rK rK rL create_global_jinja_loader s z Flask.create_global_jinja_loader)filenamerD c C s |dkr dS |j dS )zReturns ``True`` if autoescaping should be active for the given
template name. If no template name is given, returns `True`.
.. versionadded:: 0.5
NT.html.htm.xml.xhtml)r r r r )endswith)r r rK rK rL r s z Flask.select_jinja_autoescape)contextrD c C sf d}t rt|tt j}|j }x6|D ].}|| jkr&x | j| D ]}|j| q@W q&W |j| dS )a Update the template context with some commonly used variables.
This injects request, session, config and g into the template
context as well as everything template context processors want
to inject. Note that the as of Flask 0.6, the original values
in the context will not be overridden if a context processor
decides to return a value with the same key.
:param context: the context as a dictionary that is updated in place
to add extra variables.
N)N)r r reversedr copyZtemplate_context_processorsr )r r namesZorig_ctxr rC rK rK rL update_template_context s
z Flask.update_template_contextc C s* | t d}x| jD ]}|j| qW |S )zReturns the shell context for an interactive shell for this
application. This runs all the registered shell context
processors.
.. versionadded:: 0.11
)Zappr )r r r )r r processorrK rK rL make_shell_context s
zFlask.make_shell_contextr[ c C s
| j d S )av Whether debug mode is enabled. When using ``flask run`` to start
the development server, an interactive debugger will be shown for
unhandled exceptions, and the server will be reloaded when code
changes. This maps to the :data:`DEBUG` config key. This is
enabled when :attr:`env` is ``'development'`` and is overridden
by the ``FLASK_DEBUG`` environment variable. It may not behave as
expected if set in code.
**Do not enable debug mode when deploying in production.**
Default: ``True`` if :attr:`env` is ``'development'``, or
``False`` otherwise.
r\ )r )r rK rK rL r s z Flask.debugc C s || j d< | j| j_d S )Nr\ )r r r r )r rM rK rK rL r s
)ru portr load_dotenvr rD c K sL t jjddkr&ddlm} | dS t|rdtj dt jkrRt | _ t
| _ ndt jkrdt
| _ |dk rvt || _ | j
jd}d }} |r|jd \}}
} |s|r|}nd
}|s|d krt|}n| rt| }nd }|jd
| j |jd| j |jdd tj| j | j | jd d dlm} z | tjt||| f| W dd| _X dS )a Runs the application on a local development server.
Do not use ``run()`` in a production setting. It is not intended to
meet security and performance requirements for a production server.
Instead, see :doc:`/deploying/index` for WSGI server recommendations.
If the :attr:`debug` flag is set the server will automatically reload
for code changes and show a debugger in case an exception happened.
If you want to run the application in debug mode, but disable the
code execution on the interactive debugger, you can pass
``use_evalex=False`` as parameter. This will keep the debugger's
traceback screen active, but disable code execution.
It is not recommended to use this function for development with
automatic reloading as this is badly supported. Instead you should
be using the :command:`flask` command line script's ``run`` support.
.. admonition:: Keep in Mind
Flask will suppress any server error with a generic error page
unless it is in debug mode. As such to enable just the
interactive debugger without the code reloading, you have to
invoke :meth:`run` with ``debug=True`` and ``use_reloader=False``.
Setting ``use_debugger`` to ``True`` without being in debug mode
won't catch any exceptions because there won't be any to
catch.
:param host: the hostname to listen on. Set this to ``'0.0.0.0'`` to
have the server available externally as well. Defaults to
``'127.0.0.1'`` or the host in the ``SERVER_NAME`` config variable
if present.
:param port: the port of the webserver. Defaults to ``5000`` or the
port defined in the ``SERVER_NAME`` config variable if present.
:param debug: if given, enable or disable debug mode. See
:attr:`debug`.
:param load_dotenv: Load the nearest :file:`.env` and :file:`.flaskenv`
files to set environment variables. Will also change the working
directory to the directory containing the first file found.
:param options: the options to be forwarded to the underlying Werkzeug
server. See :func:`werkzeug.serving.run_simple` for more
information.
.. versionchanged:: 1.0
If installed, python-dotenv will be used to load environment
variables from :file:`.env` and :file:`.flaskenv` files.
If set, the :envvar:`FLASK_ENV` and :envvar:`FLASK_DEBUG`
environment variables will override :attr:`env` and
:attr:`debug`.
Threaded mode is enabled by default.
.. versionchanged:: 0.10
The default port is now picked from the ``SERVER_NAME``
variable.
ZFLASK_RUN_FROM_CLItruer )explain_ignored_app_runNZ FLASK_ENVZ FLASK_DEBUGr_ :z 127.0.0.1r i Z use_reloaderZ use_debuggerthreadedTF)
run_simple)rz environget debughelpersr r$ r r r" envr! r r r partitionint
setdefaultZshow_server_bannerr Zwerkzeug.servingr tcaststrr ) r ru r r r r r server_nameZsn_hostZsn_port_r rK rK rL run% sD C
z Flask.run) use_cookieskwargsrD c K s2 | j }|dkrddlm} || | jfd|i|S )a Creates a test client for this application. For information
about unit testing head over to :doc:`/testing`.
Note that if you are testing for assertions or exceptions in your
application code, you must set ``app.testing = True`` in order for the
exceptions to propagate to the test client. Otherwise, the exception
will be handled by the application (not visible to the test client) and
the only indication of an AssertionError or other exception will be a
500 status code response to the test client. See the :attr:`testing`
attribute. For example::
app.testing = True
client = app.test_client()
The test client can be used in a ``with`` block to defer the closing down
of the context until the end of the ``with`` block. This is useful if
you want to access the context locals for testing::
with app.test_client() as c:
rv = c.get('/?vodka=42')
assert request.args['vodka'] == '42'
Additionally, you may pass optional keyword arguments that will then
be passed to the application's :attr:`test_client_class` constructor.
For example::
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 ....')
See :class:`~flask.testing.FlaskClient` for more information.
.. versionchanged:: 0.4
added support for ``with`` block usage for the client.
.. versionadded:: 0.7
The `use_cookies` parameter was added as well as the ability
to override the client to be used by setting the
:attr:`test_client_class` attribute.
.. versionchanged:: 0.11
Added `**kwargs` to support passing additional keyword arguments to
the constructor of :attr:`test_client_class`.
Nr )r> r )test_client_classr r> response_class)r r r clsrK rK rL test_client s
3 zFlask.test_client)r rD c K s& | j }|dkrddlm} || f|S )a- Create a CLI runner for testing CLI commands.
See :ref:`testing-cli`.
Returns an instance of :attr:`test_cli_runner_class`, by default
:class:`~flask.testing.FlaskCliRunner`. The Flask app object is
passed as the first argument.
.. versionadded:: 1.0
Nr )r? )test_cli_runner_classr r? )r r r rK rK rL test_cli_runner s
zFlask.test_cli_runnerr= ) blueprintr rD c K s |j | | dS )ax Register a :class:`~flask.Blueprint` on the application. Keyword
arguments passed to this method will override the defaults set on the
blueprint.
Calls the blueprint's :meth:`~flask.Blueprint.register` method after
recording the blueprint in the application's :attr:`blueprints`.
:param blueprint: The blueprint to register.
:param url_prefix: Blueprint routes will be prefixed with this.
:param subdomain: Blueprint routes will match on this subdomain.
:param url_defaults: Blueprint routes will use these default values for
view arguments.
:param options: Additional keyword arguments are passed to
:class:`~flask.blueprints.BlueprintSetupState`. They can be
accessed in :meth:`~flask.Blueprint.record` callbacks.
.. versionchanged:: 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``.
.. versionadded:: 0.7
N)register)r r r rK rK rL register_blueprint s zFlask.register_blueprintc C s
| j j S )zhIterates over all blueprints by the order they were registered.
.. versionadded:: 0.11
)r values)r rK rK rL iter_blueprints s zFlask.iter_blueprints)rulert rv provide_automatic_optionsr rD c K s |d krt |}||d< |jdd }|d kr% s z%Flask.add_url_rule..required_methodsr OPTIONSTFzDView function mapping is overwriting an existing endpoint function: )r )r) popr rG r TypeErrorsetaddurl_rule_classr r view_functionsr r ) r r rt rv r r r r Zold_funcrK rK rL r
s:
zFlask.add_url_rule)r rD c s t t d fdd }|S )a A decorator that is used to register custom template filter.
You can specify a name for the filter, otherwise the function
name will be used. Example::
@app.template_filter()
def reverse(s):
return s[::-1]
:param name: the optional name of the filter, otherwise the
function name will be used.
)frD c s j | d | S )N)r )add_template_filter)r )r r rK rL decoratorX s z(Flask.template_filter..decorator)r9 )r r r rK )r r rL template_filterH s zFlask.template_filter)r r rD c C s || j j|p|j< dS )zRegister a custom template filter. Works exactly like the
:meth:`template_filter` decorator.
:param name: the optional name of the filter, otherwise the
function name will be used.
N)r filters__name__)r r r rK rK rL r ^ s
zFlask.add_template_filterc s t t d fdd }|S )aS A decorator that is used to register custom template test.
You can specify a name for the test, otherwise the function
name will be used. Example::
@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
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the
function name will be used.
)r rD c s j | d | S )N)r )add_template_test)r )r r rK rL r s z&Flask.template_test..decorator)r; )r r r rK )r r rL
template_testj s zFlask.template_testc C s || j j|p|j< dS )zRegister a custom template test. Works exactly like the
:meth:`template_test` decorator.
.. versionadded:: 0.10
:param name: the optional name of the test, otherwise the
function name will be used.
N)r testsr )r r r rK rK rL r s zFlask.add_template_testc s t t d fdd }|S )a A decorator that is used to register a custom template global function.
You can specify a name for the global function, otherwise the function
name will be used. Example::
@app.template_global()
def double(n):
return 2 * n
.. versionadded:: 0.10
:param name: the optional name of the global function, otherwise the
function name will be used.
)r rD c s j | d | S )N)r )add_template_global)r )r r rK rL r s z(Flask.template_global..decorator)r: )r r r rK )r r rL template_global s zFlask.template_globalc C s || j j|p|j< dS )a Register a custom template global function. Works exactly like the
:meth:`template_global` decorator.
.. versionadded:: 0.10
:param name: the optional name of the global function, otherwise the
function name will be used.
N)r r r )r r r rK rK rL r s zFlask.add_template_global)r rD c C s | j j| |S )zRegisters a function to be run before the first request to this
instance of the application.
The function will be called without any arguments and its return
value is ignored.
.. versionadded:: 0.8
)r append)r r rK rK rL before_first_request s zFlask.before_first_requestc C s | j j| |S )a Registers a function to be called when the application context
ends. These functions are typically also called when the request
context is popped.
Example::
ctx = app.app_context()
ctx.push()
...
ctx.pop()
When ``ctx.pop()`` is executed in the above example, the teardown
functions are called just before the app context moves from the
stack of active contexts. This becomes relevant if you are using
such constructs in tests.
Since a request context typically also manages an application
context it would also be called when you pop a request context.
When a teardown function was called because of an unhandled exception
it will be passed an error object. If an :meth:`errorhandler` is
registered, it will handle the exception and the teardown will not
receive it.
The return values of teardown functions are ignored.
.. versionadded:: 0.9
)r r )r r rK rK rL teardown_appcontext s zFlask.teardown_appcontextc C s | j j| |S )zVRegisters a shell context processor function.
.. versionadded:: 0.11
)r r )r r rK rK rL shell_context_processor s z Flask.shell_context_processorz ErrorHandlerCallable[Exception])erD c
C s | j t|\}}tjd}xd|dk r.|dfndD ]L}xF|D ]>}| j| | }|sTq This method is called whenever an exception occurs that
should be handled. A special case is :class:`~werkzeug
.exceptions.HTTPException` which is forwarded to the
:meth:`handle_http_exception` method. This function will either
return a response value or reraise the exception with the same
traceback.
.. versionchanged:: 1.0
Key errors raised from request data like ``form`` show the
bad key in debug mode rather than a generic bad request
message.
.. versionadded:: 0.7
ra TN)
rG r r r Zshow_exceptionr
r r r r )r r r rK rK rL handle_user_exceptionS s
zFlask.handle_user_exceptionc C sp t j }tj| |d | jr.|d |kr* || j| t|d}| j|}|dk rb| j||}| j |ddS )a Handle an exception that did not have an error handler
associated with it, or that was raised from an error handler.
This always causes a 500 ``InternalServerError``.
Always sends the :data:`got_request_exception` signal.
If :attr:`propagate_exceptions` is ``True``, such as in debug
mode, the error will be re-raised so that the debugger can
display it. Otherwise, the original exception is logged, and
an :exc:`~werkzeug.exceptions.InternalServerError` is returned.
If an error handler is registered for ``InternalServerError`` or
``500``, it will be used. For consistency, the handler will
always receive the ``InternalServerError``. The original
unhandled exception is available as ``e.original_exception``.
.. versionchanged:: 1.1.0
Always passes the ``InternalServerError`` instance to the
handler, setting ``original_exception`` to the unhandled
error.
.. versionchanged:: 1.1.0
``after_request`` functions and other finalization is done
even for the default 500 response when there is no handler.
.. versionadded:: 0.3
) exceptionr )Zoriginal_exceptionNT)from_error_handler)
r exc_infor0 sendr
log_exceptionr r r finalize_request)r r r server_errorr rK rK rL handle_exceptions s
zFlask.handle_exception)r rD c C s& | j jdtj dtj d|d dS )a
Logs an exception. This is called by :meth:`handle_exception`
if debugging is disabled and right before the handler is called.
The default implementation logs the exception as error on the
:attr:`logger`.
.. versionadded:: 0.8
z
Exception on z [])r N)r errorr r{ method)r r rK rK rL r s
zFlask.log_exceptionz te.NoReturn)r rD c C s> | j s t|jt s |jdkr&|jddlm} ||dS )a. Exceptions that are recording during routing are reraised with
this method. During debug we are not reraising redirect requests
for non ``GET``, ``HEAD``, or ``OPTIONS`` requests and we're raising
a different error instead to help debug situations.
:internal:
r HEADr r )FormDataRoutingRedirectN)r r r )r rG routing_exceptionr r r r )r r r rK rK rL raise_routing_exception s
z Flask.raise_routing_exceptionc C sZ t jj}|jdk r | j| |j}t|ddr@|jdkr@| j S | j | j
|j f |j S )a Does the request dispatching. Matches the URL and returns the
return value of the view or error handler. This does not have to
be a response object. In order to convert the return value to a
proper response object, call :func:`make_response`.
.. versionchanged:: 0.7
This no longer does the exception handling, this code was
moved to the new :meth:`full_dispatch_request`.
Nr Fr )
r topr r! r" Zurl_ruler r make_default_options_responser r rt view_args)r reqr rK rK rL dispatch_request s
zFlask.dispatch_requestc C sf | j y&tj| | j }|dkr,| j }W n, tk
rZ } z| j|}W Y dd}~X nX | j|S )zDispatches the request and on top of that performs request
pre and postprocessing as well as HTTP exception catching and
error handling.
.. versionadded:: 0.7
N)*try_trigger_before_first_request_functionsr2 r preprocess_requestr' Exceptionr r )r r r rK rK rL full_dispatch_request s
zFlask.full_dispatch_request)r r rD c C sR | j |}y | j|}tj| |d W n& tk
rL |s< | jjd Y nX |S )a) Given the return value from a view function this finalizes
the request by converting it into a response and invoking the
postprocessing functions. This is invoked for both normal
request dispatching as well as error handlers.
Because this means that it might be called as a result of a
failure a special safe mode is available which can be enabled
with the `from_error_handler` flag. If enabled, failures in
response processing will be logged and otherwise ignored.
:internal:
)responsez?Request finalizing failed with an error while handling an error)
make_responseprocess_responser1 r r* r r )r r r r, rK rK rL r s
zFlask.finalize_requestc
C sL | j r
dS | j2 | j r dS x| jD ]}| j| q$W d| _ W dQ R X dS )zCalled before each request and will ensure that it triggers
the :attr:`before_first_request_funcs` and only exactly once per
application instance (which means process usually).
:internal:
NT)r r r r )r rC rK rK rL r( s z0Flask.try_trigger_before_first_request_functionsc C s( t jj}|j }| j }|jj| |S )zThis method is called to create the default ``OPTIONS`` response.
This can be changed through subclassing to change the default
behavior of ``OPTIONS`` responses.
.. versionadded:: 0.7
)r r# Z url_adapterZallowed_methodsr Zallowr )r adapterr r rK rK rL r$ s
z#Flask.make_default_options_response)r rD c C s dS )a
This is called to figure out if an error should be ignored
or not as far as the teardown system is concerned. If this
function returns ``True`` then the teardown handlers will not be
passed the error.
.. versionadded:: 0.10
FrK )r r rK rK rL should_ignore_error+ s zFlask.should_ignore_error)rC rD c C s t |r| j|S |S )a) 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.
.. versionadded:: 2.0
)rJ
async_to_sync)r rC rK rK rL r 5 s
zFlask.ensure_sync.c C sJ yddl m} W n tk
r. tddY nX tjdkrBtd||S )a1 Return a sync function that will run the coroutine function.
.. code-block:: python
result = app.async_to_sync(func)(*args, **kwargs)
Override this method to change how the app converts async code
to be synchronously callable.
.. versionadded:: 2.0
r )r1 zAInstall Flask with the 'async' extra in order to use async views.Nzwerkzeug.localzKAsync cannot be used with this combination of Python and Greenlet versions.)Z asgiref.syncr1 ImportError RuntimeErrorr
__module__)r rC Zasgiref_async_to_syncrK rK rL r1 C s
zFlask.async_to_sync)r rD c C s d }}t |trht|}|dkr.|\}}}n:|dkr`t |d ttttfrV|\}}qh|\}}ntd|dkrtdtjdt || j s^t |t
t t fr| j |||d}d }}nt |trt
|}nt |tst|rHy| j j|tj}W nN tk
rD } z0t| d t|j d
jtj d dW Y dd}~X nX ntd t|j d
tjt|}|dk rt |t
t t fr||_n||_|r|j j | |S ) a Convert the return value from a view function to an instance of
:attr:`response_class`.
:param rv: the return value from the view function. The view function
must return a response. Returning ``None``, or the view ending
without returning, is not allowed. The following types are allowed
for ``view_rv``:
``str``
A response object is created with the string encoded to UTF-8
as 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.
``tuple``
Either ``(body, status, headers)``, ``(body, status)``, or
``(body, headers)``, where ``body`` is any of the other types
allowed here, ``status`` is a string or an integer, and
``headers`` is a dictionary or a list of ``(key, value)``
tuples. If ``body`` is a :attr:`response_class` instance,
``status`` overwrites the exiting value and ``headers`` are
extended.
:attr:`response_class`
The object is returned unchanged.
other :class:`~werkzeug.wrappers.Response` class
The object is coerced to :attr:`response_class`.
:func:`callable`
The function is called as a WSGI application. The result is
used to create a response object.
.. versionchanged:: 0.9
Previously a tuple was interpreted as the arguments for the
response object.
NrA r zThe view function did not return a valid response tuple. The tuple must have the form (body, status, headers), (body, status), or (body, headers).zThe view function for zh did not return a valid response. The function either returned None or ended without a return statement.)statusheadersz
The view function did not return a valid response. The return type must be a string, dict, tuple, Response instance, or WSGI callable, but it was a .zThe view function did not return a valid response. The return type must be a string, dict, tuple, Response instance, or WSGI callable, but it was a ) rG tuplelenr r listr r rt r r bytes bytearrayr' BaseResponsecallableZ
force_typer r
r with_tracebackr r r r r r6 status_coder7 r )r r r6 r7 Zlen_rvr rK rK rL r- a sJ +
$
zFlask.make_responsec C sp |dk r:| j s | jjpd}nd}| jj|j| jd |dS | jd dk rl| jj| jd | jd | jd dS dS )a* Creates a URL adapter for the given request. The URL adapter
is created at a point where the request context is not yet set
up so the request is passed explicitly.
.. versionadded:: 0.6
.. versionchanged:: 0.9
This can now also be called without a request object when the
URL adapter is created for the application context.
.. versionchanged:: 1.0
:data:`SERVER_NAME` no longer implicitly enables subdomain
matching. Use :attr:`subdomain_matching` instead.
Nr_ )r subdomainr` rc ) script_nameZ
url_scheme)rl r Zdefault_subdomainZbind_to_environr r bind)r r rB rK rK rL create_url_adapter s zFlask.create_url_adapter)rt r rD c C sb d}d|kr(t |tt|jdd }x4|D ],}|| jkr.x | j| D ]}||| qHW q.W dS )zInjects the URL defaults for the given endpoint directly into
the values dictionary passed. This is used internally and
automatically called on URL building.
.. versionadded:: 0.7
Nr8 r )N)r r r
rpartitionZurl_default_functions)r rt r r r rC rK rK rL inject_url_defaults s
zFlask.inject_url_defaults)r rt r rD c C sn xR| j D ]H}y||||}W n& tk
rB } z
|}W Y dd}~X qX |dk r|S qW |tj d krf |dS )zQHandle :class:`~werkzeug.routing.BuildError` on
:meth:`url_for`.
Nr )r r
r r )r r rt r r r r rK rK rL handle_url_build_error s z Flask.handle_url_build_errorc C s dt tj}x8|D ]0}|| jkrx | j| D ]}|tjtj q.W qW xB|D ]:}|| jkrNx*| j| D ] }| j| }|dk rh|S qhW qNW dS )a Called before the request is dispatched. Calls
:attr:`url_value_preprocessors` registered with the app and the
current blueprint (if any). Then calls :attr:`before_request_funcs`
registered with the app and the blueprint.
If any :meth:`before_request` handler 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.
N)N)r r r Zurl_value_preprocessorsrt r% Zbefore_request_funcsr )r r r Zurl_funcZ before_funcr rK rK rL r) - s
zFlask.preprocess_request)r, rD c C s t j}x |jD ]}| j||}qW xDttjdD ]4}|| jkr2x$t| j| D ]}| j||}qPW q2W | j j
|j s| j j | |j | |S )a Can be overridden in order to modify the response object
before it's sent to the WSGI server. By default this will
call all the :meth:`after_request` decorated functions.
.. versionchanged:: 0.5
As of Flask 0.5 the functions registered for after request
execution are called in reverse order of registration.
:param response: a :attr:`response_class` object.
:return: a new response object or the same, has to be an
instance of :attr:`response_class`.
N)N)
r r# Z_after_request_functionsr r r r Zafter_request_funcsr session_interfaceZis_null_sessionr Z save_session)r r, ctxrC r rK rK rL r. H s
zFlask.process_response)excrD c C sl |t krtj d }xDttjdD ]4}|| jkr"x$t| j| D ]}| j|| q@W q"W t j
| |d dS )a2 Called after the request is dispatched and the response is
returned, right before the request context is popped.
This calls all functions decorated with
:meth:`teardown_request`, and :meth:`Blueprint.teardown_request`
if a blueprint handled the request. Finally, the
:data:`request_tearing_down` signal is sent.
This is called by
:meth:`RequestContext.pop() `,
which may be delayed during testing to maintain access to
resources.
:param exc: An unhandled exception raised while dispatching the
request. Detected from the current exception information if
not passed. Passed to each teardown function.
.. versionchanged:: 0.9
Added the ``exc`` argument.
r N)rK )N) r* r r r r r Zteardown_request_funcsr r r3 r )r rK r rC rK rK rL do_teardown_requestd s
zFlask.do_teardown_requestc C sH |t krtj d }x t| jD ]}| j|| q W tj| |d dS )a Called right before the application context is popped.
When handling a request, the application context is popped
after the request context. See :meth:`do_teardown_request`.
This calls all functions decorated with
:meth:`teardown_appcontext`. Then the
:data:`appcontext_tearing_down` signal is sent.
This is called by
:meth:`AppContext.pop() `.
.. versionadded:: 0.9
r )rK N)r* r r r r r r/ r )r rK rC rK rK rL do_teardown_appcontext s
z Flask.do_teardown_appcontextc C s t | S )aF Create an :class:`~flask.ctx.AppContext`. Use as a ``with``
block to push the context, which will make :data:`current_app`
point at this application.
An application context is automatically pushed by
:meth:`RequestContext.push() `
when handling a request, and when running a CLI command. Use
this to manually create a context outside of these situations.
::
with app.app_context():
init_db()
See :doc:`/appcontext`.
.. versionadded:: 0.9
)r )r rK rK rL app_context s zFlask.app_context)r rD c C s
t | |S )a$ Create a :class:`~flask.ctx.RequestContext` representing a
WSGI environment. Use a ``with`` block to push the context,
which will make :data:`request` point at this request.
See :doc:`/reqcontext`.
Typically you should not call this from your own code. A request
context is automatically pushed by the :meth:`wsgi_app` when
handling a request. Use :meth:`test_request_context` to create
an environment and context instead of this method.
:param environ: a WSGI environment
)r )r r rK rK rL request_context s zFlask.request_context)argsr rD c
O s: ddl m} || f||}z| j|j S |j X dS )a Create a :class:`~flask.ctx.RequestContext` for a WSGI
environment created from the given values. This is mostly useful
during testing, where you may want to run a function that uses
request data without dispatching a full request.
See :doc:`/reqcontext`.
Use a ``with`` block to push the context, which will make
:data:`request` point at the request for the created
environment. ::
with test_request_context(...):
generate_report()
When using the shell, it may be easier to push and pop the
context manually to avoid indentation. ::
ctx = app.test_request_context(...)
ctx.push()
...
ctx.pop()
Takes the same arguments as Werkzeug's
:class:`~werkzeug.test.EnvironBuilder`, with some defaults from
the application. See the linked Werkzeug docs for most of the
available arguments. Flask-specific behavior is listed here.
:param path: URL path being requested.
:param base_url: Base URL where the app is being served, which
``path`` is relative to. If not given, built from
:data:`PREFERRED_URL_SCHEME`, ``subdomain``,
:data:`SERVER_NAME`, and :data:`APPLICATION_ROOT`.
:param subdomain: Subdomain name to append to
:data:`SERVER_NAME`.
:param url_scheme: Scheme to use instead of
:data:`PREFERRED_URL_SCHEME`.
:param data: The request body, either as a string or a dict of
form keys and values.
:param json: If given, this is serialized as JSON and passed as
``data``. Also defaults ``content_type`` to
``application/json``.
:param args: other positional arguments passed to
:class:`~werkzeug.test.EnvironBuilder`.
:param kwargs: other keyword arguments passed to
:class:`~werkzeug.test.EnvironBuilder`.
r )EnvironBuilderN)r rQ rO Z get_environclose)r rP r rQ ZbuilderrK rK rL test_request_context s
/ zFlask.test_request_context)r start_responserD c C s | j |}d}zhy|j | j }W nH tk
rT } z|}| j|}W Y dd}~X n tj d } Y nX |||S | j|rd}|j| X dS )a The actual WSGI application. This is not implemented in
:meth:`__call__` so that middlewares can be applied without
losing 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 and
can continue to call methods on it.
.. versionchanged:: 0.7
Teardown events for the request and app contexts are called
even if an unhandled error occurs. Other events may not be
called depending on when an error occurs during dispatch.
See :ref:`callbacks-and-errors`.
:param environ: A WSGI environment.
:param start_response: A callable accepting a status code,
a list of headers, and an optional exception context to
start the response.
Nr ) rO pushr+ r* r r r r0 Zauto_pop)r r rT rJ r r, r rK rK rL wsgi_app s
zFlask.wsgi_appc C s | j ||S )zThe WSGI server calls the Flask application object as the
WSGI application. This calls :meth:`wsgi_app`, which can be
wrapped to apply middleware.
)rV )r r rT rK rK rL __call__& s zFlask.__call__) Nre NFFrf NFN)F)r )NNNT)T)NNN)N)N)N)N)N)N)NNN)F)r r4 __qualname____doc__r< Z
request_classr r r5 r r Zapp_ctx_globals_classr r r r Z
secret_keyZsession_cookie_namerO Zpermanent_session_lifetimeZsend_file_max_age_defaultZuse_x_sendfiler JSONEncoderZ json_encoder JSONDecoderZ json_decoderr r r r r r r r r r r OptionalTyper r. rI r Unionrz PathLiker rx r r% r propertyr r loggingLoggerr r r r~ ry ZIOZAnyStrr r setterr r4 r r r r r r r Anyr r r r- r
ValuesViewr Callabler r9 r r r; r r r: r r r6 r r8 r r r* r r
r7 r r r r ZTupler
BaseExceptionr r r" r' r+ r r( r$ r0 r Coroutiner1 r- r rE rG rH r) r. r* rL rM r rN r rO rS rV rW
__classcell__rK rK )r rL rP b sX
_
V
#
s: 3
!$ 3
w( 8+rP )rA rB )frH rE ra rz r Ztypingr r datetimer itertoolsr threadingr typesr Zwerkzeug.datastructuresr r Zwerkzeug.exceptionsr r r
r Zwerkzeug.localr Zwerkzeug.routingr
r r r r r Zwerkzeug.wrappersr r> r r r r r rJ r r r r r r r r helpersr r! r" r# r$ r% r& r' r( Zscaffoldr) r* r+ r, r- sessionsr. Zsignalsr/ r0 r1 r2 r3 Z
templatingr4 r5 r6 r7 r8 r9 r: r; Zwrappersr< Z
TYPE_CHECKINGZtyping_extensionster r= r r> r? r@ version_inforJ rd r r\ rO rP rK rK rK rL s