B ;=[G@sPdZddlmZddlmZddlmZmZGdddeZ Gdd d eZ d S) u flask.blueprints ~~~~~~~~~~~~~~~~ Blueprints are the recommended way to implement larger or more pluggable applications in Flask 0.7 and later. :copyright: © 2010 by the Pallets team. :license: BSD, see LICENSE for more details. )update_wrapper)url_join)_PackageBoundObject_endpoint_from_view_funcc@s"eZdZdZddZdddZdS)BlueprintSetupStatezTemporary holder object for registering a blueprint with the application. An instance of this class is created by the :meth:`~flask.Blueprint.make_setup_state` method and later passed to all register callback functions. cCs||_||_||_||_|jd}|dkr4|jj}||_|jd}|dkrV|jj}||_t|jj|_ |j |jdddS)N subdomain url_prefix url_defaults) app blueprintoptionsfirst_registrationgetrr dicturl_values_defaultsr update)selfr r rrrr r r /lib/python3.7/site-packages/flask/blueprints.py__init__s  zBlueprintSetupState.__init__NcKs|jdk r2|r,d|jd|df}n|j}|d|j|dkrPt|}|j}d|krpt|f| d}|j j |d|j j |f|fd|i|dS)zA helper method to register a rule (and optionally a view function) to the application. The endpoint is automatically prefixed with the blueprint's name. N/rdefaultsz%s.%s)r joinrstriplstrip setdefaultrrr rpopr add_url_ruler name)rruleendpoint view_funcrrr r rr>s z BlueprintSetupState.add_url_rule)NN)__name__ __module__ __qualname____doc__rrr r r rrs%rc@s0eZdZdZdZdZdZdZdZdZ dZ d@ddZ ddZ dd Z dAd d ZdBd d ZddZdCddZddZdDddZdEddZdFddZdGddZdHddZdIddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Z d0d1Z!d2d3Z"d4d5Z#d6d7Z$d8d9Z%d:d;Z&dd?Z(dS)J Blueprinta6Represents a blueprint. A blueprint is an object that records functions that will be called with the :class:`~flask.blueprints.BlueprintSetupState` later to register functions or other things on the main application. See :ref:`blueprints` for more information. .. versionadded:: 0.7 FNc CsLtj|||| d||_||_||_||_||_g|_|dkrBi}||_dS)N) root_path) rrrr r static_folderstatic_url_pathdeferred_functionsr) rr import_namer)r*template_folderr rr r(r r rrvs zBlueprint.__init__cCs4|jr$|jr$ddlm}|td|j|dS)zRegisters a function that is called when the blueprint is registered on the application. This function is called with the state as argument as returned by the :meth:`make_setup_state` method. r)warnzgThe blueprint was already registered once but is getting modified now. These changes will not show up.N)_got_registered_oncewarn_on_modificationswarningsr.Warningr+append)rfuncr.r r rrecords   zBlueprint.recordcsfdd}|t|S)zWorks like :meth:`record` but wraps the function in another function that will ensure the function is only called once. If the blueprint is registered a second time on the application, the function passed is not called. cs|jr|dS)N)r)state)r4r rwrappersz&Blueprint.record_once..wrapper)r5r)rr4r7r )r4r record_onces zBlueprint.record_oncecCst||||S)zCreates an instance of :meth:`~flask.blueprints.BlueprintSetupState` object that is later passed to the register callback functions. Subclasses can override this to return a subclass of the setup state. )r)rr rrr r rmake_setup_stateszBlueprint.make_setup_statecCsNd|_||||}|jr2|j|jd|jddx|jD] }||q:WdS)a4Called by :meth:`Flask.register_blueprint` to register all views and callbacks registered on the blueprint with the application. Creates a :class:`.BlueprintSetupState` and calls each :meth:`record` callback with it. :param app: The application this blueprint is being registered with. :param options: Keyword arguments forwarded from :meth:`~Flask.register_blueprint`. :param first_registration: Whether this is the first time this blueprint has been registered on the application. Tz/Zstatic)r"r!N)r/r9Zhas_static_folderrr*Zsend_static_filer+)rr rrr6Zdeferredr r rregisters   zBlueprint.registerc sfdd}|S)zLike :meth:`Flask.route` but for a blueprint. The endpoint for the :func:`url_for` function is prefixed with the name of the blueprint. cs$d|j}j||f|S)Nr!)rr#r)fr!)rr rr r decoratorsz"Blueprint.route..decoratorr )rr rr<r )rr rrrouteszBlueprint.routec sPrdkstdr4tdr4djks4td|fdddS)zLike :meth:`Flask.add_url_rule` but for a blueprint. The endpoint for the :func:`url_for` function is prefixed with the name of the blueprint. .z+Blueprint endpoints should not contain dotsr#z4Blueprint view function name should not contain dotscs|jfS)N)r)s)r!rr r"r rsz(Blueprint.add_url_rule..N)AssertionErrorhasattrr#r5)rr r!r"rr )r!rr r"rrs zBlueprint.add_url_rulecsfdd}|S)a\Like :meth:`Flask.endpoint` but for a blueprint. This does not prefix the endpoint with the blueprint name, this has to be done explicitly by the user of this method. If the endpoint is prefixed with a `.` it will be registered to the current blueprint, otherwise it's an application independent endpoint. csfdd}|S)Ncs|jj<dS)N)r Zview_functions)r6)r!r;r rregister_endpointsz@Blueprint.endpoint..decorator..register_endpoint)r8)r;rC)r!r)r;rr<s z%Blueprint.endpoint..decoratorr )rr!r<r )r!rrr!szBlueprint.endpointcsfdd}|S)zRegister a custom template filter, available application wide. Like :meth:`Flask.template_filter` but for a blueprint. :param name: the optional name of the filter, otherwise the function name will be used. csj|d|S)N)r)add_app_template_filter)r;)rrr rr<sz0Blueprint.app_template_filter..decoratorr )rrr<r )rrrapp_template_filterszBlueprint.app_template_filtercsfdd}||dS)aIRegister a custom template filter, available application wide. Like :meth:`Flask.add_template_filter` but for a blueprint. Works exactly like the :meth:`app_template_filter` decorator. :param name: the optional name of the filter, otherwise the function name will be used. cs|jjjpj<dS)N)r jinja_envfiltersr#)r6)r;rr rregister_templatesz.register_templateN)r8)rr;rrHr )r;rrrDsz!Blueprint.add_app_template_filtercsfdd}|S)aRegister a custom template test, available application wide. Like :meth:`Flask.template_test` but for a blueprint. .. versionadded:: 0.10 :param name: the optional name of the test, otherwise the function name will be used. csj|d|S)N)r)add_app_template_test)r;)rrr rr<sz.Blueprint.app_template_test..decoratorr )rrr<r )rrrapp_template_tests zBlueprint.app_template_testcsfdd}||dS)aaRegister a custom template test, available application wide. Like :meth:`Flask.add_template_test` but for a blueprint. Works exactly like the :meth:`app_template_test` decorator. .. versionadded:: 0.10 :param name: the optional name of the test, otherwise the function name will be used. cs|jjjpj<dS)N)r rFZtestsr#)r6)r;rr rrHsz:Blueprint.add_app_template_test..register_templateN)r8)rr;rrHr )r;rrrIs zBlueprint.add_app_template_testcsfdd}|S)aRegister a custom template global, available application wide. Like :meth:`Flask.template_global` but for a blueprint. .. versionadded:: 0.10 :param name: the optional name of the global, otherwise the function name will be used. csj|d|S)N)r)add_app_template_global)r;)rrr rr<sz0Blueprint.app_template_global..decoratorr )rrr<r )rrrapp_template_globals zBlueprint.app_template_globalcsfdd}||dS)aiRegister a custom template global, available application wide. Like :meth:`Flask.add_template_global` but for a blueprint. Works exactly like the :meth:`app_template_global` decorator. .. versionadded:: 0.10 :param name: the optional name of the global, otherwise the function name will be used. cs|jjjpj<dS)N)r rFglobalsr#)r6)r;rr rrH,sz.register_templateN)r8)rr;rrHr )r;rrrK"s z!Blueprint.add_app_template_globalcsfddS)zLike :meth:`Flask.before_request` but for a blueprint. This function is only executed before each request that is handled by a function of that blueprint. cs|jjjgS)N)r before_request_funcsrrr3)r?)r;rr rr@5sz*Blueprint.before_request..)r8)rr;r )r;rrbefore_request0szBlueprint.before_requestcs|fddS)zLike :meth:`Flask.before_request`. Such a function is executed before each request, even if outside of a blueprint. cs|jjdgS)N)r rNrr3)r?)r;r rr@=sz.Blueprint.before_app_request..)r8)rr;r )r;rbefore_app_request9szBlueprint.before_app_requestcs|fddS)zLike :meth:`Flask.before_first_request`. Such a function is executed before the first request to the application. cs|jjS)N)r Zbefore_first_request_funcsr3)r?)r;r rr@Esz4Blueprint.before_app_first_request..)r8)rr;r )r;rbefore_app_first_requestAsz"Blueprint.before_app_first_requestcsfddS)zLike :meth:`Flask.after_request` but for a blueprint. This function is only executed after each request that is handled by a function of that blueprint. cs|jjjgS)N)r after_request_funcsrrr3)r?)r;rr rr@Msz)Blueprint.after_request..)r8)rr;r )r;rr after_requestHszBlueprint.after_requestcs|fddS)zLike :meth:`Flask.after_request` but for a blueprint. Such a function is executed after each request, even if outside of the blueprint. cs|jjdgS)N)r rRrr3)r?)r;r rr@Usz-Blueprint.after_app_request..)r8)rr;r )r;rafter_app_requestQszBlueprint.after_app_requestcsfddS)a=Like :meth:`Flask.teardown_request` but for a blueprint. This function is only executed when tearing down requests handled by a function of that blueprint. Teardown request functions are executed when the request context is popped, even when no actual request was performed. cs|jjjgS)N)r teardown_request_funcsrrr3)r?)r;rr rr@`sz,Blueprint.teardown_request..)r8)rr;r )r;rrteardown_requestYszBlueprint.teardown_requestcs|fddS)zLike :meth:`Flask.teardown_request` but for a blueprint. Such a function is executed when tearing down each request, even if outside of the blueprint. cs|jjdgS)N)r rUrr3)r?)r;r rr@isz0Blueprint.teardown_app_request..)r8)rr;r )r;rteardown_app_requestdszBlueprint.teardown_app_requestcsfddS)zLike :meth:`Flask.context_processor` but for a blueprint. This function is only executed for requests handled by a blueprint. cs|jjjgS)N)r template_context_processorsrrr3)r?)r;rr rr@qsz-Blueprint.context_processor..)r8)rr;r )r;rrcontext_processormszBlueprint.context_processorcs|fddS)zLike :meth:`Flask.context_processor` but for a blueprint. Such a function is executed each request, even if outside of the blueprint. cs|jjdgS)N)r rXrr3)r?)r;r rr@ysz1Blueprint.app_context_processor..)r8)rr;r )r;rapp_context_processoruszBlueprint.app_context_processorcsfdd}|S)zLike :meth:`Flask.errorhandler` but for a blueprint. This handler is used for all requests, even if outside of the blueprint. csfddS)Ncs|jS)N)r errorhandler)r?)coder;r rr@sz?Blueprint.app_errorhandler..decorator..)r8)r;)r\r)r;rr<sz-Blueprint.app_errorhandler..decoratorr )rr\r<r )r\rrapp_errorhandler}szBlueprint.app_errorhandlercsfddS)zRegisters a function as URL value preprocessor for this blueprint. It's called before the view functions are called and can modify the url values provided. cs|jjjgS)N)r url_value_preprocessorsrrr3)r?)r;rr rr@sz2Blueprint.url_value_preprocessor..)r8)rr;r )r;rrurl_value_preprocessorsz Blueprint.url_value_preprocessorcsfddS)zCallback function for URL defaults for this blueprint. It's called with the endpoint and values and should update the values passed in place. cs|jjjgS)N)r url_default_functionsrrr3)r?)r;rr rr@sz(Blueprint.url_defaults..)r8)rr;r )r;rrr szBlueprint.url_defaultscs|fddS)zESame as :meth:`url_value_preprocessor` but application wide. cs|jjdgS)N)r r^rr3)r?)r;r rr@sz6Blueprint.app_url_value_preprocessor..)r8)rr;r )r;rapp_url_value_preprocessorsz$Blueprint.app_url_value_preprocessorcs|fddS)z;Same as :meth:`url_defaults` but application wide. cs|jjdgS)N)r r`rr3)r?)r;r rr@sz,Blueprint.app_url_defaults..)r8)rr;r )r;rapp_url_defaultsszBlueprint.app_url_defaultscsfdd}|S)a Registers an error handler that becomes active for this blueprint only. Please be aware that routing does not happen local to a blueprint so an error handler for 404 usually is not handled by a blueprint unless it is caused inside a view function. Another special case is the 500 internal server error which is always looked up from the application. Otherwise works as the :meth:`~flask.Flask.errorhandler` decorator of the :class:`~flask.Flask` object. csfddS)Ncs|jjS)N)r _register_error_handlerr)r?)code_or_exceptionr;rr rr@sz;Blueprint.errorhandler..decorator..)r8)r;)rdr)r;rr<sz)Blueprint.errorhandler..decoratorr )rrdr<r )rdrrr[s zBlueprint.errorhandlercsfdddS)a1Non-decorator version of the :meth:`errorhandler` error attach function, akin to the :meth:`~flask.Flask.register_error_handler` application-wide function of the :class:`~flask.Flask` object but for error handlers limited to this blueprint. .. versionadded:: 0.11 cs|jjS)N)r rcr)r?)rdr;rr rr@sz2Blueprint.register_error_handler..N)r8)rrdr;r )rdr;rrregister_error_handlersz Blueprint.register_error_handler)NNNNNNN)F)F)NN)N)N)N)N)N)N))r#r$r%r&r0r/Z json_encoderZ json_decoderr,r-r(rr5r8r9r:r=rr!rErDrJrIrLrKrOrPrQrSrTrVrWrYrZr]r_r rarbr[rer r r rr'SsR                r'N) r& functoolsrZ werkzeug.urlsrZhelpersrrobjectrr'r r r r s   A