U aA@sddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddlmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlm Z ddl!m"Z#ddl$m%Z%ddl$m&Z&ddl'm(Z(ddl'm)Z)ddl*m+Z+ddl*m,Z,ddl*m-Z-ddl.m/Z/ddl.m0Z0ddl.m1Z1ddl.m2Z2dd l3m4Z4dd!l3m5Z5dd"l3m6Z6dd#l3m7Z7dd$l3m8Z8dd%l3m9Z9dd&l3m:Z:dd'l&m;Z;dd(lmZ>dd*l=m?Z?dd+l=m@Z@dd,l=mAZAdd-l=mBZBdd.lCmDZDdd/lEmFZFdd0lEmGZGdd1lEmHZHdd2lEmIZIdd3lEmJZJdd4lKmLZLdd5lKmMZMdd6lmNZNdd7lmOZOdd8lmPZPdd9lmQZQdd:lmRZRdd;lmSZSddlmVZVdd?lmWZWdd@lmXZXddAlYmZZZddlYm"Z"ej[rlddl\Z]ddBl^m_Z_ddCl`maZaddDl`mbZbejcdEkrejdZdnejeefdFdGdHZdejge ejge dIdJdKZhGdLdMdMeAZidS)NN) timedelta)chain)Lock) TracebackType)Headers) ImmutableDict) BadRequest)BadRequestKeyError) HTTPException)InternalServerError) ContextVar) BuildError)Map) MapAdapter)RequestRedirect)RoutingException)Rule)Response)cli)json)Config)ConfigAttribute)_AppCtxGlobals AppContextRequestContext)_request_ctx_stack)g)request)session)_split_blueprint_path)get_debug_flag)get_env)get_flashed_messages)get_load_dotenv)locked_cached_property)url_for)jsonify create_logger)_endpoint_from_view_func) _sentinel) find_package)Scaffold) setupmethod)SecureCookieSessionInterface)appcontext_tearing_down)got_request_exception)request_finished)request_started)request_tearing_downDispatchingJinjaLoader) Environment)AfterRequestCallable)BeforeRequestCallable)ErrorHandlerCallable)ResponseReturnValue)TeardownCallable) TemplateContextProcessorCallableTemplateFilterCallableTemplateGlobalCallableTemplateTestCallable)URLDefaultCallable)URLValuePreprocessorCallable)Request) Blueprint FlaskClientFlaskCliRunner)funcreturncCs0t|r|j}qt|tjr&|j}qt|SN)inspectismethod__func__ isinstance functoolspartialrQiscoroutinefunction)rQr[JC:\Users\vtejo\AppData\Local\Temp\pip-unpacked-wheel-e702oxwa\flask\app.pyrZUs   rZvaluerRcCs |dkst|tr|St|dS)N)seconds)rWr)r^r[r[r\_make_timedelta_sr`cseZdZUdZeZeZeZ e Z e Z edZedZedZededZededZedZejZejZiZeed <ed d d d d d ed d d d ddd d dd d dd d d d d dddd dd ddZ e!Z"e#Z$d Z%e&j'e&j(ded<d Z)e&j'e&j(ded<e*Z+de,e&j'e,e&j'e,e&j'e,e-e-e&j'e,e&j'e,e-e&j'e,d fdd Z.e-ddd Z/e0e,dd!d"Z1e2e-dd#d$Z3e2e-dd%d&Z4e0e5j6dd'd(Z7e0edd)d*Z8e2e-dd+d,Z9de-e d-d.d/Z:e,dd0d1Z;de,e,e&je2e-dd6d7Z?e?j@e-d d8d9d7Z?edd:d;ZAeBddd?d@ZDed dAdBdCZEeddDdEZFedFZGe2e-ddGdHZHeHj@e-d d8dIdHZHde&j'e,e&j'eIe&j'e-e-e&jJd dJdKdLZKde-e&jJddMdNdOZLe&jJddPdQdRZMeNdSe&jJd dTdUdVZOe&jPdSddWdXZQeNde,e&j'e,e&j'e&jRe&j'e-e&jJd dYdZd[ZSeNde&j'e,e&jReTgeTfd\d]d^ZUeNdeTe&j'e,d d_d`daZVeNde&j'e,e&jReWgeWfd\dbdcZXeNdeWe&j'e,d d_dddeZYeNde&j'e,e&jReZgeZfd\dfdgZ[eNdeZe&j'e,d d_dhdiZ\eNe]e]djdkdlZ^eNe_e_djdmdnZ`eNe&jRe&jRdjdodpZaebe&j'ecdqdrdsZdeee&jfeeegfdqdtduZhebe-dqdvdwZiebe&jfeeegfdqdxdyZjebedqdzd{Zke&jfe&jlemeneofe&jld|fd d}d~dZpeddddZqegdddZredddZsde&jfegeefe-edddZtd dddZuedddZve&j'ene-dddZwe&jRe&jRdddZxe&jRde&jyfe&jRde&jJfdddZzegedddZ{e&j'ee&j'e|dddZ}e,ed dddZ~ebe,ee,dddZe&j'egdddZeedddZefe&j'end dddZefe&j'end dddZedddZeedddZe&jJe&jJedddZee&jRe&jJdddZee&jRe&jJdddZZS)FlaskaThe flask object implements a WSGI application and acts as the central object. It is passed the name of the module or package of the application. Once it is created it will act as a central registry for the view functions, the URL rules, template configuration and much more. The name of the package is used to resolve resources from inside the package or the folder the module is contained in depending on if the package parameter resolves to an actual python package (a folder with an :file:`__init__.py` file inside) or a standard module (just a ``.py`` file). For more information about resource loading, see :func:`open_resource`. Usually you create a :class:`Flask` instance in your main module or in the :file:`__init__.py` file of your package like this:: from flask import Flask app = Flask(__name__) .. admonition:: About the First Parameter The idea of the first parameter is to give Flask an idea of what belongs to your application. This name is used to find resources on the filesystem, can be used by extensions to improve debugging information and a lot more. So it's important what you provide there. If you are using a single module, `__name__` is always the correct value. If you however are using a package, it's usually recommended to hardcode the name of your package there. For example if your application is defined in :file:`yourapplication/app.py` you should create it with one of the two versions below:: app = Flask('yourapplication') app = Flask(__name__.split('.')[0]) Why is that? The application will work even with `__name__`, thanks to how resources are looked up. However it will make debugging more painful. Certain extensions can make assumptions based on the import name of your application. For example the Flask-SQLAlchemy extension will look for the code in your application that triggered an SQL query in debug mode. If the import name is not properly set up, that debugging information is lost. (For example it would only pick up SQL queries in `yourapplication.app` and not `yourapplication.views.frontend`) .. versionadded:: 0.7 The `static_url_path`, `static_folder`, and `template_folder` parameters were added. .. versionadded:: 0.8 The `instance_path` and `instance_relative_config` parameters were added. .. versionadded:: 0.11 The `root_path` parameter was added. .. versionadded:: 1.0 The ``host_matching`` and ``static_host`` parameters were added. .. versionadded:: 1.0 The ``subdomain_matching`` parameter was added. Subdomain matching needs to be enabled manually now. Setting :data:`SERVER_NAME` does not implicitly enable it. :param import_name: the name of the application package :param static_url_path: can be used to specify a different path for the static files on the web. Defaults to the name of the `static_folder` folder. :param static_folder: The folder with static files that is served at ``static_url_path``. Relative to the application ``root_path`` or an absolute path. Defaults to ``'static'``. :param static_host: the host to use when adding the static route. Defaults to None. Required when using ``host_matching=True`` with a ``static_folder`` configured. :param host_matching: set ``url_map.host_matching`` attribute. Defaults to False. :param subdomain_matching: consider the subdomain relative to :data:`SERVER_NAME` when matching routes. Defaults to False. :param template_folder: the folder that contains the templates that should be used by the application. Defaults to ``'templates'`` folder in the root path of the application. :param instance_path: An alternative instance path for the application. By default the folder ``'instance'`` next to the package or module is assumed to be the instance path. :param instance_relative_config: if set to ``True`` relative filenames for loading the config are assumed to be relative to the instance path instead of the application root. :param root_path: The path to the root of the application files. This should only be set manually when it can't be detected automatically, such as for namespace packages. TESTING SECRET_KEYSESSION_COOKIE_NAMEPERMANENT_SESSION_LIFETIME)Z get_converterSEND_FILE_MAX_AGE_DEFAULTUSE_X_SENDFILE jinja_optionsNF)days/r!Thttpzapplication/jsoni)ENVDEBUGrbPROPAGATE_EXCEPTIONSPRESERVE_CONTEXT_ON_EXCEPTIONrcrerg SERVER_NAMEAPPLICATION_ROOTrdZSESSION_COOKIE_DOMAINZSESSION_COOKIE_PATHZSESSION_COOKIE_HTTPONLYZSESSION_COOKIE_SECUREZSESSION_COOKIE_SAMESITEZSESSION_REFRESH_EACH_REQUESTZMAX_CONTENT_LENGTHrfTRAP_BAD_REQUEST_ERRORSTRAP_HTTP_EXCEPTIONSZEXPLAIN_TEMPLATE_LOADINGPREFERRED_URL_SCHEMEZ JSON_AS_ASCIIZJSON_SORT_KEYSZJSONIFY_PRETTYPRINT_REGULARZJSONIFY_MIMETYPETEMPLATES_AUTO_RELOADZMAX_COOKIE_SIZErKtest_client_classrMtest_cli_runner_classstatic templates) import_namestatic_url_path static_folder static_host host_matchingsubdomain_matchingtemplate_folder instance_pathinstance_relative_config root_pathc stj||||| d|dkr(|}ntj|srycsjf|SrS)Zsend_static_file)kwZself_refr[r\z Flask.__init__..)endpointhost view_func) super__init__auto_find_instance_pathospathisabs ValueErrorr make_configconfigurl_build_error_handlersbefore_first_request_funcsteardown_appcontext_funcsshell_context_processors blueprints extensions url_map_classurl_maprr_got_first_requestr_before_request_lockZhas_static_folderboolAssertionErrorweakrefref add_url_ruler|namer) selfr{r|r}r~rrrrrr __class__rr\rsP            zFlask.__init__)rRcCs |jo |jSrS)debugrrr[r[r\_is_setup_finished szFlask._is_setup_finishedcCsF|jdkr@ttjddd}|dkr(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)r{getattrsysmodulesrrsplitextbasename)rfnr[r[r\rs z Flask.namecCs"|jd}|dk r|S|jp |jS)zReturns the value of the ``PROPAGATE_EXCEPTIONS`` configuration value in case it's set, otherwise a sensible default is returned. .. versionadded:: 0.7 roN)rtestingrrrvr[r[r\propagate_exceptions!s zFlask.propagate_exceptionscCs|jd}|dk r|S|jS)zReturns the value of the ``PRESERVE_CONTEXT_ON_EXCEPTION`` configuration value in case it's set, otherwise a sensible default is returned. .. versionadded:: 0.7 rpNrrrr[r[r\preserve_context_on_exception-s z#Flask.preserve_context_on_exceptioncCst|S)aA 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*rr[r[r\logger:sz Flask.loggercCs|S)zThe Jinja environment used to load templates. The environment is created the first time this property is accessed. Changing :attr:`jinja_options` after that will have no effect. )create_jinja_environmentrr[r[r\ jinja_envUszFlask.jinja_envcCs|jS)zThis attribute is set to ``True`` if the application started handling the first request. .. versionadded:: 0.8 )rrr[r[r\got_first_request_szFlask.got_first_request)instance_relativerRcCs:|j}|r|j}t|j}t|d<t|d<|||S)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 rmrn)rrdictdefault_configr$r# config_class)rrrdefaultsr[r[r\rhs    zFlask.make_configcCs<t|j\}}|dkr$tj|dStj|d|jdS)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)r.r{rrjoinr)rprefix package_pathr[r[r\ryszFlask.auto_find_instance_pathrb)resourcemoderRcCsttj|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)rrrr[r[r\open_instance_resources zFlask.open_instance_resourcecCs|jd}|dk r|S|jS)amReload 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. rvNrrr[r[r\templates_auto_reloads zFlask.templates_auto_reloadr]cCs||jd<dS)Nrvrrr^r[r[r\rscCsft|j}d|kr|j|d<d|kr.|j|d<|j|f|}|jjtt|j t t t dt j|jd<|S)aCreate the Jinja environment based on :attr:`jinja_options` and the various Jinja-related methods of the app. Changing :attr:`jinja_options` after this will have no effect. Also adds Flask-related globals and filters to the environment. .. versionchanged:: 0.11 ``Environment.auto_reload`` set in accordance with ``TEMPLATES_AUTO_RELOAD`` configuration option. .. versionadded:: 0.5 Z autoescape auto_reload)r(r%rr r!rzjson.dumps_function)rrhselect_jinja_autoescaperjinja_environmentglobalsupdater(r%rr r!rrdumpsZpolicies)roptionsrr[r[r\rs    zFlask.create_jinja_environmentcCst|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 r7rr[r[r\create_global_jinja_loaders z Flask.create_global_jinja_loader)filenamerRcCs|dkr 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)rrr[r[r\rszFlask.select_jinja_autoescape)contextrRcCsj|jd}tj}|dk r>tjD]}||jkrt||j|}q|}|D]}||qJ||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)Ztemplate_context_processorsrtopr rrcopyr)rrfuncsZreqctxbpZorig_ctxrQr[r[r\update_template_contexts   zFlask.update_template_contextcCs&|td}|jD]}||q|S)zReturns the shell context for an interactive shell for this application. This runs all the registered shell context processors. .. versionadded:: 0.11 )Zappr)rrr)rr processorr[r[r\make_shell_contexts  zFlask.make_shell_contextrmcCs |jdS)avWhether 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. rnrrr[r[r\rsz Flask.debugcCs||jd<|j|j_dS)Nrn)rrrrrr[r[r\r"s )rportr load_dotenvrrRc KsLtjddkr&ddlm}|dSt|rdtdtjkrRt|_ t |_ ndtjkrdt |_ |dk rvt ||_ |j d}d}} |r|d \}} } |s|r|}nd }|s|d krt|}n| rt| }nd }|d |j |d|j |ddt|j |j |jdd dlm} z| tt|||f|W5d|_XdS)a Runs the application on a local development server. Do not use ``run()`` in a production setting. It is not intended to meet security and performance requirements for a production server. Instead, see :doc:`/deploying/index` for WSGI server recommendations. If the :attr:`debug` flag is set the server will automatically reload for code changes and show a debugger in case an exception happened. If you want to run the application in debug mode, but disable the code execution on the interactive debugger, you can pass ``use_evalex=False`` as parameter. This will keep the debugger's traceback screen active, but disable code execution. It is not recommended to use this function for development with automatic reloading as this is badly supported. Instead you should be using the :command:`flask` command line script's ``run`` support. .. admonition:: Keep in Mind Flask will suppress any server error with a generic error page unless it is in debug mode. As such to enable just the interactive debugger without the code reloading, you have to invoke :meth:`run` with ``debug=True`` and ``use_reloader=False``. Setting ``use_debugger`` to ``True`` without being in debug mode won't catch any exceptions because there won't be any to catch. :param host: the hostname to listen on. Set this to ``'0.0.0.0'`` to have the server available externally as well. Defaults to ``'127.0.0.1'`` or the host in the ``SERVER_NAME`` config variable if present. :param port: the port of the webserver. Defaults to ``5000`` or the port defined in the ``SERVER_NAME`` config variable if present. :param debug: if given, enable or disable debug mode. See :attr:`debug`. :param load_dotenv: Load the nearest :file:`.env` and :file:`.flaskenv` files to set environment variables. Will also change the working directory to the directory containing the first file found. :param options: the options to be forwarded to the underlying Werkzeug server. See :func:`werkzeug.serving.run_simple` for more information. .. versionchanged:: 1.0 If installed, python-dotenv will be used to load environment variables from :file:`.env` and :file:`.flaskenv` files. If set, the :envvar:`FLASK_ENV` and :envvar:`FLASK_DEBUG` environment variables will override :attr:`env` and :attr:`debug`. Threaded mode is enabled by default. .. versionchanged:: 0.10 The default port is now picked from the ``SERVER_NAME`` variable. ZFLASK_RUN_FROM_CLItruer)explain_ignored_app_runNZ FLASK_ENVZ FLASK_DEBUGrq:z 127.0.0.1riZ use_reloaderZ use_debuggerZthreadedTF) run_simple)renvironget debughelpersrr&rrr$envr#rrr partitionint setdefaultZshow_server_bannerrZwerkzeug.servingrrtcaststr) rrrrrrr server_nameZsn_hostZsn_port_rr[r[r\run'sDC           z Flask.run) use_cookieskwargsrRcKs2|j}|dkrddlm}|||jfd|i|S)aCreates a test client for this application. For information about unit testing head over to :doc:`/testing`. Note that if you are testing for assertions or exceptions in your application code, you must set ``app.testing = True`` in order for the exceptions to propagate to the test client. Otherwise, the exception will be handled by the application (not visible to the test client) and the only indication of an AssertionError or other exception will be a 500 status code response to the test client. See the :attr:`testing` attribute. For example:: app.testing = True client = app.test_client() The test client can be used in a ``with`` block to defer the closing down of the context until the end of the ``with`` block. This is useful if you want to access the context locals for testing:: with app.test_client() as c: rv = c.get('/?vodka=42') assert request.args['vodka'] == '42' Additionally, you may pass optional keyword arguments that will then be passed to the application's :attr:`test_client_class` constructor. For example:: from flask.testing import FlaskClient class CustomClient(FlaskClient): def __init__(self, *args, **kwargs): self._authentication = kwargs.pop("authentication") super(CustomClient,self).__init__( *args, **kwargs) app.test_client_class = CustomClient client = app.test_client(authentication='Basic ....') See :class:`~flask.testing.FlaskClient` for more information. .. versionchanged:: 0.4 added support for ``with`` block usage for the client. .. versionadded:: 0.7 The `use_cookies` parameter was added as well as the ability to override the client to be used by setting the :attr:`test_client_class` attribute. .. versionchanged:: 0.11 Added `**kwargs` to support passing additional keyword arguments to the constructor of :attr:`test_client_class`. NrrJr)rwrrKresponse_class)rrrclsr[r[r\ test_clients3 zFlask.test_client)rrRcKs&|j}|dkrddlm}||f|S)a-Create a CLI runner for testing CLI commands. See :ref:`testing-cli`. Returns an instance of :attr:`test_cli_runner_class`, by default :class:`~flask.testing.FlaskCliRunner`. The Flask app object is passed as the first argument. .. versionadded:: 1.0 NrrL)rxrrM)rrrr[r[r\test_cli_runners  zFlask.test_cli_runnerrI) blueprintrrRcKs|||dS)axRegister a :class:`~flask.Blueprint` on the application. Keyword arguments passed to this method will override the defaults set on the blueprint. Calls the blueprint's :meth:`~flask.Blueprint.register` method after recording the blueprint in the application's :attr:`blueprints`. :param blueprint: The blueprint to register. :param url_prefix: Blueprint routes will be prefixed with this. :param subdomain: Blueprint routes will match on this subdomain. :param url_defaults: Blueprint routes will use these default values for view arguments. :param options: Additional keyword arguments are passed to :class:`~flask.blueprints.BlueprintSetupState`. They can be accessed in :meth:`~flask.Blueprint.record` callbacks. .. versionchanged:: 2.0.1 The ``name`` option can be used to change the (pre-dotted) name the blueprint is registered with. This allows the same blueprint to be registered multiple times with unique names for ``url_for``. .. versionadded:: 0.7 N)register)rrrr[r[r\register_blueprintszFlask.register_blueprintcCs |jS)zhIterates over all blueprints by the order they were registered. .. versionadded:: 0.11 )rvaluesrr[r[r\iter_blueprintsszFlask.iter_blueprints)rulerrprovide_automatic_optionsrrRc Ks|dkrt|}||d<|dd}|dkr'sz%Flask.add_url_rule..required_methodsr[rOPTIONSTFzDView function mapping is overwriting an existing endpoint function: )r,poprrWr TypeErrorsetaddurl_rule_classrrview_functionsrr) rrrrrrrrZold_funcr[r[r\rsD       zFlask.add_url_rule)rrRcsttdfdd }|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. frRcsj|d|SN)r)add_template_filterrrrr[r\ decoratorZsz(Flask.template_filter..decoratorr@rrrr[rr\template_filterJszFlask.template_filter)rrrRcCs||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)rfilters__name__rrrr[r[r\r`s zFlask.add_template_filtercsttdfdd }|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. rcsj|d|Sr)add_template_testrrr[r\rsz&Flask.template_test..decoratorrDrr[rr\ template_testlszFlask.template_testcCs||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)rtestsrrr[r[r\rs zFlask.add_template_testcsttdfdd }|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. rcsj|d|Sr)add_template_globalrrr[r\rsz(Flask.template_global..decoratorrBrr[rr\template_globalszFlask.template_globalcCs||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)rrrrr[r[r\rs zFlask.add_template_globalrcCs|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 )rappendrrr[r[r\before_first_requests zFlask.before_first_requestcCs|j||S)aRegisters 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 )rr r!r[r[r\teardown_appcontexts zFlask.teardown_appcontextcCs|j||S)zVRegisters a shell context processor function. .. versionadded:: 0.11 )rr r!r[r[r\shell_context_processors zFlask.shell_context_processor)erRc Csz|t|\}}|dfD]Z}ttjdgD]F}|j||}|sDq,|jD]&}||}|dk rJ|SqJq,qdS)a(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)Z_get_exc_class_and_codetyperr rZerror_handler_spec__mro__r) rr% exc_classcodecrZ handler_maprhandlerr[r[r\_find_error_handlers   zFlask._find_error_handlercCs@|jdkr|St|tr|S||}|dkr2|S|||S)acHandles 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)rWrr, ensure_syncrr%r+r[r[r\handle_http_exception s   zFlask.handle_http_exceptioncCsF|jdrdS|jd}|dkr4|jr4t|tr4dS|rBt|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. .. versionchanged:: 1.0 Bad request errors are not trapped by default in debug mode. .. versionadded:: 0.8 rtTrsNF)rrrWr r)rr%Ztrap_bad_requestr[r[r\trap_http_exception-s   zFlask.trap_http_exceptioncCs`t|tr |js|jdr d|_t|tr>||s>||S||}|dkrR| ||S)a>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 rsTN) rWr rrZshow_exceptionr r0r/r,r-r.r[r[r\handle_user_exceptionPs   zFlask.handle_user_exceptioncCspt}tj||d|jr.|d|kr*|||t|d}||}|dk rb|||}|j |ddS)aHandle an exception that did not have an error handler associated with it, or that was raised from an error handler. This always causes a 500 ``InternalServerError``. Always sends the :data:`got_request_exception` signal. If :attr:`propagate_exceptions` is ``True``, such as in debug mode, the error will be re-raised so that the debugger can display it. Otherwise, the original exception is logged, and an :exc:`~werkzeug.exceptions.InternalServerError` is returned. If an error handler is registered for ``InternalServerError`` or ``500``, it will be used. For consistency, the handler will always receive the ``InternalServerError``. The original unhandled exception is available as ``e.original_exception``. .. versionchanged:: 1.1.0 Always passes the ``InternalServerError`` instance to the handler, setting ``original_exception`` to the unhandled error. .. versionchanged:: 1.1.0 ``after_request`` functions and other finalization is done even for the default 500 response when there is no handler. .. versionadded:: 0.3 ) exceptionr)Zoriginal_exceptionNT)from_error_handler) rexc_infor3sendr log_exceptionr r,r-finalize_request)rr%r4 server_errorr+r[r[r\handle_exceptionps    zFlask.handle_exception)NNN)r4rRcCs&|jjdtjdtjd|ddS)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 [])r4N)rerrorr rmethod)rr4r[r[r\r6s zFlask.log_exceptionz te.NoReturn)r rRcCs:|jrt|jtr|jdkr"|jddlm}||dS)a.Exceptions that are recording during routing are reraised with this method. During debug we are not reraising redirect requests for non ``GET``, ``HEAD``, or ``OPTIONS`` requests and we're raising a different error instead to help debug situations. :internal: )rHEADrr)FormDataRoutingRedirectN)rrWrouting_exceptionrr<rr>)rr r>r[r[r\raise_routing_exceptions   zFlask.raise_routing_exceptioncCsZtjj}|jdk r|||j}t|ddr@|jdkr@|S| |j |j f|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`. NrFr) rrr r?r@Zurl_rulerr<make_default_options_responser-rr view_args)rreqrr[r[r\dispatch_requests    zFlask.dispatch_requestc Csf|z&t||}|dkr,|}Wn,tk rZ}z||}W5d}~XYnX||S)zDispatches the request and on top of that performs request pre and postprocessing as well as HTTP exception catching and error handling. .. versionadded:: 0.7 N)*try_trigger_before_first_request_functionsr5r5preprocess_requestrD Exceptionr1r7)rrr%r[r[r\full_dispatch_requests  zFlask.full_dispatch_request)rr3rRcCsR||}z||}tj||dWn&tk rL|s<|jdYnX|S)a)Given the return value from a view function this finalizes the request by converting it into a response and invoking the postprocessing functions. This is invoked for both normal request dispatching as well as error handlers. Because this means that it might be called as a result of a failure a special safe mode is available which can be enabled with the `from_error_handler` flag. If enabled, failures in response processing will be logged and otherwise ignored. :internal: )responsez?Request finalizing failed with an error while handling an error) make_responseprocess_responser4r5rGrr2)rrr3rIr[r[r\r7s   zFlask.finalize_requestc CsR|jr dS|j8|jr&W5QRdS|jD]}||q,d|_W5QRXdS)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)rrrr-rrQr[r[r\rE s z0Flask.try_trigger_before_first_request_functionscCs(tjj}|}|}|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 )rrZ url_adapterZallowed_methodsrZallowr)radapterrrr[r[r\rAs  z#Flask.make_default_options_response)r;rRcCsdS)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[)rr;r[r[r\should_ignore_error(szFlask.should_ignore_errorrPcCst|r||S|S)a)Ensure that the function is synchronous for WSGI workers. Plain ``def`` functions are returned as-is. ``async def`` functions are wrapped to run and wait for the response. Override this method to change how the app runs async views. .. versionadded:: 2.0 )rZ async_to_syncrLr[r[r\r-2s  zFlask.ensure_sync.cCsHzddlm}Wntk r,tdYnXtjdkr@td||S)a1Return a sync function that will run the coroutine function. .. code-block:: python result = app.async_to_sync(func)(*args, **kwargs) Override this method to change how the app converts async code to be synchronously callable. .. versionadded:: 2.0 r)rOzAInstall Flask with the 'async' extra in order to use async views.zwerkzeug.localzKAsync cannot be used with this combination of Python and Greenlet versions.)Z asgiref.syncrO ImportError RuntimeErrorr __module__)rrQZasgiref_async_to_syncr[r[r\rO@s  zFlask.async_to_sync)rrRc Csd}}t|trht|}|dkr.|\}}}n:|dkr`t|dttttfrV|\}}qh|\}}ntd|dkrtdtjdt||j s\t|t t t fr|j |||d}d}}nt|trt |}nt|tst|rFz|j |tj}WnLtk rB}z,t|d t|jd tdW5d}~XYnXntd t|jd tt|}|dk rt|t t t fr||_n||_|r|j||S) aConvert the return value from a view function to an instance of :attr:`response_class`. :param rv: the return value from the view function. The view function must return a response. Returning ``None``, or the view ending without returning, is not allowed. The following types are allowed for ``view_rv``: ``str`` A response object is created with the string encoded to UTF-8 as the body. ``bytes`` A response object is created with the bytes as the body. ``dict`` A dictionary that will be jsonify'd before being returned. ``tuple`` Either ``(body, status, headers)``, ``(body, status)``, or ``(body, headers)``, where ``body`` is any of the other types allowed here, ``status`` is a string or an integer, and ``headers`` is a dictionary or a list of ``(key, value)`` tuples. If ``body`` is a :attr:`response_class` instance, ``status`` overwrites the exiting value and ``headers`` are extended. :attr:`response_class` The object is returned unchanged. other :class:`~werkzeug.wrappers.Response` class The object is coerced to :attr:`response_class`. :func:`callable` The function is called as a WSGI application. The result is used to create a response object. .. versionchanged:: 0.9 Previously a tuple was interpreted as the arguments for the response object. NrNrzThe view function did not return a valid response tuple. The tuple must have the form (body, status, headers), (body, status), or (body, headers).zThe view function for zh did not return a valid response. The function either returned None or ended without a return statement.)statusheadersz The view function did not return a valid response. The return type must be a string, dict, tuple, Response instance, or WSGI callable, but it was a .zThe view function did not return a valid response. The return type must be a string, dict, tuple, Response instance, or WSGI callable, but it was a )rWtuplelenrrlistr r rrrbytes bytearrayr) BaseResponsecallableZ force_typerr&rwith_tracebackrr4rrrrT status_coderUr)rrrTrUZlen_rvr%r[r[r\rJ^sT+            zFlask.make_responsecCsp|dk r:|js|jjpd}nd}|jj|j|jd|dS|jddk rl|jj|jd|jd|jddSdS)a*Creates a URL adapter for the given request. The URL adapter is created at a point where the request context is not yet set up so the request is passed explicitly. .. versionadded:: 0.6 .. versionchanged:: 0.9 This can now also be called without a request object when the URL adapter is created for the application context. .. versionchanged:: 1.0 :data:`SERVER_NAME` no longer implicitly enables subdomain matching. Use :attr:`subdomain_matching` instead. Nrq)r subdomainrrru) script_nameZ url_scheme)rrZdefault_subdomainZbind_to_environrrbind)rr r`r[r[r\create_url_adapters zFlask.create_url_adapter)rrrRcs^jd}d|krFt|dd}tfdd|D}t||}|D]}|||qJdS)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 NrVrc3s|]}j|VqdSrS)url_default_functions)rrrr[r\ sz,Flask.inject_url_defaults..)rdr" rpartitionr from_iterable)rrrrZbpsZbp_funcsrQr[rr\inject_url_defaultss  zFlask.inject_url_defaults)r;rrrRc Csn|jD]L}z||||}Wn&tk r@}z|}W5d}~XYqX|dk r|Sq|tdkrf|dS)zQHandle :class:`~werkzeug.routing.BuildError` on :meth:`url_for`. Nr)rr rr4)rr;rrr+rr%r[r[r\handle_url_build_errors  zFlask.handle_url_build_errorcCs|jd}tjD]}||jkrt||j|}q|D]}|tjtjq4|jd}tjD]}||jkrXt||j|}qX|D] }||}|dk r||Sq|dS)aCalled 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)Zurl_value_preprocessorsr rrrrBZbefore_request_funcsr-)rrrrQrr[r[r\rF(s"        zFlask.preprocess_request)rIrRcCstj}|j}tjD]"}||jkrt|t|j|}qd|jkrTt|t|jd}|D]}|||}qX|j |j s|j ||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) rrZ_after_request_functionsr rZafter_request_funcsrreversedr-session_interfaceZis_null_sessionr!Z save_session)rrIctxrrr+r[r[r\rKGs    zFlask.process_response)excrRcCsv|tkrtd}t|jd}tjD]"}||jkr(t|t|j|}q(|D]}|||qPt j ||ddS)a2Called after the request is dispatched and the response is returned, right before the request context is popped. This calls all functions decorated with :meth:`teardown_request`, and :meth:`Blueprint.teardown_request` if a blueprint handled the request. Finally, the :data:`request_tearing_down` signal is sent. This is called by :meth:`RequestContext.pop() `, which may be delayed during testing to maintain access to resources. :param exc: An unhandled exception raised while dispatching the request. Detected from the current exception information if not passed. Passed to each teardown function. .. versionchanged:: 0.9 Added the ``exc`` argument. rNrm) r-rr4rjZteardown_request_funcsr rrr-r6r5)rrmrrrQr[r[r\do_teardown_requestas   zFlask.do_teardown_requestcCsD|tkrtd}t|jD]}|||qtj||ddS)aCalled right before the application context is popped. When handling a request, the application context is popped after the request context. See :meth:`do_teardown_request`. This calls all functions decorated with :meth:`teardown_appcontext`. Then the :data:`appcontext_tearing_down` signal is sent. This is called by :meth:`AppContext.pop() `. .. versionadded:: 0.9 rrnN)r-rr4rjrr-r2r5)rrmrQr[r[r\do_teardown_appcontexts  zFlask.do_teardown_appcontextcCst|S)aFCreate an :class:`~flask.ctx.AppContext`. Use as a ``with`` block to push the context, which will make :data:`current_app` point at this application. An application context is automatically pushed by :meth:`RequestContext.push() ` when handling a request, and when running a CLI command. Use this to manually create a context outside of these situations. :: with app.app_context(): init_db() See :doc:`/appcontext`. .. versionadded:: 0.9 rrr[r[r\ app_contextszFlask.app_context)rrRcCs t||S)a$Create a :class:`~flask.ctx.RequestContext` representing a WSGI environment. Use a ``with`` block to push the context, which will make :data:`request` point at this request. See :doc:`/reqcontext`. Typically you should not call this from your own code. A request context is automatically pushed by the :meth:`wsgi_app` when handling a request. Use :meth:`test_request_context` to create an environment and context instead of this method. :param environ: a WSGI environment r)rrr[r[r\request_contextszFlask.request_context)argsrrRcOs>ddlm}||f||}z||WS|XdS)aCreate a :class:`~flask.ctx.RequestContext` for a WSGI environment created from the given values. This is mostly useful during testing, where you may want to run a function that uses request data without dispatching a full request. See :doc:`/reqcontext`. Use a ``with`` block to push the context, which will make :data:`request` point at the request for the created environment. :: with test_request_context(...): generate_report() When using the shell, it may be easier to push and pop the context manually to avoid indentation. :: ctx = app.test_request_context(...) ctx.push() ... ctx.pop() Takes the same arguments as Werkzeug's :class:`~werkzeug.test.EnvironBuilder`, with some defaults from the application. See the linked Werkzeug docs for most of the available arguments. Flask-specific behavior is listed here. :param path: URL path being requested. :param base_url: Base URL where the app is being served, which ``path`` is relative to. If not given, built from :data:`PREFERRED_URL_SCHEME`, ``subdomain``, :data:`SERVER_NAME`, and :data:`APPLICATION_ROOT`. :param subdomain: Subdomain name to append to :data:`SERVER_NAME`. :param url_scheme: Scheme to use instead of :data:`PREFERRED_URL_SCHEME`. :param data: The request body, either as a string or a dict of form keys and values. :param json: If given, this is serialized as JSON and passed as ``data``. Also defaults ``content_type`` to ``application/json``. :param args: other positional arguments passed to :class:`~werkzeug.test.EnvironBuilder`. :param kwargs: other keyword arguments passed to :class:`~werkzeug.test.EnvironBuilder`. r)EnvironBuilderN)rrtcloserrZ get_environ)rrsrrtZbuilderr[r[r\test_request_contexts / zFlask.test_request_context)rstart_responserRc Cs||}d}zlz||}WnHtk rT}z|}||}W5d}~XYntd}YnX|||WS||rd}||XdS)aThe actual WSGI application. This is not implemented in :meth:`__call__` so that middlewares can be applied without losing a reference to the app object. Instead of doing this:: app = MyMiddleware(app) It's a better idea to do this instead:: app.wsgi_app = MyMiddleware(app.wsgi_app) Then you still have the original application object around and can continue to call methods on it. .. versionchanged:: 0.7 Teardown events for the request and app contexts are called even if an unhandled error occurs. Other events may not be called depending on when an error occurs during dispatch. See :ref:`callbacks-and-errors`. :param environ: A WSGI environment. :param start_response: A callable accepting a status code, a list of headers, and an optional exception context to start the response. Nr) rrrNZauto_poppushrHrGr9rr4)rrrwrlr;rIr%r[r[r\wsgi_apps     zFlask.wsgi_appcCs |||S)zThe WSGI server calls the Flask application object as the WSGI application. This calls :meth:`wsgi_app`, which can be wrapped to apply middleware. )ry)rrrwr[r[r\__call__#szFlask.__call__) NryNFFrzNFN)F)r)NNNT)T)NNN)N)N)N)N)N)N)F)rrR __qualname____doc__rHZ request_classrrr9rrZapp_ctx_globals_classrrrrZ secret_keyZsession_cookie_namer`Zpermanent_session_lifetimeZsend_file_max_age_defaultZuse_x_sendfiler JSONEncoderZ json_encoder JSONDecoderZ json_decoderrhr__annotations__rrrrr rrrwrOptionalTyperxr1rkrrrrr'rpropertyrrloggingLoggerrrrrrIOAnyStrrrsetterrr8rrrrrrrAnyrrrr0r ValuesViewrCallablerrArrrErrrCrrr;r"r>r#r$rGr<r,r Unionr=r/r0r1r9Tupler& BaseExceptionrr6r@rDrHr7rErArNr- CoroutinerOrJrrcrhrirFrKr-rorprrqrrrrvryrz __classcell__r[r[rr\rafs b     &      #   z: :      #$ 3      w *  $ 8+ra)jrXrTrrrtypingrrdatetimer itertoolsr threadingrtypesrZwerkzeug.datastructuresrrZwerkzeug.exceptionsrr r r Zwerkzeug.localr Zwerkzeug.routingr rrrrrZwerkzeug.wrappersrr\rrrrrrlrrrrrrr r!Zhelpersr"r#r$r%r&r'r(r)r+Zscaffoldr,r-r.r/r0sessionsr1Zsignalsr2r3r4r5r6Z templatingr8r9r:r;r<r=r>r?rArCrErFrGwrappersrH TYPE_CHECKINGZtyping_extensionsterrIrrKrM version_inforZrrrr`rar[r[r[r\s