_S@sodZddlmZddlmZddlmZeZGdddeZGdd d eZ d S) z flask.blueprints ~~~~~~~~~~~~~~~~ Blueprints are the recommended way to implement larger or more pluggable applications in Flask 0.7 and later. :copyright: 2010 Pallets :license: BSD-3-Clause )update_wrapper)_endpoint_from_view_func)_PackageBoundObjectc@s4eZdZdZddZddddZdS)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||_||_||_||_|jjd}|dkrN|jj}||_|jjd}|dkr|jj}||_t|jj|_ |j j |jjdfdS)N subdomain url_prefix url_defaults) app blueprintoptionsfirst_registrationgetrrdicturl_values_defaultsr update)selfr r r r rrr1/tmp/pip-build-5gj8f0j9/flask/flask/blueprints.py__init__s          zBlueprintSetupState.__init__NcKs|jdk rK|rBdj|jjd|jdf}n |j}|jd|j|dkrvt|}|j}d|krt||j d}|j j |d|j j |f|d||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)rjoinrstriplstrip setdefaultrrr rpopr add_url_ruler name)rruleendpoint view_funcr rrrrrAs -      z BlueprintSetupState.add_url_rule)__name__ __module__ __qualname____doc__rrrrrrrs  %rc @seZdZdZdZdZdZdZdZdZ dZ ddddddde ddZ ddZ dd Zdd d Zdd d ZddZddddZddZdddZdddZdddZdddZdddZdddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Z d.d/Z!d0d1Z"d2d3Z#d4d5Z$d6d7Z%d8d9Z&d:d;Z'd<d=Z(d>d?Z)dS)@ Blueprinta Represents a blueprint, a collection of routes and other app-related functions that can be registered on a real application later. A blueprint is an object that allows defining application functions without requiring an application object ahead of time. It uses the same decorators as :class:`~flask.Flask`, but defers the need for an application by recording them for later registration. Decorating a function with a blueprint creates a deferred function that is called with :class:`~flask.blueprints.BlueprintSetupState` when the blueprint is registered on an application. See :ref:`blueprints` for more information. .. versionchanged:: 1.1.0 Blueprints have a ``cli`` group to register nested CLI commands. The ``cli_group`` parameter controls the name of the group under the ``flask`` command. .. versionadded:: 0.7 :param name: The name of the blueprint. Will be prepended to each endpoint name. :param import_name: The name of the blueprint package, usually ``__name__``. This helps locate the ``root_path`` for the blueprint. :param static_folder: A folder with static files that should be served by the blueprint's static route. The path is relative to the blueprint's root path. Blueprint static files are disabled by default. :param static_url_path: The url to serve static files from. Defaults to ``static_folder``. If the blueprint does not have a ``url_prefix``, the app's static route will take precedence, and the blueprint's static files won't be accessible. :param template_folder: A folder with templates that should be added to the app's template search path. The path is relative to the blueprint's root path. Blueprint templates are disabled by default. Blueprint templates have a lower precedence than those in the app's templates folder. :param url_prefix: A path to prepend to all of the blueprint's URLs, to make them distinct from the rest of the app's routes. :param subdomain: A subdomain that blueprint routes will match on by default. :param url_defaults: A dict of default values that blueprint routes will receive by default. :param root_path: By default, the blueprint will automatically this based on ``import_name``. In certain situations this automatic detection can fail, so the path can be specified manually instead. FNc Cswtj|||d| ||_||_||_||_||_g|_|dkrai}||_| |_ dS)N root_path) rrrrr static_folderstatic_url_pathdeferred_functionsr cli_group) rr import_namer(r)template_folderrrr r'r+rrrrs         zBlueprint.__init__cCsF|jr2|jr2ddlm}|td|jj|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.rrrrecords  zBlueprint.recordcs(fdd}|jt|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)r4rrwrappers z&Blueprint.record_once..wrapper)r5r)rr4r7r)r4r record_onceszBlueprint.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 r r rrrmake_setup_stateszBlueprint.make_setup_statecCs d|_|j|||}|jrJ|j|jdd|jddx|jD]}||qTW|jd|j}|j j sdS|dkr|j j j |j j nP|t kr|j |j _ |j j|j n||j _ |j j|j dS)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/r!r Zstaticr+N)r/r9Zhas_static_folderrr)Zsend_static_filer*rr+clicommandsr _sentinelrZ add_command)rr r r r6deferredZcli_resolved_grouprrrregisters&        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/jd|j}j|||S)Nr )rr"r)fr )r rrrr decoratorsz"Blueprint.route..decoratorr)rrr r@r)r rrrrouteszBlueprint.routec strdkstdrNtdrNdjksNtd|jfdddS)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|jS)N)r)s)r r rr!rr&sz(Blueprint.add_url_rule..N)AssertionErrorhasattrr"r5)rrr r!r r)r r rr!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. cs&fdd}j|S)Ncs|jj.decorator..register_endpoint)r8)r?rG)r r)r?rr@0s 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)Nr)add_app_template_filter)r?)rrrrr@Asz0Blueprint.app_template_filter..decoratorr)rrr@r)rrrapp_template_filter9szBlueprint.app_template_filtercs&fdd}|j|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.register_templateN)r8)rr?rrLr)r?rrrHGs z!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)Nr)add_app_template_test)r?)rrrrr@_sz.Blueprint.app_template_test..decoratorr)rrr@r)rrrapp_template_testUs zBlueprint.app_template_testcs&fdd}|j|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.register_templateN)r8)rr?rrLr)r?rrrMes 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)Nr)add_app_template_global)r?)rrrrr@sz0Blueprint.app_template_global..decoratorr)rrr@r)rrrapp_template_globalus zBlueprint.app_template_globalcs&fdd}|j|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.register_templateN)r8)rr?rrLr)r?rrrPs z!Blueprint.add_app_template_globalcs jfddS)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"|jjjjgjS)N)r before_request_funcsrrr3)rC)r?rrrrDsz*Blueprint.before_request..)r8)rr?r)r?rrbefore_requestszBlueprint.before_requestcs|jfddS)zLike :meth:`Flask.before_request`. Such a function is executed before each request, even if outside of a blueprint. cs|jjjdgjS)N)r rSrr3)rC)r?rrrDsz.Blueprint.before_app_request..)r8)rr?r)r?rbefore_app_requestszBlueprint.before_app_requestcs|jfddS)zLike :meth:`Flask.before_first_request`. Such a function is executed before the first request to the application. cs|jjjS)N)r Zbefore_first_request_funcsr3)rC)r?rrrDsz4Blueprint.before_app_first_request..)r8)rr?r)r?rbefore_app_first_requestsz"Blueprint.before_app_first_requestcs jfddS)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"|jjjjgjS)N)r after_request_funcsrrr3)rC)r?rrrrDsz)Blueprint.after_request..)r8)rr?r)r?rr after_requestszBlueprint.after_requestcs|jfddS)zLike :meth:`Flask.after_request` but for a blueprint. Such a function is executed after each request, even if outside of the blueprint. cs|jjjdgjS)N)r rWrr3)rC)r?rrrDsz-Blueprint.after_app_request..)r8)rr?r)r?rafter_app_requestszBlueprint.after_app_requestcs jfddS)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"|jjjjgjS)N)r teardown_request_funcsrrr3)rC)r?rrrrDsz,Blueprint.teardown_request..)r8)rr?r)r?rrteardown_requestszBlueprint.teardown_requestcs|jfddS)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|jjjdgjS)N)r rZrr3)rC)r?rrrDsz0Blueprint.teardown_app_request..)r8)rr?r)r?rteardown_app_requestszBlueprint.teardown_app_requestcs jfddS)zLike :meth:`Flask.context_processor` but for a blueprint. This function is only executed for requests handled by a blueprint. cs"|jjjjgjS)N)r template_context_processorsrrr3)rC)r?rrrrDs z-Blueprint.context_processor..)r8)rr?r)r?rrcontext_processorszBlueprint.context_processorcs|jfddS)zLike :meth:`Flask.context_processor` but for a blueprint. Such a function is executed each request, even if outside of the blueprint. cs|jjjdgjS)N)r r]rr3)rC)r?rrrDsz1Blueprint.app_context_processor..)r8)rr?r)r?rapp_context_processorszBlueprint.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. cs jfddS)Ncs|jjS)N)r errorhandler)rC)coder?rrrDsz?Blueprint.app_errorhandler..decorator..)r8)r?)rar)r?rr@sz-Blueprint.app_errorhandler..decoratorr)rrar@r)rarrapp_errorhandlerszBlueprint.app_errorhandlercs jfddS)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"|jjjjgjS)N)r url_value_preprocessorsrrr3)rC)r?rrrrDsz2Blueprint.url_value_preprocessor..)r8)rr?r)r?rrurl_value_preprocessorsz Blueprint.url_value_preprocessorcs jfddS)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"|jjjjgjS)N)r url_default_functionsrrr3)rC)r?rrrrDsz(Blueprint.url_defaults..)r8)rr?r)r?rrr szBlueprint.url_defaultscs|jfddS)zESame as :meth:`url_value_preprocessor` but application wide. cs|jjjdgjS)N)r rcrr3)rC)r?rrrDsz6Blueprint.app_url_value_preprocessor..)r8)rr?r)r?rapp_url_value_preprocessor sz$Blueprint.app_url_value_preprocessorcs|jfddS)z;Same as :meth:`url_defaults` but application wide. cs|jjjdgjS)N)r rerr3)rC)r?rrrDsz,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. cs#jfddS)Ncs|jjjS)N)r _register_error_handlerr)rC)code_or_exceptionr?rrrrD)sz;Blueprint.errorhandler..decorator..)r8)r?)rir)r?rr@'sz)Blueprint.errorhandler..decoratorr)rrir@r)rirrr`s zBlueprint.errorhandlercs#jfdddS)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|jjjS)N)r rhr)rC)rir?rrrrD8sz2Blueprint.register_error_handler..N)r8)rrir?r)rir?rrregister_error_handler/sz Blueprint.register_error_handler)*r"r#r$r%r0r/Z json_encoderZ json_decoderr,r-r'r<rr5r8r9r>rArr rIrHrNrMrQrPrTrUrVrXrYr[r\r^r_rbrdr rfrgr`rjrrrrr&ZsZ 3  '      r&N) r% functoolsrhelpersrrobjectr<rr&rrrr s  E