File: //usr/lib/python2.7/site-packages/flask/app.pyc
�
n�Dac @ s� d Z d d l Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z d d l
m Z d d l m
Z
d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l! m" Z" d d l! m# Z# d d l! m$ Z$ d d l! m% Z% d d l& m' Z' d d l& m( Z( d d l) m* Z* d d l) m+ Z+ d d l) m, Z, d d! l- m. Z. d d" l- m/ Z/ d d# l- m0 Z0 d d$ l- m1 Z1 d d% l2 m3 Z3 d d& l2 m4 Z4 d d' l2 m5 Z5 d d( l2 m6 Z6 d d) l2 m7 Z7 d d* l2 m8 Z8 d d+ l2 m9 Z9 d d, l2 m: Z: d d- l2 m; Z; d d. l m< Z< d d/ l= m> Z> d d0 l? m@ Z@ d d1 lA mB ZB d d2 lA mC ZC d d3 lA mD ZD d d4 lA mE ZE d d5 lA mF ZF d d6 lG mH ZH d d7 lG mI ZI d d8 lG mJ ZJ d d9 lK mL ZL d d: lK mM ZM eN � ZO d; � ZP d< � ZQ d= e4 f d> � � YZR d S(? s�
flask.app
~~~~~~~~~
This module implements the central WSGI application object.
:copyright: 2010 Pallets
:license: BSD-3-Clause
i����N( t timedelta( t update_wrapper( t chain( t Lock( t Headers( t
ImmutableDict( t
BadRequest( t BadRequestKeyError( t default_exceptions( t
HTTPException( t InternalServerError( t MethodNotAllowed( t
BuildError( t Map( t RequestRedirect( t RoutingException( t Rule( t BaseResponsei ( t cli( t json( t
integer_types( t reraise( t string_types( t text_type( t Config( t ConfigAttribute( t _AppCtxGlobals( t
AppContext( t RequestContext( t _request_ctx_stack( t g( t request( t session( t _endpoint_from_view_func( t _PackageBoundObject( t find_package( t get_debug_flag( t get_env( t get_flashed_messages( t get_load_dotenv( t locked_cached_property( t url_for( t jsonify( t
create_logger( t SecureCookieSessionInterface( t appcontext_tearing_down( t got_request_exception( t request_finished( t request_started( t request_tearing_down( t _default_template_ctx_processor( t DispatchingJinjaLoader( t Environment( t Request( t Responsec C s t | t � s t d | � S| S( Nt seconds( t
isinstanceR ( t value( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt _make_timedeltaL s
c s � f d � } t | � � S( sk Wraps a method so that it performs a check in debug mode if the
first request was already handled.
c s1 | j r! | j r! t d � � n � | | | � S( Nsm A setup function was called after the first request was handled. This usually indicates a bug in the application where a module was not imported and decorators or other functionality was called too late.
To fix this make sure to import all your view modules, database models and everything related at a central place before the application starts serving requests.( t debugt _got_first_requestt AssertionError( t selft argst kwargs( t f( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt wrapper_funcW s ( R ( RA RB ( ( RA s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt setupmethodR s
t Flaskc
B s� e Z d Z e Z e Z e Z e Z
e Z e
d � Z e
d � Z e
d � Z e
d d e �Z e
d d e �Z e
d � Z e j Z e j Z i d d g d
6Z e i dz d 6dz d 6e d 6dz d
6dz d 6dz d 6e d d � d 6e d 6dz d 6d d 6d d 6dz d 6dz d 6e d 6e d 6dz d 6e d 6dz d 6e d d � d 6dz d 6e d 6e d 6d! d" 6e d# 6e d$ 6e d% 6d& d' 6dz d( 6d) d* 6� Z e! Z" e# Z$ dz Z% dz Z& e' � Z( dz Z) dz Z* dz Z+ dz d+ dz e e d, dz e dz d- � Z, e- d. � � Z. e/ d/ � � Z0 e/ d0 � � Z1 e- d1 � � Z2 e- d2 � � Z3 e/ d3 � � Z4 e d4 � Z5 d5 � Z6 d6 d7 � Z7 e/ d8 � � Z8 e8 j9 d9 � � Z8 d: � Z: d; � Z; d< � Z< d= � Z= d> � Z> e
d � Z? e/ d? � � Z@ e@ j9 d@ � � Z@ dz dz dz e dA � ZA e dB � ZB dC � ZC dD � ZD dE � ZE dF � ZF eG dG � � ZH dH � ZI eG dz dz dz dI � � ZJ dJ � ZK eG dK � � ZL eM dL � � ZN eG dM � � ZO eG dN � � ZP eG dO � � ZQ eG dz dP � � ZR eG dz dQ � � ZS eG dz dR � � ZT eG dz dS � � ZU eG dz dT � � ZV eG dz dU � � ZW eG dV � � ZX eG dW � � ZY eG dX � � ZZ eG dY � � Z[ eG dZ � � Z\ eG d[ � � Z] eG d\ � � Z^ eG d] � � Z_ eG d^ � � Z` d_ � Za d` � Zb da � Zc db � Zd dc � Ze dd � Zf de � Zg df � Zh dg � Zi e dh � Zj di � Zk dj � Zl dk � Zm dl � Zn dm � Zo dn � Zp do � Zq dp � Zr dq � Zs et dr � Zu et ds � Zv dt � Zw du � Zx dv � Zy dw � Zz dx � Z{ dy � Z| RS({ sg 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: Flask by default will automatically calculate the path
to the root of the application. In certain situations
this cannot be achieved (for instance if the package
is a Python 3 namespace package) and needs to be
manually defined.
t TESTINGt
SECRET_KEYt SESSION_COOKIE_NAMEt PERMANENT_SESSION_LIFETIMEt
get_convertert SEND_FILE_MAX_AGE_DEFAULTt USE_X_SENDFILEs jinja2.ext.autoescapes jinja2.ext.with_t
extensionst ENVt DEBUGt PROPAGATE_EXCEPTIONSt PRESERVE_CONTEXT_ON_EXCEPTIONt daysi t SERVER_NAMEt /t APPLICATION_ROOTR t SESSION_COOKIE_DOMAINt SESSION_COOKIE_PATHt SESSION_COOKIE_HTTPONLYt SESSION_COOKIE_SECUREt SESSION_COOKIE_SAMESITEt SESSION_REFRESH_EACH_REQUESTt MAX_CONTENT_LENGTHt hoursi t TRAP_BAD_REQUEST_ERRORSt TRAP_HTTP_EXCEPTIONSt EXPLAIN_TEMPLATE_LOADINGt httpt PREFERRED_URL_SCHEMEt
JSON_AS_ASCIIt JSON_SORT_KEYSt JSONIFY_PRETTYPRINT_REGULARs application/jsont JSONIFY_MIMETYPEt TEMPLATES_AUTO_RELOADi� t MAX_COOKIE_SIZEt statict templatesc C s� t j | | d | d |
�| | _ | | _ | d k rI | j � } n! t j j | � sj t d � � n | | _
| j | � | _ i | _
i | _ g | _ i | _ g | _ i | _ i | _ g | _ i | _ i | _ i t g d 6| _ g | _ i | _ g | _ i | _ | j � | _ | | j _ | | _ t! | _" t# � | _$ | j% r�t& | � | k svt' d � � | j( | j d d d d | d | j) �n | j* | j+ _* d S(
Nt template_foldert root_pathsW If an instance path is provided it must be absolute. A relative path was given instead.s- Invalid static_host/host_matching combinations /<path:filename>t endpointRh t hostt view_func(, R" t __init__t static_url_patht
static_foldert Nonet auto_find_instance_patht ost patht isabst
ValueErrort
instance_patht make_configt configt view_functionst error_handler_spect url_build_error_handlerst before_request_funcst before_first_request_funcst after_request_funcst teardown_request_funcst teardown_appcontext_funcst url_value_preprocessorst url_default_functionsR2 t template_context_processorst shell_context_processorst
blueprintst _blueprint_orderRL t
url_map_classt url_mapt
host_matchingt subdomain_matchingt FalseR< R t _before_request_lockt has_static_foldert boolR= t add_url_rulet send_static_filet nameR ( R> t import_nameRp Rq t static_hostR� R� Rj Rx t instance_relative_configRk ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRo � sP
c C s_ | j d k rX t t j d d d � } | d k r8 d St j j t j j | � � d S| j S( s_ 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
t __main__t __file__i N( R� t getattrt syst modulesRr Rt Ru t splitextt basename( R> t fn( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� d s
c C s- | j d } | d k r | S| j p, | j S( s� Returns the value of the ``PROPAGATE_EXCEPTIONS`` configuration
value in case it's set, otherwise a sensible default is returned.
.. versionadded:: 0.7
RO N( Rz Rr t testingR; ( R> t rv( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt propagate_exceptionsu s
c C s$ | j d } | d k r | S| j S( s� Returns the value of the ``PRESERVE_CONTEXT_ON_EXCEPTION``
configuration value in case it's set, otherwise a sensible default
is returned.
.. versionadded:: 0.7
RP N( Rz Rr R; ( R> R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt preserve_context_on_exception� s
c C s
t | � S( s� 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> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt logger� s c C s
| j � S( s� The 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.
( t create_jinja_environment( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt jinja_env� s c C s | j S( s� This attribute is set to ``True`` if the application started
handling the first request.
.. versionadded:: 0.8
( R< ( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt got_first_request� s c C sT | j } | r | j } n t | j � } t � | d <t � | d <| j | | � S( sd 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
RM RN ( Rk Rx t dictt default_configR% R$ t config_class( R> t instance_relativeRk t defaults( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRy � s
c C sQ t | j � \ } } | d k r4 t j j | d � St j j | d | j d � S( s 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
t instancet vars -instanceN( R# R� Rr Rt Ru t joinR� ( R> t prefixt package_path( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRs � s t rbc C s t t j j | j | � | � S( s� 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'.
( t openRt Ru R� Rx ( R> t resourcet mode( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt open_instance_resource� s
c C s$ | j d } | d k r | S| j S( sm 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.
Rf N( Rz Rr R; ( R> R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt templates_auto_reload� s
c C s | | j d <d S( NRf ( Rz ( R> R9 ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� � s c
C s� t | j � } d | k r+ | j | d <n d | k rG | j | d <n | j | | � } | j j d t d t d | j d t
d t d t � t
j | j d <| S(
s� 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
t
autoescapet auto_reloadR) R& Rz R R R t tojson( R� t
jinja_optionst select_jinja_autoescapeR� t jinja_environmentt globalst updateR) R& Rz R R R R t
tojson_filtert filters( R> t optionsR� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� � s c C s
t | � S( s� 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
( R3 ( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt create_global_jinja_loader s c C s | d k r t S| j d � S( s� Returns ``True`` if autoescaping should be active for the given
template name. If no template name is given, returns `True`.
.. versionadded:: 0.5
s .htmls .htms .xmls .xhtmlN( s .htmls .htms .xmls .xhtml( Rr t Truet endswith( R> t filename( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� ) s c C s� | j d } t j } | d k re | j j } | d k re | | j k re t | | j | � } qe n | j � } x | D] } | j | � � qx W| j | � d S( s 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( R� Rr R t topR t blueprintR t copyR� ( R> t contextt funcst reqctxt bpt orig_ctxt func( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt update_template_context3 s
c C s< i | d 6t d 6} x! | j D] } | j | � � q W| S( s� Returns the shell context for an interactive shell for this
application. This runs all the registered shell context
processors.
.. versionadded:: 0.11
t appR ( R R� R� ( R> R� t processor( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt make_shell_contextL s c C s | j d S( sv 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.
RN ( Rz ( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR; c s c C s | | j d <| j | j _ d S( NRN ( Rz R� R� R� ( R> R9 ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR; t s
c K s� t j j d � d k r3 d d l m } | � d St | � r� t j � d t j k rs t � | _ t
� | _ q� d t j k r� t
� | _ q� n | d k r� t
| � | _ n d } d } | j j d
� } d \ }
} | r� | j d � \ }
} } n | p |
p | } t t d � | | f D� | � � } | j d
| j � | j d | j � | j d t � t j | j | j | j t � d d l m }
z |
| | | | � Wd t | _ Xd S( s 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 :ref:`deployment` 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.
t FLASK_RUN_FROM_CLIt truei ( t explain_ignored_app_runNt FLASK_ENVt FLASK_DEBUGs 127.0.0.1i� RR t :c s s! | ] } | d k r | Vq d S( N( Rr ( t .0t p( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pys <genexpr>� s t use_reloadert use_debuggert threadedi����( t
run_simple( NN( Rt t environt gett debughelpersR� R' R t load_dotenvR% t envR$ R; Rr R� Rz t partitiont intt nextt
setdefaultR� t show_server_bannerR� R� t werkzeug.servingR� R< ( R> Rm t portR; R� R� R� t _hostt _portt server_namet sn_hostt sn_portt _R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt runy s: <
% c K sA | j } | d k r( d d l m } n | | | j d | | �S( s� Creates a test client for this application. For information
about unit testing head over to :ref:`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`.
i ( t FlaskClientt use_cookiesN( t test_client_classRr R� R� t response_class( R> R� R@ t cls( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt test_client� s 3 c K s5 | j } | d k r( d d l m } n | | | � S( s- 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
i ( t FlaskCliRunnerN( t test_cli_runner_classRr R� R� ( R> R@ R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt test_cli_runner s
c C s& t j t d � � | j j | | � S( s� Creates or opens a new session. Default implementation stores all
session data in a signed cookie. This requires that the
:attr:`secret_key` is set. Instead of overriding this method
we recommend replacing the :class:`session_interface`.
.. deprecated: 1.0
Will be removed in 2.0. Use
``session_interface.open_session`` instead.
:param request: an instance of :attr:`request_class`.
sf "open_session" is deprecated and will be removed in 2.0. Use "session_interface.open_session" instead.( t warningst warnt DeprecationWarningt session_interfacet open_session( R> R ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� . s
c C s) t j t d � � | j j | | | � S( s2 Saves the session if it needs updates. For the default
implementation, check :meth:`open_session`. Instead of overriding this
method we recommend replacing the :class:`session_interface`.
.. deprecated: 1.0
Will be removed in 2.0. Use
``session_interface.save_session`` instead.
:param session: the session to be saved (a
:class:`~werkzeug.contrib.securecookie.SecureCookie`
object)
:param response: an instance of :attr:`response_class`
sf "save_session" is deprecated and will be removed in 2.0. Use "session_interface.save_session" instead.( R� R� R� R� t save_session( R> R t response( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR C s
c C s# t j t d � � | j j | � S( s7 Creates a new instance of a missing session. Instead of overriding
this method we recommend replacing the :class:`session_interface`.
.. deprecated: 1.0
Will be removed in 2.0. Use
``session_interface.make_null_session`` instead.
.. versionadded:: 0.7
sp "make_null_session" is deprecated and will be removed in 2.0. Use "session_interface.make_null_session" instead.( R� R� R� R� t make_null_session( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR Z s
c K s� t } | j | j k rW | j | j | k s} t d | | j | j | j f � � n& | | j | j <| j j | � t } | j | | | � d S( sa 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.
.. versionadded:: 0.7
s� A name collision occurred between blueprints %r and %r. Both share the same name "%s". Blueprints that are created on the fly need unique names.N( R� R� R� R= R� t appendR� t register( R> R� R� t first_registration( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt register_blueprintn s #c C s
t | j � S( sh Iterates over all blueprints by the order they were registered.
.. versionadded:: 0.11
( t iterR� ( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt iter_blueprints� s c K s� | d
k r t | � } n | | d <| j d d
� } | d
k r^ t | d d
� pX d } n t | t � r| t d � � n t d � | D� � } t t | d d � � } | d
k r� t | d d
� } n | d
k rd | k r� t } | j d � qt
} n | | O} | j | d | | �} | | _ | j
j | � | d
k r�| j j | � } | d
k r�| | k r�t d | � � n | | j | <n d
S(
s� Connects a URL rule. Works exactly like the :meth:`route`
decorator. If a view_func is provided it will be registered with the
endpoint.
Basically this example::
@app.route('/')
def index():
pass
Is equivalent to the following::
def index():
pass
app.add_url_rule('/', 'index', index)
If the view_func is not provided you will need to connect the endpoint
to a view function like so::
app.view_functions['index'] = index
Internally :meth:`route` invokes :meth:`add_url_rule` so if you want
to customize the behavior via subclassing you only need to change
this method.
For more information refer to :ref:`url-route-registrations`.
.. versionchanged:: 0.2
`view_func` parameter added.
.. versionchanged:: 0.6
``OPTIONS`` is added automatically as method.
:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule. Flask
itself assumes the name of the view function as
endpoint
:param view_func: the function to call when serving a request to the
provided endpoint
:param provide_automatic_options: controls whether the ``OPTIONS``
method should be added automatically. This can also be controlled
by setting the ``view_func.provide_automatic_options = False``
before adding the rule.
:param options: the options to be forwarded to the underlying
:class:`~werkzeug.routing.Rule` object. A change
to Werkzeug is handling of method options. methods
is a list of methods this rule should be limited
to (``GET``, ``POST`` etc.). By default a rule
just listens for ``GET`` (and implicitly ``HEAD``).
Starting with Flask 0.6, ``OPTIONS`` is implicitly
added and handled by the standard request handling.
Rl t methodst GETs_ Allowed methods have to be iterables of strings, for example: @app.route(..., methods=["POST"])c s s | ] } | j � Vq d S( N( t upper( R� t item( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pys <genexpr>� s t required_methodst provide_automatic_optionst OPTIONSsF View function mapping is overwriting an existing endpoint function: %sN( R
( ( Rr R! t popR� R8 R t TypeErrort setR� t addR� t url_rule_classR R� R{ R� R= ( R> t ruleRl Rn R R� R R
t old_func( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR� � s< =
c s � � � f d � } | S( s� A decorator that is used to register a view function for a
given URL rule. This does the same thing as :meth:`add_url_rule`
but is intended for decorator usage::
@app.route('/')
def index():
return 'Hello World'
For more information refer to :ref:`url-route-registrations`.
:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule. Flask
itself assumes the name of the view function as
endpoint
:param options: the options to be forwarded to the underlying
:class:`~werkzeug.routing.Rule` object. A change
to Werkzeug is handling of method options. methods
is a list of methods this rule should be limited
to (``GET``, ``POST`` etc.). By default a rule
just listens for ``GET`` (and implicitly ``HEAD``).
Starting with Flask 0.6, ``OPTIONS`` is implicitly
added and handled by the standard request handling.
c s, � j d d � } � j � | | � � | S( NRl ( R Rr R� ( RA Rl ( R� R R> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt decorator! s ( ( R> R R� R ( ( R� R R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt route s c s � � f d � } | S( s� A decorator to register a function as an endpoint.
Example::
@app.endpoint('example.endpoint')
def example():
return "example"
:param endpoint: the name of the endpoint
c s | � j � <| S( N( R{ ( RA ( Rl R> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR 4 s
( ( R> Rl R ( ( Rl R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRl ( s c C sa t | t � r t | } n | } t | t � s7 t � t | t � rS | | j f S| d f Sd S( s Get the exception class being handled. For HTTP status codes
or ``HTTPException`` subclasses, return both the exception and
status code.
:param exc_class_or_code: Any exception class, or an HTTP status
code as an integer.
N( R8 R R t
issubclasst ExceptionR= R t codeRr ( t exc_class_or_codet exc_class( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt _get_exc_class_and_code: s
c s � � f d � } | S( s7 Register a function to handle errors by code or exception class.
A decorator that is used to register a function given an
error code. Example::
@app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
You can also register handlers for arbitrary exceptions::
@app.errorhandler(DatabaseError)
def special_exception_handler(error):
return 'Database connection failed', 500
.. versionadded:: 0.7
Use :meth:`register_error_handler` instead of modifying
:attr:`error_handler_spec` directly, for application wide error
handlers.
.. versionadded:: 0.7
One can now additionally also register custom exception types
that do not necessarily have to be a subclass of the
:class:`~werkzeug.exceptions.HTTPException` class.
:param code_or_exception: the code as integer for the handler, or
an arbitrary exception
c s � j d � | � | S( N( t _register_error_handlerRr ( RA ( t code_or_exceptionR> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR n s ( ( R> R R ( ( R R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt errorhandlerO s c C s | j d | | � d S( s� Alternative error attach function to the :meth:`errorhandler`
decorator that is more straightforward to use for non decorator
usage.
.. versionadded:: 0.7
N( R Rr ( R> R RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt register_error_handlert s c C s� t | t � r' t d j | � � � n y | j | � \ } } Wn& t k
rh t d j | � � � n X| j j | i � j | i � } | | | <d S( sq
:type key: None|str
:type code_or_exception: int|T<=Exception
:type f: callable
s� Tried to register a handler for an exception instance {0!r}. Handlers can only be registered for exception classes or HTTP error codes.sb '{0}' is not a recognized HTTP error code. Use a subclass of HTTPException with that code instead.N( R8 R Rw t formatR t KeyErrorR| R� ( R> t keyR RA R R t handlers( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR ~ s
!c s � � f d � } | S( s 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.
c s � j | d � �| S( NR� ( t add_template_filter( RA ( R� R> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR � s ( ( R> R� R ( ( R� R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt template_filter� s c C s | | j j | p | j <d S( s� Register 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� R� t __name__( R> RA R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR' � s c s � � f d � } | S( sS 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.
c s � j | d � �| S( NR� ( t add_template_test( RA ( R� R> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR � s ( ( R> R� R ( ( R� R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt
template_test� s c C s | | j j | p | j <d S( s� Register 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� t testsR) ( R> RA R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR* � s
c s � � f d � } | S( s� 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.
c s � j | d � �| S( NR� ( t add_template_global( RA ( R� R> ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR � s ( ( R> R� R ( ( R� R> s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt template_global� s c C s | | j j | p | j <d S( s 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> RA R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR- � s
c C s | j j d g � j | � | S( s� Registers a function to run before each request.
For example, this can be used to open a database connection, or to load
the logged in user from the session.
The function will be called without any arguments. If it returns a
non-None value, the value is handled as if it was the return value from
the view, and further request handling is stopped.
N( R~ R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt before_request� s c C s | j j | � | S( s� Registers 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 R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt before_first_request s
c C s | j j d g � j | � | S( su Register a function to be run after each request.
Your function must take one parameter, an instance of
:attr:`response_class` and return a new response object or the
same (see :meth:`process_response`).
As of Flask 0.7 this function might not be executed at the end of the
request in case an unhandled exception occurred.
N( R� R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt
after_request s c C s | j j d g � j | � | S( s� Register a function to be run at the end of each request,
regardless of whether there was an exception or not. These functions
are executed when the request context is popped, even if not an
actual request was performed.
Example::
ctx = app.test_request_context()
ctx.push()
...
ctx.pop()
When ``ctx.pop()`` is executed in the above example, the teardown
functions are called just before the request context moves from the
stack of active contexts. This becomes relevant if you are using
such constructs in tests.
Generally teardown functions must take every necessary step to avoid
that they will fail. If they do execute code that might fail they
will have to surround the execution of these code by try/except
statements and log occurring errors.
When a teardown function was called because of an exception it will
be passed an error object.
The return values of teardown functions are ignored.
.. admonition:: Debug Note
In debug mode Flask will not tear down a request on an exception
immediately. Instead it will keep it alive so that the interactive
debugger can still access it. This behavior can be controlled
by the ``PRESERVE_CONTEXT_ON_EXCEPTION`` configuration variable.
N( R� R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt teardown_request' s $ c C s | j j | � | S( s 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> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt teardown_appcontextN s c C s | j d j | � | S( s0 Registers a template context processor function.N( R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt context_processoro s c C s | j j | � | S( sV Registers a shell context processor function.
.. versionadded:: 0.11
( R� R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt shell_context_processoru s c C s | j j d g � j | � | S( s# Register a URL value preprocessor function for all view
functions in the application. These functions will be called before the
:meth:`before_request` functions.
The function can modify the values captured from the matched url before
they are passed to the view. For example, this can be used to pop a
common language code value and place it in ``g`` rather than pass it to
every view.
The function is passed the endpoint name and values dict. The return
value is ignored.
N( R� R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt url_value_preprocessor~ s c C s | j j d g � j | � | S( s� Callback function for URL defaults for all view functions of the
application. It's called with the endpoint and values and should
update the values passed in place.
N( R� R� Rr R ( R> RA ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt url_defaults� s c C s� | j t | � � \ } } x� t j | f d | f t j d f d f D]i \ } } | j j | i � j | � } | s| qF n x0 | j D]% } | j | � } | d k r� | Sq� WqF Wd S( s( Return a registered error handler for an exception in this order:
blueprint handler for a specific code, app handler for a specific code,
blueprint handler for an exception class, app handler for an exception
class, or ``None`` if a suitable handler is not found.
N( NN( R t typeR R� Rr R| R� R� t __mro__( R> t eR R R� t ct handler_mapR� t handler( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt _find_error_handler� s c C sO | j d k r | St | t � r& | S| j | � } | d k rE | S| | � S( sc Handles an HTTP exception. By default this will invoke the
registered error handlers and fall back to returning the
exception as response.
.. versionchanged:: 1.0.3
``RoutingException``, used internally for actions such as
slash redirects during routing, is not passed to error
handlers.
.. versionchanged:: 1.0
Exceptions are looked up by code *and* by MRO, so
``HTTPExcpetion`` subclasses can be handled with a catch-all
handler for the base ``HTTPException``.
.. versionadded:: 0.3
N( R Rr R8 R R> ( R> R: R= ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt handle_http_exception� s c C s] | j d r t S| j d } | d k rF | j rF t | t � rF t S| rY t | t � St S( s� Checks if an HTTP exception should be trapped or not. By default
this will return ``False`` for all exceptions except for a bad request
key error if ``TRAP_BAD_REQUEST_ERRORS`` is set to ``True``. It
also returns ``True`` if ``TRAP_HTTP_EXCEPTIONS`` is set to ``True``.
This is called for all HTTP exceptions raised by a view function.
If it returns ``True`` for any exception the error handler for this
exception is not called and it shows up as regular exception in the
traceback. This is helpful for debugging implicitly raised HTTP
exceptions.
.. versionchanged:: 1.0
Bad request errors are not trapped by default in debug mode.
.. versionadded:: 0.8
R^ R] N( Rz R� Rr R; R8 R R R� ( R> R: t trap_bad_request( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt trap_http_exception� s
c C s t j � \ } } } | | k s' t � t | t � r� | j sL | j d r� t | _ | j d | j
� k r� d j | j � | _ q� q� t
t d � s� d | _ q� n t | t � r� | j | � r� | j | � S| j | � } | d k rt | | | � n | | � S( s> 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
R] i s KeyError: '{}'t show_exception( N( R� t exc_infoR= R8 R R; Rz R� RB R? t get_descriptionR# t descriptiont hasattrR RA R? R> Rr R ( R> R: t exc_typet exc_valuet tbR= ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt handle_user_exception� s
c C s� t j � \ } } } t j | d | �| j rY | | k rP t | | | � qY | � n | j | | | f � t � } | | _ | j | � } | d k r� | | � } n | j | d t �S( s� 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``.
.. note::
Prior to Werkzeug 1.0.0, ``InternalServerError`` will not
always have an ``original_exception`` attribute. Use
``getattr(e, "original_exception", None)`` to simulate the
behavior for compatibility.
.. 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
t exceptiont from_error_handlerN(
R� RC R. t sendR� R t
log_exceptionR
t original_exceptionR> Rr t finalize_requestR� ( R> R: RG RH RI t server_errorR= ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt handle_exception s " c C s* | j j d t j t j f d | �d S( s
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
s Exception on %s [%s]RC N( R� t errorR Ru t method( R> RC ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRN [ s c C sX | j s, t | j t � s, | j d k r8 | j � n d d l m } | | � � d S( s. 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
t HEADR i ( t FormDataRoutingRedirectN( R
RU R ( R; R8 t routing_exceptionR RT R� RV ( R> R RV ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt raise_routing_exceptiong s
c C sv t j j } | j d k r+ | j | � n | j } t | d t � r_ | j d k r_ | j
� S| j | j | j
� S( s� 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`.
R R N( R R� R RW Rr RX t url_ruleR� R� RT t make_default_options_responseR{ Rl t view_args( R> t reqR ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt dispatch_requestz s
c C st | j � y8 t j | � | j � } | d k rA | j � } n Wn" t k
rf } | j | � } n X| j | � S( s� Dispatches 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( t* try_trigger_before_first_request_functionsR0 RM t preprocess_requestRr R] R RJ RP ( R> R� R: ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt full_dispatch_request� s
c C si | j | � } y& | j | � } t j | d | �Wn- t k
rd | sQ � n | j j d � n X| S( s) 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:
R s? Request finalizing failed with an error while handling an error( t
make_responset process_responseR/ RM R R� RK ( R> R� RL R ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRP � s
c C sR | j r
d S| j �6 | j r$ d Sx | j D]
} | � q. Wt | _ Wd QXd S( s� Called 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:
N( R< R� R R� ( R> R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR^ � s
c C s� t j j } t | d � r* | j � } nI g } y | j d d � Wn, t k
rb } | j } n t k
rr n X| j � } | j
j | � | S( s� This 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
t allowed_methodsRT s --( R R� t url_adapterRF Rc t matchR t
valid_methodsR R� t allowR� ( R> t adapterR R: R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRZ � s
c C s t S( s
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
( R� ( R> RS ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt should_ignore_error� s c C s" d } } t | t � r� t | � } | d k rC | \ } } } q� | d k r� t | d t t t t f � r} | \ } } q� | \ } } q� t d � � n | d k r� t d � � n t | | j � s�t | t t
t f � r| j | d | d | �} d } } q�t | t � r&t | � } q�t | t
� sAt | � r�y | j j | t j � } Wq�t k
r�} t d j d | d
| � � } t t | t j � d � q�Xq�t d j d
| � � � n | d k rt | t t
t f � r�| | _ q| | _ n | r | j j | � n | S(
s� 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`` (``unicode`` in Python 2)
A response object is created with the string encoded to UTF-8
as the body.
``bytes`` (``str`` in Python 2)
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.
i i i s� The view function did not return a valid response tuple. The tuple must have the form (body, status, headers), (body, status), or (body, headers).sy The view function did not return a valid response. The function either returned None or ended without a return statement.t statust headerss� {e}
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 {rv.__class__.__name__}.R: R� s� 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 {rv.__class__.__name__}.N( Rr R8 t tuplet lenR R� t listR R� R t bytest bytearrayR* R t callablet
force_typeR R� R# R R� RC Rj t status_codeRk t extend( R> R� Rj Rk t len_rvR: t new_error( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRa � sL +
! c C s� | d k rS | j s' | j j p* d n d } | j j | j d | j d d | �S| j d d k r� | j j | j d d | j d d | j d �Sd S( s* 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.
R� RR t subdomaint script_nameRT t
url_schemeRa N( Rr R� R� t default_subdomaint bind_to_environR� Rz t bind( R> R Rw ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt create_url_adapterc s
c C sz | j j d d � } d | k rX | j d d � d } t | | j j | d � � } n x | D] } | | | � q_ Wd S( s� Injects 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
t .i i N( ( ( R� R� Rr t rsplitR ( R> Rl t valuesR� R� R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt inject_url_defaults� s !
c
C s� t j � \ } } } xS | j D]H } y& | | | | � } | d k rJ | SWq t k
rf } | } q Xq W| | k r� t | | | � n | � d S( sI Handle :class:`~werkzeug.routing.BuildError` on :meth:`url_for`.
N( R� RC R} Rr R R (
R> RS Rl R� RG RH RI R= R� R: ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt handle_url_build_error� s c C s� t j j j } | j j d d � } | d k rX | | j k rX t | | j | � } n x! | D] } | t j t j � q_ W| j
j d d � } | d k r� | | j
k r� t | | j
| � } n x' | D] } | � } | d k r� | Sq� Wd S( s� 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( ( ( R R� R R� R� R� Rr R Rl R[ R~ ( R> R� R� R� R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyR_ � s
c C s� t j } | j j } | j } | d k rX | | j k rX t | t | j | � � } n d | j k r� t | t | j d � � } n x | D] } | | � } q� W| j j
| j � s� | j j | | j | � n | S( s 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(
R R� R R� t _after_request_functionsRr R� R t reversedR� t is_null_sessionR R ( R> R t ctxR� R� R= ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRb � s
c C s� | t k r t j � d } n t | j j d d � � } t j j j
} | d k r� | | j k r� t | t | j | � � } n x | D] } | | � q� Wt j
| d | �d S( s2 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() <flask.ctx.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.
i t excN( ( t _sentinelR� RC R� R� R� Rr R R� R R� R R1 RM ( R> R� R� R� R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt do_teardown_request� s
c C sZ | t k r t j � d } n x! t | j � D] } | | � q/ Wt j | d | �d S( s� 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() <flask.ctx.AppContext.pop>`.
.. versionadded:: 0.9
i R� N( R� R� RC R� R� R- RM ( R> R� R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt do_teardown_appcontext� s
c C s
t | � S( sF 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() <flask.ctx.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> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt app_context s c C s
t | | � S( s$ 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� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt request_context) s c O sK d d l m } | | | | � } z | j | j � � SWd | j � Xd S( s� 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`.
i ( t EnvironBuilderN( R� R� R� t get_environt close( R> R? R@ R� t builder( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt test_request_context9 s
/c C s� | j | � } d } zo y | j � | j � } WnA t k
r\ } | } | j | � } n t j � d } � n X| | | � SWd | j | � r� d } n | j | � Xd S( s� 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.
i N(
R� Rr t pushR` R RR R� RC Ri t auto_pop( R> R� t start_responseR� RS R R: ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt wsgi_appq s
c C s | j | | � S( s� The WSGI server calls the Flask application object as the
WSGI application. This calls :meth:`wsgi_app` which can be
wrapped to applying middleware.( R� ( R> R� R� ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt __call__� s c C s d | j j | j f S( Ns <%s %r>( t __class__R) R� ( R> ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt __repr__� s N(} R) t
__module__t __doc__R5 t
request_classR6 R� R4 R� R t app_ctx_globals_classR R� R R� t
secret_keyt session_cookie_nameR: t permanent_session_lifetimet send_file_max_age_defaultt use_x_sendfileR t JSONEncodert json_encodert JSONDecodert json_decoderR� R Rr R� R R� R� R R R
R� R� R� R, R� R� Rj Rk Ro R( R� t propertyR� R� R� R� R� Ry Rs R� R� t setterR� R� R� R� R� R� R; R� R� R� R� R R RC R R R� R Rl t staticmethodR R! R" R R( R' R+ R* R. R- R/ R0 R1 R2 R3 R4 R5 R6 R7 R> R? RA RJ RR RN RX R] R` RP R^ RZ Ri Ra R} R� R� R_ Rb R� R� R� R� R� R� R� R� R� ( ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyRD g s, a
�
#
l 8 $ i %
'! ! # + ;
v & 8 + (S R� Rt R� R� t datetimeR t functoolsR t itertoolsR t threadingR t werkzeug.datastructuresR R t werkzeug.exceptionsR R R R R
R t werkzeug.routingR R
R R R t werkzeug.wrappersR t R R t _compatR R R R Rz R R R� R R R R� R R R R t helpersR! R" R# R$ R% R& R' R( R) R* t loggingR+ t sessionsR, t signalsR- R. R/ R0 R1 t
templatingR2 R3 R4 t wrappersR5 R6 t objectR� R: RC RD ( ( ( s( /tmp/pip-build-W6Gm0N/Flask/flask/app.pyt <module>
s|