U
|
ß=®d _ ã @ sV d dl mZ d dlZd dlZd dlmZ d dlmZ ddl mZ
|
ddl m Z ddl m Z dd l mZ dd
|
l mZ ejrdd lmZ ejd gejf Zejd e
|
jdZejde
|
jdZejde
|
jdZejde
|
j dZ ejde
|
j dZ ejde
|
j dZ!ejde
|
j"dZ#ejde
|
j$dZ%ejde
|
j&dZ'ejde
|
j(dZ)G dd d Z*G dd deZ+dS )é )Ú annotationsN)Ú defaultdict)Úupdate_wrapperé )Útyping)Ú_endpoint_from_view_func)Ú _sentinel)ÚScaffold)Ú setupmethod)ÚFlaskÚBlueprintSetupStateÚT_after_request)ÚboundÚT_before_requestÚT_error_handlerÚ
|
T_teardownÚ T_template_context_processorÚT_template_filterÚT_template_globalÚT_template_testÚT_url_defaultsÚT_url_value_preprocessorc @ s> e Zd ZdZdddddddd Zdd d d dddddZd
|
S )r zíTemporary 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.
|
Ú Blueprintr út.AnyÚboolÚNone)Ú blueprintÚappÚoptionsÚfirst_registrationÚreturnc C s¦ || _ || _|| _|| _| j d¡}|d kr4| jj}|| _| j d¡}|d krV| jj}|| _| j d|j¡| _| j dd¡| _t | jj
|
| _ | j | j dd¡¡ d S )NÚ subdomainÚ
|
url_prefixÚnameÚ name_prefixÚ Ú url_defaults© ) r r r r Úgetr! r" r# r$ ÚdictÚurl_values_defaultsr& Úupdate)Úselfr r r r r! r" r' r' úGd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\flask/blueprints.pyÚ__init__) s z BlueprintSetupState.__init__NÚstrú
|
str | Nonezt.Callable | None)ÚruleÚendpointÚ view_funcr r c K sª | j dk r2|r,d | j d¡| d¡f¡}n| j }| d| j¡ |dkrPt|}| j}d|krpt|f| d¡}| j
|
j || j d| j d| d¡|fd|i| dS )z³A 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ú/r! ÚdefaultsÚ.)r" ÚjoinÚrstripÚlstripÚ
|
setdefaultr! r r& r) Úpopr Ú add_url_ruler$ r# )r, r1 r2 r3 r r5 r' r' r- r< W s&
|
ýüûz BlueprintSetupState.add_url_rule)NN)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r. r< r' r' r' r- r " s
|
1 üc sø e Zd ZdZdZdddddddefddddddddddd
|
fd d
|
Zdd d d dZedd dddZ edd dddZ
|
dTdddddddZ ed d d d d d Z ddd d d!d"Z edUddd#d$d d d%d&d'ZedVdd(d)d*d+ZedWd,dd d-d.d/ZedXdd0d)d1d2ZedYd3dd d-d4d5ZedZdd6d)d7d8Zed[d9dd d-d:d;Zed<d<d=d>d?Zed@d@d=dAdBZedCdCd=dDdEZedFdFd=dGdHZedIdJdKdLdMZedNdNd=dOdPZedQdQd=dRdSZ Z S )\r aã 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 :doc:`/blueprints` for more information.
|
|
: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 set
|
this based on ``import_name``. In certain situations this
|
automatic detection can fail, so the path can be specified
|
manually instead.
|
|
.. 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
|
FNr/ zstr | os.PathLike | Noner0 z dict | None)
|
r# Ú import_nameÚ static_folderÚstatic_url_pathÚtemplate_folderr" r! r& Ú root_pathÚ cli_groupc sl t j||||| d |s"tdd|kr2td|| _|| _|| _g | _|d krVi }|| _|
|
| _g | _ d S )N)rA rB rC rD rE z'name' may not be empty.r6 z+'name' may not contain a dot '.' character.)
|
Úsuperr. Ú
|
ValueErrorr# r" r! Údeferred_functionsr* rF Ú _blueprints) r, r# rA rB rC rD r" r! r& rE rF ©Ú __class__r' r- r. ® s( ûzBlueprint.__init__r )Úf_namer c C s" | j r td| d| j dd S )NzThe setup method 'z,' can no longer be called on the blueprint 'zÐ'. It has already been registered at least once, any changes will not be applied consistently.
|
Make sure all imports, decorators, functions, etc. needed to set up the blueprint are done before registering it.)Ú_got_registered_onceÚAssertionErrorr# )r, rM r' r' r- Ú_check_setup_finishedÕ s ÿz Blueprint._check_setup_finishedz
|
t.Callable)Úfuncr c C s | j |¡ dS )záRegisters 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.
|
N)rI Úappend)r, rQ r' r' r- Úrecordß s zBlueprint.recordc s( ddd fdd }| t| ¡ dS )zýWorks 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.
|
r r ©Ústater c s | j r | d S ©N)r ©rU ©rQ r' r- Úwrapperð s z&Blueprint.record_once.<locals>.wrapperN)rS r )r, rQ rY r' rX r- Ú record_onceè s zBlueprint.record_oncer r) r r )r r r r c C s t | |||S )zãCreates 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 )r, r r r r' r' r- Úmake_setup_stateö s zBlueprint.make_setup_stater )r r r c K s$ || krt d| j ||f¡ dS )aß Register a :class:`~flask.Blueprint` on this blueprint. Keyword
|
arguments passed to this method will override the defaults set
|
on the blueprint.
|
|
.. 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:: 2.0
|
z%Cannot register a blueprint on itselfN)rH rJ rR )r, r r r' r' r- Úregister_blueprintÿ s z Blueprint.register_blueprint)r r r c sf | dd¡}| dj¡}| d| d¡ |jkr|j krJdnd}| krbd dnd}td | d
|
| d | d tfd d|j ¡ D } |jk}|j < d_ |||¡} j rè| j
|
j dj dd |sò|rÆ fdd}
|
j ¡ D ]H\} } | dkr n d| } ttdd | ¡ D } | |j | < qj ¡ D ]\} }||j| < q\|
|
j|j |
|
j|j |
|
j|j |
|
j|j |
|
j|j |
|
j|j jD ]}|| qÌ| dj¡}jjrJ|dkr|jj jj¡ n8|t kr4 j_|j j¡ n|j_|j j¡ j D ]\}}| ¡ }| d¡}| d¡}|dkr|j!}| j!dk r°|dk r°|d | j! |d< n*|dk rÄ||d< n| j!dk rÚ| j!|d< |dkrê|j"}| j"dk r |dk r | j" #d¡d | d¡ |d< n*|dk r4||d< n| j"dk rJ| j"|d< |d< | $||¡ qPdS ) a Called 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`.
|
|
.. versionchanged:: 2.3
|
Nested blueprints now correctly apply subdomains.
|
|
.. versionchanged:: 2.1
|
Registering the same blueprint with the same name multiple
|
times is an error.
|
|
.. versionchanged:: 2.0.1
|
Nested blueprints are registered with their dotted name.
|
This allows different blueprints with the same name to be
|
nested at different locations.
|
|
.. 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``.
|
r$ r% r# r6 Úthisz a differentz 'ú'z
|
The name 'z ' is already registered for z
|
blueprintz'. Use 'name=' to provide a unique name.c 3 s | ]}| kV qd S rV r' )Ú.0Zbp)r, r' r- Ú <genexpr>< s z%Blueprint.register.<locals>.<genexpr>Tz/<path:filename>Zstatic)r3 r2 c s> | ¡ D ]0\}}|d kr n d| }|| |¡ qd S )Nr6 )ÚitemsÚextend)Zbp_dictZ parent_dictÚkeyÚvalues©r# r' r- rb M s z"Blueprint.register.<locals>.extendNc S s$ i | ] \}}|d d | ¡ D qS )c S s i | ]\}}||qS r' r' )r_ Ú exc_classrQ r' r' r- Ú
|
<dictcomp>W s z1Blueprint.register.<locals>.<dictcomp>.<dictcomp>)ra )r_ ÚcodeZ code_valuesr' r' r- rg V s
|
ý ÿz&Blueprint.register.<locals>.<dictcomp>rF r" r! r4 )%r( r# r9 Z
|
blueprintsrH Úanyrd rN r[ Zhas_static_folderr< rC Zsend_static_fileZerror_handler_specra r r) Zview_functionsÚbefore_request_funcsÚafter_request_funcsÚteardown_request_funcsÚurl_default_functionsÚurl_value_preprocessorsÚtemplate_context_processorsrI rF ÚcliÚcommandsr+ r Z add_commandrJ Úcopyr! r" r8 Úregister)r, r r r$ Z self_nameZbp_descZ existing_atZfirst_bp_registrationZfirst_name_registrationrU rb rc Úvaluer2 rQ ÚdeferredZcli_resolved_groupr Z
|
bp_optionsZ bp_url_prefixZ bp_subdomainr' ©r# r, r- rs s
|
ÿ
|
|
|
ý
|
üþ þ
|
|
|
|
|
|
|
|
|
|
|
ÿ
|
|
|
zBlueprint.registerzft.RouteCallable | Nonez bool | None)r1 r2 r3 Úprovide_automatic_optionsr r c sR rd krt dr4tdr4djkr4t d| fdd¡ dS )a Register a URL rule with the blueprint. See :meth:`.Flask.add_url_rule` for
|
full documentation.
|
|
The URL rule is prefixed with the blueprint's URL prefix. The endpoint name,
|
used with :func:`url_for`, is prefixed with the blueprint's name.
|
r6 z/'endpoint' may not contain a dot '.' character.r= z5'view_func' name may not contain a dot '.' character.c s | j fdiS )Nrw )r< ©Ús©r2 r rw r1 r3 r' r- Ú<lambda>¯ s ýüûz(Blueprint.add_url_rule.<locals>.<lambda>N)rH Úhasattrr= rS )r, r1 r2 r3 rw r r' rz r- r< s ÿzBlueprint.add_url_rulez2t.Callable[[T_template_filter], T_template_filter])r# r c s ddd fdd }|S )a Register a template filter, available in any template rendered by the
|
application. Equivalent to :meth:`.Flask.template_filter`.
|
|
:param name: the optional name of the filter, otherwise the
|
function name will be used.
|
r ©Úfr c s j | d | S ©Nre )Úadd_app_template_filter©r~ rv r' r- Ú decoratorà s z0Blueprint.app_template_filter.<locals>.decoratorr' ©r, r# r r' rv r- Úapp_template_filter¸ s z Blueprint.app_template_filterzft.TemplateFilterCallable)r~ r# r c s$ ddd fdd }| |¡ dS )aI Register a template filter, available in any template rendered by the
|
application. Works like the :meth:`app_template_filter` decorator. Equivalent to
|
:meth:`.Flask.add_template_filter`.
|
|
:param name: the optional name of the filter, otherwise the
|
function name will be used.
|
r r rT c s | j jjp j< d S rV )r Ú jinja_envÚfiltersr= rW ©r~ r# r' r- Úregister_templateÕ s z<Blueprint.add_app_template_filter.<locals>.register_templateN©rZ ©r, r~ r# r r' r r- r É s z!Blueprint.add_app_template_filterz.t.Callable[[T_template_test], T_template_test]c s ddd fdd }|S )a! Register a template test, available in any template rendered by the
|
application. Equivalent to :meth:`.Flask.template_test`.
|
|
.. versionadded:: 0.10
|
|
:param name: the optional name of the test, otherwise the
|
function name will be used.
|
r r} c s j | d | S r )Úadd_app_template_testr rv r' r- r ç s z.Blueprint.app_template_test.<locals>.decoratorr' r r' rv r- Úapp_template_testÚ s zBlueprint.app_template_testzft.TemplateTestCallablec s$ ddd fdd }| |¡ dS )aa Register a template test, available in any template rendered by the
|
application. Works like the :meth:`app_template_test` decorator. Equivalent to
|
:meth:`.Flask.add_template_test`.
|
|
.. versionadded:: 0.10
|
|
:param name: the optional name of the test, otherwise the
|
function name will be used.
|
r r rT c s | j jjp j< d S rV )r r
Útestsr= rW r r' r- r û s z:Blueprint.add_app_template_test.<locals>.register_templateNr r r' r r- r í s z Blueprint.add_app_template_testz2t.Callable[[T_template_global], T_template_global]c s ddd fdd }|S )a' Register a template global, available in any template rendered by the
|
application. Equivalent to :meth:`.Flask.template_global`.
|
|
.. versionadded:: 0.10
|
|
:param name: the optional name of the global, otherwise the
|
function name will be used.
|
r r} c s j | d | S r )Úadd_app_template_globalr rv r' r- r s z0Blueprint.app_template_global.<locals>.decoratorr' r r' rv r- Úapp_template_global s z Blueprint.app_template_globalzft.TemplateGlobalCallablec s$ ddd fdd }| |¡ dS )ai Register a template global, available in any template rendered by the
|
application. Works like the :meth:`app_template_global` decorator. Equivalent to
|
:meth:`.Flask.add_template_global`.
|
|
.. versionadded:: 0.10
|
|
:param name: the optional name of the global, otherwise the
|
function name will be used.
|
r r rT c s | j jjp j< d S rV )r r
Úglobalsr= rW r r' r- r ! s z<Blueprint.add_app_template_global.<locals>.register_templateNr r r' r r- r s z!Blueprint.add_app_template_globalr r} c s | fdd¡ S )zLike :meth:`before_request`, but before every request, not only those handled
|
by the blueprint. Equivalent to :meth:`.Flask.before_request`.
|
c s | j j d g ¡ ¡S rV )r rj r: rR rx r r' r- r{ , ó z.Blueprint.before_app_request.<locals>.<lambda>r ©r, r~ r' r r- Úbefore_app_request& s
|
ÿz Blueprint.before_app_requestr c s | fdd¡ S )zLike :meth:`after_request`, but after every request, not only those handled
|
by the blueprint. Equivalent to :meth:`.Flask.after_request`.
|
c s | j j d g ¡ ¡S rV )r rk r: rR rx r r' r- r{ 6 r z-Blueprint.after_app_request.<locals>.<lambda>r r r' r r- Úafter_app_request0 s
|
ÿzBlueprint.after_app_requestr c s | fdd¡ S )z Like :meth:`teardown_request`, but after every request, not only those
|
handled by the blueprint. Equivalent to :meth:`.Flask.teardown_request`.
|
c s | j j d g ¡ ¡S rV )r rl r: rR rx r r' r- r{ @ r z0Blueprint.teardown_app_request.<locals>.<lambda>r r r' r r- Úteardown_app_request: s
|
ÿz Blueprint.teardown_app_requestr c s | fdd¡ S )z¥Like :meth:`context_processor`, but for templates rendered by every view, not
|
only by the blueprint. Equivalent to :meth:`.Flask.context_processor`.
|
c s | j j d g ¡ ¡S rV )r ro r: rR rx r r' r- r{ L r z1Blueprint.app_context_processor.<locals>.<lambda>r r r' r r- Úapp_context_processorD s
|
ÿz Blueprint.app_context_processorztype[Exception] | intz.t.Callable[[T_error_handler], T_error_handler])rh r c s ddd fdd }|S )zLike :meth:`errorhandler`, but for every request, not only those handled by
|
the blueprint. Equivalent to :meth:`.Flask.errorhandler`.
|
r r} c s fdd¡ S )Nc s | j ¡S rV )r Z errorhandlerrx )rh r~ r' r- r{ Y r z?Blueprint.app_errorhandler.<locals>.decorator.<locals>.<lambda>r r ©rh r, r r- r X s z-Blueprint.app_errorhandler.<locals>.decoratorr' )r, rh r r' r r- Úapp_errorhandlerP s zBlueprint.app_errorhandlerr c s | fdd¡ S )zªLike :meth:`url_value_preprocessor`, but for every request, not only those
|
handled by the blueprint. Equivalent to :meth:`.Flask.url_value_preprocessor`.
|
c s | j j d g ¡ ¡S rV )r rn r: rR rx r r' r- r{ f r z6Blueprint.app_url_value_preprocessor.<locals>.<lambda>r r r' r r- Úapp_url_value_preprocessor^ s
|
ÿz$Blueprint.app_url_value_preprocessorr c s | fdd¡ S )zLike :meth:`url_defaults`, but for every request, not only those handled by
|
the blueprint. Equivalent to :meth:`.Flask.url_defaults`.
|
c s | j j d g ¡ ¡S rV )r rm r: rR rx r r' r- r{ p r z,Blueprint.app_url_defaults.<locals>.<lambda>r r r' r r- Úapp_url_defaultsj s
|
ÿzBlueprint.app_url_defaults)F)NNN)N)N)N)N)N)N) r= r> r? r@ rN r r. rP r
|
rS rZ r[ r\ rs r< r r r r r r r r r r r r r Ú __classcell__r' r' rK r- r w sv 4õ&'
|
ÿ û ÿ ÿ ÿ ÿ ÿ ÿ r ),Ú
|
__future__r Úosr ÚtÚ collectionsr Ú functoolsr r% ÚftZscaffoldr r r r
|
Ú TYPE_CHECKINGr r ÚCallableZDeferredSetupFunctionÚTypeVarZAfterRequestCallabler ZBeforeRequestCallabler ZErrorHandlerCallabler ZTeardownCallabler Z TemplateContextProcessorCallabler ZTemplateFilterCallabler ZTemplateGlobalCallabler ZTemplateTestCallabler ZURLDefaultCallabler Z URLValuePreprocessorCallabler r r r' r' r' r- Ú<module> s< ÿ ÿU
|
