gEdZddlZddlZddlmZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZmZmZmZdd lmZmZmZmZmZd d lmZmZmZmZmZm Z m!Z!d d l"m#Z#m$Z$d dl%m&Z&m'Z'd dl(m)Z)m*Z*d dl+m,Z,m-Z-m.Z.d dl/m0Z0m1Z1m2Z2m3Z3d dl4m5Z5d dl6m7Z7m8Z8m9Z9d dl:m;Z;mZ>m?Z?d dl@mAZAmBZBmCZCmDZDeZEeFZGdZHdZIGddeZJdS)z flask.app ~~~~~~~~~ This module implements the central WSGI application object. :copyright: (c) 2015 by Armin Ronacher. :license: BSD, see LICENSE for more details. N)Lock) timedelta)chainupdate_wrapper)deque) ImmutableDict)MapRuleRequestRedirect BuildError) HTTPExceptionInternalServerErrorMethodNotAllowed BadRequestdefault_exceptions)_PackageBoundObjecturl_forget_flashed_messageslocked_cached_property_endpoint_from_view_func find_packageget_debug_flag)jsoncli)RequestResponse)ConfigAttributeConfig)RequestContext AppContext_AppCtxGlobals)_request_ctx_stackrequestsessiong)SecureCookieSessionInterface)DispatchingJinjaLoader Environment_default_template_ctx_processor)request_startedrequest_finishedgot_request_exceptionrequest_tearing_downappcontext_tearing_down)reraise string_types text_type integer_typescPt|tst|S|S)N)seconds) isinstancer)values ?/granary/edev/quantum/lib/python3.11/site-packages/flask/app.py_make_timedeltar:.s* eY ' '('''' Lc.fd}t|S)zkWraps a method so that it performs a check in debug mode if the first request was already handled. cV|jr|jrtd|g|Ri|S)NamA 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.)debug_got_first_requestAssertionError)selfargskwargsfs r9 wrapper_funcz!setupmethod..wrapper_func8sV : C$1 C "BCC Cq'''''''r;r)rDrEs` r9 setupmethodrF4s. ( ( ( ( ( , * **r;ceZdZdZeZeZeZ e Z dZ dZ ee e Z[ [ eZedZedZedZedZede Zed e Zed Zed ZejZejZ e!d dgZ"e!ide#dddddddddde$dd dd dddddddddddddddd dd!dde$d"#dddd$dddd%dd& Z%e&Z'dZ(e)Z* dsd)Z+d*Z,d+Z-ee,e-Z.[,[-e/d,Z0ed-Z1ed.Z2ed/Z3e/d0Z4ed1Z5dtd2Z6d3Z7dud5Z8d6Z9d7Z:d8Z;d9Zdvd<Z?dwd=Z@d>ZAd?ZBd@ZCeDdAZEdBZFeDdxdCZGdDZHeDdEZIeJdFZKeDdGZLdHZMeDdIZNeDdydJZOeDdydKZPeDdydLZQeDdydMZReDdydNZSeDdydOZTeDdPZUeDdQZVeDdRZWeDdSZXeDdTZYeDdUZZeDdVZ[eDdWZ\eDdXZ]dYZ^dZZ_d[Z`d\Zad]Zbd^Zcd_Zdd`ZedaZfdbZgdcZhddZideZjdfZkdgZldhZmdiZndjZoepfdkZqepfdlZrdmZsdnZtdoZudpZvdqZwdrZxdS)zFlaskaThe 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. :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 should be served at `static_url_path`. Defaults to the ``'static'`` folder in the root path of the application. :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. c|jSN)app_ctx_globals_classrAs r9_get_request_globals_classz Flask._get_request_globals_classs ))r;cPddlm}|td||_dS)NrwarnzCrequest_globals_class attribute is now called app_ctx_globals_class)warningsrPDeprecationWarningrK)rAr8rPs r9_set_request_globals_classz Flask._set_request_globals_classsM!!!!!!  !?@@ A A A%*"""r;DEBUGTESTING SECRET_KEYSESSION_COOKIE_NAMEPERMANENT_SESSION_LIFETIME) get_converterSEND_FILE_MAX_AGE_DEFAULTUSE_X_SENDFILE LOGGER_NAMEzjinja2.ext.autoescapezjinja2.ext.with_) extensionsF)defaultPROPAGATE_EXCEPTIONSNPRESERVE_CONTEXT_ON_EXCEPTION)daysLOGGER_HANDLER_POLICYalways SERVER_NAMEAPPLICATION_ROOTr&SESSION_COOKIE_DOMAINSESSION_COOKIE_PATHSESSION_COOKIE_HTTPONLYTSESSION_COOKIE_SECURESESSION_REFRESH_EACH_REQUEST )hourshttpzapplication/json) MAX_CONTENT_LENGTHrZTRAP_BAD_REQUEST_ERRORSTRAP_HTTP_EXCEPTIONSEXPLAIN_TEMPLATE_LOADINGPREFERRED_URL_SCHEME JSON_AS_ASCIIJSON_SORT_KEYSJSONIFY_PRETTYPRINT_REGULARJSONIFY_MIMETYPETEMPLATES_AUTO_RELOADstatic templatesc tj|||||"ddlm} | t dd|}|||_|||_||}n.tj |std||_ | ||_d|_|j|_i|_i|_d|ji|_g|_i|_g|_i|_i|_g|_i|_i|_dt:gi|_g|_i|_ g|_!i|_"tG|_$d|_%tM|_'|j(r%|)|jd zd |j* tWj,|j-|_+dS) N)template_folder root_pathrrOz)static_path is now called static_url_path stacklevelzXIf an instance path is provided it must be absolute. A relative path was given instead.Fz/ry)endpoint view_func).r__init__rQrPrRstatic_url_path static_folderauto_find_instance_pathospathisabs ValueError instance_path make_configconfig_logger import_name logger_nameview_functions_error_handlerserror_handler_specurl_build_error_handlersbefore_request_funcsbefore_first_request_funcsafter_request_funcsteardown_request_funcsteardown_appcontext_funcsurl_value_preprocessorsurl_default_functionsr+template_context_processorsshell_context_processors blueprints_blueprint_orderr]r url_mapr?r_before_request_lockhas_static_folder add_url_rulesend_static_filerAppGroupname) rAr static_pathrrr|rinstance_relative_configr}rPs r9rzFlask.__init__Ts? $T;5D/8 : : : :  " % % % % % % D#%677CD F F F F)O  D  $!.D    88::MM}-- NMNN N + &&'?@@  + ! "$()=">)+%%'!+-'$& ')#*,&(*$&(" 23, ()+% " "uu #($(FF!  ! ?   d25GG'/(,(=  ? ? ?< **r;cPddlm}|tdd|jS)NrrOzOerror_handlers is deprecated, use the new error_handler_spec attribute instead.rr)rQrPrRr)rArPs r9_get_error_handlerszFlask._get_error_handlers(sO!!!!!!  !899EF H H H H##r;c(||_||jd<dSrJ)rr)rAr8s r9_set_error_handlerszFlask._set_error_handlers-s$(-%%%r;c|jdkrgttjddd}|dStjtj|dS|jS)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)rgetattrsysmodulesrrsplitextbasename)rAfns r9rz Flask.name3sh  z ) )Z0*dCCBz!z7##BG$4$4R$8$899!< <r;c@|jd}||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_)rtestingr>rArvs r9propagate_exceptionszFlask.propagate_exceptionsDs*[/ 0 >I|)tz)r;c2|jd}||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`)rr>rs r9preserve_context_on_exceptionz#Flask.preserve_context_on_exceptionPs#[8 9 >Izr;c|jr|jj|jkr|jSt5|jr(|jj|jkr|jcdddSddlm}||x|_}|cdddS#1swxYwYdS)aA :class:`logging.Logger` object for this application. The default configuration is to log to stderr if the application is in debug mode. This logger can be used to (surprise) log messages. Here some examples:: app.logger.debug('A value for debugging') app.logger.warning('A warning occurred (%d apples)', 42) app.logger.error('An error occurred') .. versionadded:: 0.3 Nr) create_logger)rrr _logger_lock flask.loggingr)rArrs r9loggerz Flask.logger]s < DL-1AAA<    | $ 1T5E E E|         4 3 3 3 3 3 - d 3 3 3DL2                   s#BBBBc*|S)z.The Jinja2 environment used to load templates.)create_jinja_environmentrLs r9 jinja_envzFlask.jinja_envss,,...r;c|jS)zThis attribute is set to ``True`` if the application started handling the first request. .. versionadded:: 0.8 )r?rLs r9got_first_requestzFlask.got_first_requestxs &&r;cX|j}|r|j}|||jS)adUsed 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 config_classdefault_config)rAinstance_relativer}s r9rzFlask.make_configs4N  +*I  D,?@@@r;ct|j\}}| tj|dStj|d|jdzS)aTries 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)rrrrjoinr)rAprefix package_paths r9rzFlask.auto_find_instance_pathsS ,D,<== >7<< j99 9w||FE49{+BCCCr;rbchttj|j||S)aOpens 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'. )openrrrr)rAresourcemodes r9open_instance_resourcezFlask.open_instance_resources'BGLL!3X>>EEEr;cbt|j}d|vr |j|d<d|vr(|jd|jd|d<n |j|d<|j|fi|}|jtt|jttttj|jd<|S)aCreates the Jinja2 environment based on :attr:`jinja_options` and :meth:`select_jinja_autoescape`. Since 0.7 this also adds the Jinja2 globals and filters after initialization. Override this function to customize the behavior. .. versionadded:: 0.5 .. versionchanged:: 0.11 ``Environment.auto_reload`` set in accordance with ``TEMPLATES_AUTO_RELOAD`` configuration option. autoescape auto_reloadrxN)rrrr%r&r'tojson)dict jinja_optionsselect_jinja_autoescaperr>jinja_environmentglobalsupdaterrr%r&r'r tojson_filterfilters)rAoptionsrs r9rzFlask.create_jinja_environmentst)** w & &$($@GL !  ' '{23?)-5L)M &&)- & #T #D 4 4G 4 4 !5;   $1 8 r;c t|S)aCreates 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 )r)rLs r9create_global_jinja_loaderz Flask.create_global_jinja_loaders&d+++r;cdS)zDeprecated. Used to initialize the Jinja2 globals. .. versionadded:: 0.5 .. versionchanged:: 0.7 This method is deprecated with 0.7. Override :meth:`create_jinja_environment` instead. NrLs r9init_jinja_globalszFlask.init_jinja_globalssr;c4|dS|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)z.htmlz.htmz.xmlz.xhtml)endswith)rAfilenames r9rzFlask.select_jinja_autoescapes$  4  !DEEEr;c6|jd}tj}|2|jj}|$||jvrt ||j|}|}|D]}|| ||dS)aUpdate 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)rr$topr% blueprintrcopyr)rAcontextfuncsreqctxbporig_ctxfuncs r9update_template_contextzFlask.update_template_contexts06#'  )B~"(H"H"HeT%Eb%IJJ<<>> # #D NN4466 " " " " x     r;ch|td}|jD]}|| |S)zReturns the shell context for an interactive shell for this application. This runs all the registered shell context processors. .. versionadded:: 0.11 )appr')r'rr)rAr processors r9make_shell_contextzFlask.make_shell_contextsC " "6 # #I IIiikk " " " " r;c ddlm}|d}|?|jd}|r.d|vr*t|ddd}nd}|t ||_|d |j|d |j|d d  ||||fi|d |_dS#d |_wxYw)aRuns 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. .. versionchanged:: 0.10 The default port is now picked from the ``SERVER_NAME`` variable. :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'``. :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 options: the options to be forwarded to the underlying Werkzeug server. See :func:`werkzeug.serving.run_simple` for more information. r) run_simpleNz 127.0.0.1re:ri use_reloader use_debuggerpassthrough_errorsTF) werkzeug.servingrrintrsplitboolr> setdefaultr?)rAhostportr>rr server_names r9runz Flask.runs Z 0///// <D <+m4K sk11;--c155a899  eDJ>4:666>4:666/666 , JtT4 3 37 3 3 3 ',D # # #eD # + + + +s / C C c B|j}|ddlm}|||jfd|i|S)aCreates 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, authentication=None, *args, **kwargs): FlaskClient.__init__(*args, **kwargs) self._authentication = authentication 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) FlaskClient use_cookies)test_client_class flask.testingr response_class)rAr rCclss r9 test_clientzFlask.test_clientRsFf$ ; 8 8 8 8 8 8s4,PP+PPPPr;c8|j||S)aPCreates 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`. :param request: an instance of :attr:`request_class`. )session_interface open_sessionrAr%s r9rzFlask.open_sessions%224AAAr;c:|j|||S)aSaves 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`. :param session: the session to be saved (a :class:`~werkzeug.contrib.securecookie.SecureCookie` object) :param response: an instance of :attr:`response_class` )r save_session)rAr&responses r9rzFlask.save_sessions%224(KKKr;c6|j|S)zCreates a new instance of a missing session. Instead of overriding this method we recommend replacing the :class:`session_interface`. .. versionadded:: 0.7 )rmake_null_sessionrLs r9rzFlask.make_null_sessions %77===r;c &d}|j|jvr>|j|j|us)Jd|d|j|jd|jdn+||j|j<|j|d}||||dS)aRegister a blueprint on the application. For information about blueprints head over to :ref:`blueprints`. The blueprint name is passed in as the first argument. Options are passed as additional keyword arguments and forwarded to `blueprints` in an "options" dictionary. :param subdomain: set a subdomain for the blueprint :param url_prefix: set the prefix for all URLs defined on the blueprint. ``(url_prefix='/')`` :param url_defaults: a dictionary with URL defaults that is added to each and every URL defined with this blueprint :param static_folder: add a static folder to urls in this blueprint :param static_url_path: add a static url path to urls in this blueprint :param template_folder: set an alternate template folder :param root_path: set an alternate root path for this blueprint .. versionadded:: 0.7 Fz.A blueprint's name collision occurred between z and z. Both share the same name "z=". Blueprints that are created on the fly need unique names.TN)rrrappendregister)rArrfirst_registrations r9register_blueprintzFlask.register_blueprints*# >T_ , ,?9>2i????DOIN;;;Y^^^M@??? /8DOIN +  ! ( ( 3 3 3!% 4*<=====r;c*t|jS)zhIterates over all blueprints by the order they were registered. .. versionadded:: 0.11 )iterrrLs r9iter_blueprintszFlask.iter_blueprintss D)***r;c |t|}||d<|dd}|t|ddpd}t|trt dt d|D}t t|dd}t|d d}|d |vrd }|d nd }||z}|j|fd|i|}||_ |j ||@|j |}|||krtd |z||j |<dSdS)aConnects 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 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. Nrmethods)GETz_Allowed methods have to be iterables of strings, for example: @app.route(..., methods=["POST"])c3>K|]}|VdSrJ)upper).0items r9 z%Flask.add_url_rule..s*77tdjjll777777r;required_methodsrprovide_automatic_optionsOPTIONSTFzFView function mapping is overwriting an existing endpoint function: %s)rpoprr7r2 TypeErrorsetaddurl_rule_classr,rrgetr@) rArulerrrr$r+r,old_funcs r9rzFlask.add_url_rulesd  / ::H& ++i.. ?iD99EXG g| , , NMNN N77w77777wy2DbIIJJ%,I '%/%/! % ,'',0) $$Y////,1) ##"t"4DDDGDD)B&   *..x88H#I(=(=$&FHP&QRRR,5D  ) ) ) ! r;c fd}|S)aA 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. cTdd}j||fi|S)Nr)r.r)rDrrr4rAs r9 decoratorzFlask.route..decoratorGs:{{:t44H D dHa ; ;7 ; ; ;Hr;r)rAr4rr8s``` r9routez Flask.route/s00       r;cfd}|S)zA 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|j<|SrJ)r)rDrrAs r9r8z!Flask.endpoint..decoratorXs,-D  )Hr;r)rArr8s`` r9rzFlask.endpointMs*      r;ct|trt|}n|}t|tsJt|t r ||jfS|dfS)z7Ensure that we register only exceptions as handler keysN)r7r4r issubclass Exceptionrcode)exc_class_or_code exc_classs r9_get_exc_class_and_codezFlask._get_exc_class_and_code]sh ' 7 7 **+<=II)I)Y///// i / / #in, ,d? "r;cfd}|S)aaA decorator that is used to register a function give a given 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 You can also register a function as error handler without using the :meth:`errorhandler` decorator. The following example is equivalent to the one above:: def page_not_found(error): return 'This page does not exist', 404 app.error_handler_spec[None][404] = page_not_found Setting error handlers via assignments to :attr:`error_handler_spec` however is discouraged as it requires fiddling with nested dictionaries and the special case for arbitrary exception types. The first ``None`` refers to the active blueprint. If the error handler should be application wide ``None`` shall be used. .. 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: the code as integer for the handler c6d||SrJ_register_error_handler)rDcode_or_exceptionrAs r9r8z%Flask.errorhandler..decorators!  ( (/@! D D DHr;r)rArGr8s`` r9 errorhandlerzFlask.errorhandlerls+T      r;c4|d||dS)zAlternative error attach function to the :meth:`errorhandler` decorator that is more straightforward to use for non decorator usage. .. versionadded:: 0.7 NrE)rArGrDs r9register_error_handlerzFlask.register_error_handlers# $$T+>II$PRSSr;cfd}|S)aA 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. c6||SN)r)add_template_filterrDrrAs r9r8z(Flask.template_filter..decorator!  $ $QT $ 2 2 2Hr;rrArr8s`` r9template_filterzFlask.template_filters*      r;c2||jj|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)rr__name__rArDrs r9rRzFlask.add_template_filters 67t1qz222r;cfd}|S)aSA 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. c6||SrQ)add_template_testrSs r9r8z&Flask.template_test..decorators!  " "14 " 0 0 0Hr;rrUs`` r9 template_testzFlask.template_tests*(      r;c2||jj|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)rtestsrXrYs r9r\zFlask.add_template_tests 45T/QZ000r;cfd}|S)aA 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. c6||SrQ)add_template_globalrSs r9r8z(Flask.template_global..decoratorrTr;rrUs`` r9template_globalzFlask.template_globals*      r;c2||jj|p|j<dS)aRegister 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)rrrXrYs r9rbzFlask.add_template_global s 67t1qz222r;cb|jdg||S)aRegisters a function to run before each request. The function will be called without any arguments. If the function returns a non-None value, it's handled as if it was the return value from the view and further request handling is stopped. N)rrrrArDs r9before_requestzFlask.before_requests0 !,,T266==a@@@r;c:|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 )rrrfs r9before_first_requestzFlask.before_first_request#s  '..q111r;cb|jdg||S)auRegister 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)rrrrfs r9 after_requestzFlask.after_request0s0  ++D"55<s1H #..tR88??BBBr;c:|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 exception it will be passed an error object. The return values of teardown functions are ignored. .. versionadded:: 0.9 )rrrfs r9teardown_appcontextzFlask.teardown_appcontextes 8 &--a000r;cF|jd||S)z0Registers a template context processor function.N)rrrfs r9context_processorzFlask.context_processors% (.55a888r;c:|j||S)zVRegisters a shell context processor function. .. versionadded:: 0.11 )rrrfs r9shell_context_processorzFlask.shell_context_processors %,,Q///r;cb|jdg||S)zRegisters a function as URL value preprocessor for all view functions of the application. It's called before the view functions are called and can modify the url values provided. N)rrrrfs r9url_value_preprocessorzFlask.url_value_preprocessors0 $//b99@@CCCr;cb|jdg||S)zCallback 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)rrrrfs r9 url_defaultszFlask.url_defaultss0 "--dB77>>qAAAr;c4|t|\}fd}||jtji|}||S||jd|S)uFinds a registered error handler for the request’s blueprint. Otherwise falls back to the app, returns None if not a suitable handler is found. c,|sdStj}t}|rj|}||vr||||}|||<|S||j|hdSdSrJ)r__mro__r0popleftr1r3extend) handler_mapqueuedonerhandlerrAs r9 find_handlerz/Flask._find_error_handler..find_handlers )+,,E55D *mmoo$;; %//#..&-4K *"N S[))) * * * * *r;N)rBtyperr3r%r)rAer?rrrAs @r9_find_error_handlerzFlask._find_error_handlers 66tAww?? 4 * * * * *,,t6 #G$5r : : #D ++  N|D3D9==dCCDDDr;c\|j|S||}||S||S)zHandles an HTTP exception. By default this will invoke the registered error handlers and fall back to returning the exception as response. .. versionadded:: 0.3 )r?r)rArrs r9handle_http_exceptionzFlask.handle_http_exceptions; 6>H**1-- ?Hwqzzr;ch|jdrdS|jdrt|tSdS)aChecks 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. .. versionadded:: 0.8 rqTrpF)rr7r)rArs r9trap_http_exceptionzFlask.trap_http_exceptions> ;- . 4 ;0 1 -a,, ,ur;c tj\}}}||usJt|tr*||s||S||}|t|||||S)aThis method is called whenever an exception occurs that should be handled. A special case are :class:`~werkzeug.exception.HTTPException`\s which are forwarded by this function to the :meth:`handle_http_exception` method. This function will either return a response value or reraise the exception with the same traceback. .. versionadded:: 0.7 )rexc_infor7rrrrr1rArexc_type exc_valuetbrs r9handle_user_exceptionzFlask.handle_user_exceptions#&,..)RA~~~~ a ' ' 10H0H0K0K 1--a00 0**1-- ? Hi , , ,wqzzr;cBtj\}}}tj|||t }|jr||urt|||n|||||f|t S||S)aDefault exception handling that kicks in when an exception occurs that is not caught. In debug mode the exception will be re-raised immediately, otherwise it is logged and the handler for a 500 internal server error is used. If no such handler exists, a default 500 internal server error message is displayed. .. versionadded:: 0.3 ) exception) rrr.sendrrrr1 log_exceptionrs r9handle_exceptionzFlask.handle_exception s#&,..)R"415555**+>+@+@AA  $  A~~)R0000 Hi4555 ?&(( (wqzzr;ct|jdtjdtjd|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 [])rN)rerrorr%rmethod)rArs r9rzFlask.log_exception(sL  LLL NNN       r;c|jr#t|jtr |jdvr|jddlm}||)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)FormDataRoutingRedirect)r>r7routing_exceptionr r debughelpersr)rAr%rs r9raise_routing_exceptionzFlask.raise_routing_exception5s]z ,W6HH ,n :::+ +999999%%g...r;ctjj}|j|||j}t |ddr|jdkr|S|j |j di|j S)aDoes 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) r$rr%rrurl_rulerrmake_default_options_responserr view_args)rAreqr4s r9dispatch_requestzFlask.dispatch_requestEs!$,  ,  ( ( - - -| 44e < < 8zY&&5577 71t"4=1BBCMBBBr;c| tj||}||}n,#t $r}||}Yd}~nd}~wwxYw||}||}tj|||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)r) *try_trigger_before_first_request_functionsr,rpreprocess_requestrr>r make_responseprocess_responser-)rArrrs r9full_dispatch_requestzFlask.full_dispatch_request[s 77999 /   & & &((**Bz**,, / / /++A..BBBBBB /%%b))((22dX6666s>A A>A99A>c|jrdS|j5|jr ddddS|jD] }| d|_ddddS#1swxYwYdS)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?rr)rArs r9rz0Flask.try_trigger_before_first_request_functionsos  "  F  & + +&  + + + + + + + +7  &*D #  + + + + + + + + + + + + + + + + + +s AAAAcbtjj}t|dr|}nJg} |dn0#t $r}|j}Yd}~nd}~wt$r }Yd}~nd}~wwxYw| }|j ||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 allowed_methodsz--)rN) r$r url_adapterhasattrrmatchr valid_methodsrrallowr)rAadapterr$rrs r9rz#Flask.make_default_options_responses%(4 7- . . --//GGG  T ****# * * */       " "     sA A>A'' A>9A>cdS)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 Fr)rArs r9should_ignore_errorzFlask.should_ignore_errors ur;cHdx}}t|tr|ddt|z zz\}}}|tdt|tt fr|d}}t||jsdt|tttfr||||}dx}}n%|j |tj }|$t|tr||_n||_|r|j||S)aConverts the return value from a view function to a real response object that is an instance of :attr:`response_class`. The following types are allowed for `rv`: .. tabularcolumns:: |p{3.5cm}|p{9.5cm}| ======================= =========================================== :attr:`response_class` the object is returned unchanged :class:`str` a response object is created with the string as body :class:`unicode` a response object is created with the string encoded to utf-8 as body a WSGI function the function is called as WSGI application and buffered as response object :class:`tuple` A tuple in the form ``(response, status, headers)`` or ``(response, headers)`` where `response` is any of the types defined here, `status` is a string or an integer and `headers` is a list or a dictionary with header values. ======================= =========================================== :param rv: the return value from the view function .. versionchanged:: 0.9 Previously a tuple was interpreted as the arguments for the response object. NrJz'View function did not return a response)headersstatus)r7tuplelenrrlistrr3bytes bytearray force_typer%environr2r status_coderr|)rArstatus_or_headersrs r9rzFlask.make_responsesB<'+*G b%  J-/'QR[2I-I *B!7 :FGG G '$ 6 6 A):D&G"d122 I "y%;<< I((W0A)CC.22++(33BHH  (+\:: 3- !2  ' J  g & & & r;c|,|j|j|jdS|jd@|j|jd|jdpd|jdSdS)aCreates 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. Nre)rrf/rs) script_name url_scheme)rbind_to_environrrbindrs r9create_url_adapterzFlask.create_url_adapters  <// K 6088 8 ;} % 1<$$ M* K(:;Bs;'=>%@@ @ 2 1r;c|jdd}d|vrE|ddd}t||j|d}|D]}|||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 Nr.rr)rr3rr)rArvaluesrrrs r9inject_url_defaultszFlask.inject_url_defaultss*..tR88 (??a((+B%!;!?!?B!G!GHHE # #D D6 " " " " # #r;ctj\}}}|jD]/} ||||}||cS#t$r } | }Yd} ~ (d} ~ wwxYw||urt ||||)zIHandle :class:`~werkzeug.routing.BuildError` on :meth:`url_for`. N)rrrr r1) rArrrrrrrrrs r9handle_url_build_errorzFlask.handle_url_build_errors#&,..)R4  G WUHf55>III"     I   Hi , , , s6 A AA ctjjj}|jdd}|$||jvrt ||j|}|D]"}|tjtj#|j dd}|$||j vrt ||j |}|D]}|}||cSdS)aCalled before the actual request dispatching and will call each :meth:`before_request` decorated function, passing no arguments. If any of these functions returns a value, it's handled as if it was the return value from the view and further request handling is stopped. This also triggers the :meth:`url_value_processor` functions before the actual :meth:`before_request` functions are called. Nr) r$rr%rrr3rrrr)rArrrrs r9rzFlask.preprocess_requests # + 5,00r:: >bD$@@@%!=b!ABBE 6 6D D!7#4 5 5 5 5)--dB77 >bD$===%!:2!>??E  DB~   r;ctj}|jj}|j}|1||jvr(t |t|j|}d|jvr(t |t|jd}|D] }||}|j |j s| |j ||S)aCan 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$rr%r_after_request_functionsrrreversedris_null_sessionr&r)rArctxrrrs r9rzFlask.process_response1s!$ [ ", >bD$<<<%$*B2*F!G!GHHE 4+ + +%$*B4*H!I!IJJE ) )Gwx((HH%55ckBB 5   ck8 4 4 4r;cx|turtjd}t|jdd}t jjj }|1||jvr(t|t|j|}|D] }||tj ||dS)aCalled after the actual request dispatching and will call every as :meth:`teardown_request` decorated function. This is not actually called by the :class:`Flask` object itself but is always triggered when the request context is popped. That way we have a tighter control over certain resources under testing environments. .. versionchanged:: 0.9 Added the `exc` argument. Previously this was always using the current exception information. rNrexc) _sentinelrrrrr3r$rr%rrr/r)rArrrrs r9do_teardown_requestzFlask.do_teardown_requestKs )  ,..#C488rBBCC  # + 5 >bD$???%$*Eb*I!J!JKKE  D DIIII!$C000000r;c|turtjd}t|jD] }||t j||dS)zCalled when an application context is popped. This works pretty much the same as :meth:`do_teardown_request` but for the application context. .. versionadded:: 0.9 rrN)rrrrrr0r)rArrs r9do_teardown_appcontextzFlask.do_teardown_appcontext`sd )  ,..#CT;<<  D DIIII$Ts333333r;c t|S)aBinds the application only. For as long as the application is bound to the current context the :data:`flask.current_app` points to that application. An application context is automatically created when a request context is pushed if necessary. Example usage:: with app.app_context(): ... .. versionadded:: 0.9 )r"rLs r9 app_contextzFlask.app_contextms$r;c"t||S)aCreates a :class:`~flask.ctx.RequestContext` from the given environment and binds it to the current context. This must be used in combination with the ``with`` statement because the request is only bound to the current context for the duration of the ``with`` block. Example usage:: with app.request_context(environ): do_something_with(request) The object returned can also be used without the ``with`` statement which is useful for working in the shell. The example above is doing exactly the same as this code:: ctx = app.request_context(environ) ctx.push() try: do_something_with(request) finally: ctx.pop() .. versionchanged:: 0.3 Added support for non-with statement usage and ``with`` statement is now passed the ctx object. :param environ: a WSGI environment )r!)rArs r9request_contextzFlask.request_context|s8dG,,,r;cddlm}||g|Ri|} |||S#|wxYw)zCreates a WSGI environment from the given values (see :class:`werkzeug.test.EnvironBuilder` for more information, this function accepts the same arguments). r)make_test_environ_builder)rrr get_environclose)rArBrCrbuilders r9test_request_contextzFlask.test_request_contextsy <;;;;;++DB4BBB6BB ''(;(;(=(=>> MMOOOOGMMOOOOs &AA%c||}|d} |}nA#t$r4}|}|||}Yd}~nd}~wwxYw|||||rd}||S#||rd}||wxYw)aThe actual WSGI application. This is not implemented in `__call__` so that middlewares can be applied without losing a reference to the class. So 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 The behavior of the before and after request callbacks was changed under error conditions and a new callback was added that will always execute at the end of the request, independent on if an error occurred or not. 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 N)rpushrr>rrrauto_pop)rArstart_responserrrrs r9wsgi_appzFlask.wsgi_apps2""7++    H5577 H H H--d.C.CA.F.FGG H8G^44''..  LL    ''..  LL    s/AB< B *A<7B<<BB<<.C*c.|||S)zShortcut for :attr:`wsgi_app`.)r)rArrs r9__call__zFlask.__call__s}}Wn555r;c2d|jjd|jdS)N< >) __class__rXrrLs r9__repr__zFlask.__repr__s% N # # # III  r;)NNryrzNFN)F)r)NNN)T)NNrJ)yrX __module__ __qualname____doc__r request_classrrr*rr#rKrMrSpropertyrequest_globals_classr rrr>r secret_keysession_cookie_namer:permanent_session_lifetimesend_file_max_age_defaultuse_x_sendfilerr JSONEncoder json_encoder JSONDecoder json_decoderr rrrrr r2r r(rrrrerror_handlersrrrrrrrrrrrrrrrrr rrrrrFrr"rr9r staticmethodrBrHrJrFrVrRr]r\rcrbrgrirkrmrorqrsrurwrrrrrrrrrrrrrrrrrrrrrrrrrrrrr;r9rHrHEsQQjMN $ +***+++ %H%?%?AA"$>L OG $ $Eoi((G!..J */*?@@"11M%"'"'"'!00K%!'!'!'%_%566N "/-00K #L #L"M+-?@M #]$u0M0M0M$$ $ ( $  $ % r0B0B0B $ $ $ x$ $ $  $ $ $ "$ !$" '#$$1509 0C0C0C050505060404040B049$$$NFN  5466FJ9D>CR+R+R+R+h$$$ ...X13FGGN0    * *X *  X X*///''X' A A A A D D D F F F F   D , , ,   FFF!!!2   A,A,A,A,F6Q6Q6Q6QpBBB L L L>>>>>[>B+++[6[6[6[[6z<  [  # #\ #,,[,\AAA  [ "["777[7[0 5 5 5[ 5[& 7 7 7[ 7  [   [   [ $$[$L[<[ [[[$E$E$EL"(6:   /// CCC,(+++ .<<<|@@@, # # #(64'01111**3 4 4 4 4    ---<   & & & P666     r;rH)Krrr threadingrdatetimer itertoolsr functoolsr collectionsrwerkzeug.datastructuresr werkzeug.routingr r r r werkzeug.exceptionsrrrrrhelpersrrrrrrrrrwrappersrrrrr rr!r"r#rr$r%r&r'sessionsr( templatingr)r*r+signalsr,r-r.r/r0_compatr1r2r3r4robjectrr:rFrHrr;r9rs $$$$$$111111CCCCCCCCCCCC66666666666666''''''''++++++++;;;;;;;;;;<<<<<<<<<<<<222222%%%%%%%%%%33333333333333DDDDDDDDDDDDtvv  FHH  +++"Q Q Q Q Q Q Q Q Q Q r;