x s @r1 r5 r5 4 sG
r3 r5 c D e Zd ZdZddZedd Zddd Zdd
Zd S )
DistFacadez$Emulate a pkg_resources Distributiondist importlib_metadata.Distributionr# r$ c || _ d S r: )_dist)r= rF s r1 r< zDistFacade.__init__B s
r3 r8 c | j d }|S )Nnamer r= rK s r1 project_namezDistFacade.project_nameE s M&) r3 Nattrc . t | j || S r: )getattrrI )r= rN defaults r1 __getattr__zDistFacade.__getattr__J s tz4111r3 list[str]c N t t | j ddgz S )NrI rM )sorteddirrI r= s r1 __dir__zDistFacade.__dir__M s" c$*oo.(AABBBr3 )rF rG r# r$ )r# r8 r: )rN r8 )r# rS ) r? r@ rA rB r< propertyrM rR rX r3 r1 rE rE ? s .. X2 2 2 2 2C C C C C Cr3 rE c e Zd ZdZdBdZdCdZdDdEdZdFdZ dGdHdZdIdZ dJdZ
dKd Z dLd Z dMd"Z
dNd#ZdOd$ZdPd&ZdJd'ZdQd(ZdRd-ZdSd.ZdDdTd1ZdUd3ZdVd5ZdWd7ZdXd=ZdYd>ZdZdAZdS )[
PluginManagera Core class which manages registration of plugin objects and 1:N hook
calling.
You can register new hooks by calling :meth:`add_hookspecs(module_or_class)
`.
You can register plugin objects (which contain hook implementations) by
calling :meth:`register(plugin) `.
For debugging purposes you can call :meth:`PluginManager.enable_tracing`
which will subsequently send debug information to the trace helper.
rM r8 r# r$ c || _ i | _ g | _ t j d | _ t | _ t | _
d S )N pluginmanage) rM _name2plugin_plugin_distinfor TagTracergettracer hookr
_inner_hookexec)r= rM s r1 r< zPluginManager.__init___ sQ #/79IK $ . 0 0 4 4^ D D
%<< ) r3 hook_namemethodsSequence[HookImpl]kwargsMapping[str, object] firstresultboolobject | list[object]c 2 | |||| S r: re )r= rf rg ri rk s r1 _hookexeczPluginManager._hookexecg s ##Iw LLLr3 Nr6 r rK
str | Nonec R |p| | }|| j v r:| j |d dS t d|d|d| j || j v r t d|d|d| j || j |< t | D ]}| || }|t | t || }t |||| }| d p|}t | j
|d }|,t || j }t | j
|| n?| r+| || | | | | |S )a" Register a plugin and return its name.
If a name is not specified, a name is generated using
:func:`get_canonical_name`.
If the name is blocked from registering, returns ``None``.
If the plugin is already registered, raises a :class:`ValueError`.
Nz Plugin name already registered: =
z2Plugin already registered under a different name: specname)get_canonical_namer_ rb
ValueErrorvaluesrV parse_hookimpl_optsr rP r rd r rp setattrhas_spec _verify_hook_maybe_apply_history
_add_hookimpl)r= r6 rK plugin_name
hookimpl_optsmethodhookimplrd s r1 registerzPluginManager.registerr s =d 5 5f = = $+ + + $$["55=t * ;;(9(9;
T&--// / / * ;;(9(9;
*0+& KK - -D 4 4VT B BM ('
6664;FD4I4I#FK OO$((44<+249dD+I+I<&tT^<__T**F**622 2 )
2
2
))&1111 & & (###!$'
r3 c F | | d| j |< dS )zHBlock registrations of the given name, unregister if already registered.rK N)r r_ rL s r1 set_blockedzPluginManager.set_blocked s) T""""&$ r3 c 2 || j v o| j | du S )z0Return whether the given plugin name is blocked.N)r_ rL s r1
is_blockedzPluginManager.is_blocked s" t((LT->t-D-LLr3 module_or_classr c g }t | D ]}| || }|t | j |d }|.t || j || }t
| j || nC| || | D ]}| || |
| |st d| j d| dS )zAdd new hook specifications defined in the given ``module_or_class``.
Functions are recognized as hook specifications if they have been
decorated with a matching :class:`HookspecMarker`.
Nzdid not find any z
hooks in )
rV parse_hookspec_optsrP rd r rp r{ set_specification
get_hookimplsr} appendrx rM )r= r namesrK spec_optshc hookfunctions r1
add_hookspecszPluginManager.add_hookspecs s (( # #D 00 $GGI$)0D$)G)G:$T4>?IVVBDItR0000 (( )DDD(*(8(8(:(: < < ))"l;;;; T""" VD$5VV?VV
r3 _HookSpecOpts | Nonec X t || }t || j dz d }|S )N_spec)rP rM )r= r rK r optss r1 r z!PluginManager.parse_hookspec_opts s2 #?D99%,VT5F5PRV%W%W r3 set[Any]c N t | j S )z.Return a set of all registered plugin objects.)setr_ ry rW s r1 get_pluginszPluginManager.get_plugins s 4$++--...r3 c h t fd| j D S )z0Return whether the plugin is already registered.c 3 $ K | ]
}|k V d S r: rZ ).0valr6 s r1 z.PluginManager.is_registered.. s' GGS6S=GGGGGGr3 )anyr_ ry )r= r6 s `r1
is_registeredzPluginManager.is_registered s5 GGGGD,=,D,D,F,FGGGGGGr3 c ` t |dd }|pt t | S )a3 Return a canonical name for a plugin object.
Note that a plugin may be registered under a different name
specified by the caller of :meth:`register(plugin, name) `.
To obtain the name of n registered plugin use :meth:`get_name(plugin)
` instead.
r? N)rP r8 id)r= r6 rK s r1 rw z PluginManager.get_canonical_name s, #6:t<<&s2f::&r3
Any | Nonec 6 | j | S )z:Return the plugin registered under the given name, if any.)r_ rb rL s r1 r zPluginManager.get_plugin
s $$T***r3 c 0 | | duS )z:Return whether a plugin with the given name is registered.N)r rL s r1
has_pluginzPluginManager.has_plugin s t$$D00r3 c X | j D ]\ }}||k r|c S dS )zPReturn the name the plugin is registered under, or ``None`` if
is isn't.N)r_ items)r= r6 rK r s r1 r zPluginManager.get_name sB *0022 ID#}} tr3 rd r r r c 4 | r4|j s|j r&t |j d|j d|j d |j J |j j r t |j j |j
t |j t |j j z
}|r>t |j d|j d|j dt |j
d|d |j s|j rTt j |j
s;t |j d|j d|j dt |j
d |j rB|j r=t |j d|j d|j dt |j
d d S d S )
NzPlugin z
hook z5
historic incompatible with yield/wrapper/hookwrapperz
for hook z
hookimpl definition: z
Argument(s) zB are declared in the hookimpl but can not be found in the hookspeczV
Declared as wrapper=True or hookwrapper=True but function is not a generator functionzE
The wrapper=True and hookwrapper=True options are mutually exclusive) is_historic hookwrapperwrapperr5 r6 r rK spec warn_on_implr2 r! r argnames
_formatdefr isgeneratorfunction)r= rd r notinspecs r1 r} zPluginManager._verify_hook s 8#7 8;K ''''4
y$$$ 9 ! J ty 5x7H I I I )**S1C-D-DD '
(((III x 01111 II
( 4 -h.?@@ ( '''Jx?P4Q4Q4Q4QS
4 ' '''Jx?P4Q4Q4Q4QS
r3 c
| j j D ]u}|d dk rgt | j | }| s>| D ])}|j s t
|j d|d|j *vdS )zVerify that all hooks which have not been verified against a
hook specification are optional, otherwise raise
:class:`PluginValidationError`.r _z
unknown hook z in plugin N)rd __dict__rP r| r optionalhookr5 r6 )r= rK rd r s r1
check_pendingzPluginManager.check_pendingI s I&
DAw#~~$+DIt$<$<}} $($6$6$8$8 ' 4 "7 (#'44 !:# #
r3 groupintc d}t t j D ]}|j D ]}|j |k sA| |j |k s4| |j s| |j rO| }| ||j | j
|t | f |dz
}|S )a$ Load modules from querying the specified setuptools ``group``.
:param str group: Entry point group to load plugins.
:param str name: If given, loads only plugins with the given ``name``.
:rtype: int
:return: The number of plugins loaded by this call.
r Nr r )
listimportlib_metadata
distributions entry_pointsr rK r r loadr r` r rE )r= r rK countrF epr6 s r1 load_setuptools_entrypointsz)PluginManager.load_setuptools_entrypointsY s +9;;<<
D'
H%% (RW__rw// .= rw// .=
f27
333%,,fj6F6F-GHHH
r3 list[tuple[_Plugin, DistFacade]]c * t | j S )zXReturn a list of (plugin, distinfo) pairs for all
setuptools-registered plugins.)r r` rW s r1 list_plugin_distinfoz"PluginManager.list_plugin_distinfor s D)***r3 list[tuple[str, _Plugin]]c N t | j S )zAReturn a list of (name, plugin) pairs for all registered plugins.)r r_ r rW s r1 list_name_pluginz PluginManager.list_name_pluginw s D%++--...r3 list[_HookCaller] | Nonec | | dS g }| j j D ]7}| D ] }|j |u r| | !8|S )z.Get all hook callers for the specified plugin.N)r rd r ry r r6 r )r= r6 r r r s r1 r z PluginManager.get_hookcallers{ s == (4 ),3355 3 3J & 4 4 6 6
3
3?f,, &&z222
3 r3 before _BeforeTraceafter _AfterTraceCallable[[], None]c H j dfd }| _ d fd
}|S )a0 Add before/after tracing functions for all hooks.
Returns an undo function which, when called, removes the added tracers.
``before(hook_name, hook_impls, kwargs)`` will be called ahead
of all hook calls and receive a hookcaller instance, a list
of HookImpl instances and the keyword arguments for the hook call.
``after(outcome, hook_name, hook_impls, kwargs)`` receives the
same arguments as ``before`` but also a :class:`_Result` object
which represents the result of the overall hook call.
rf r8
hook_implsrh
caller_kwargsrj rk rl r# rm c t j fd } | | S )Nc S r: rZ )r rk r rf oldcalls r1 zPPluginManager.add_hookcall_monitoring..traced_hookexec.. s :}kRR r3 )r from_call
get_result)rf r r rk outcomer r r s ```` r1 traced_hookexecz>PluginManager.add_hookcall_monitoring..traced_hookexec sq
F9j- 8 8 8 'RRRRRRRR G
E'9j- @ @ @%%'' 'r3 r$ c _ d S r: ro )r r= s r1 undoz3PluginManager.add_hookcall_monitoring..undo s #*D r3 )
rf r8 r rh r rj rk rl r# rm r# r$ ro )r= r r r r r s ``` @r1 add_hookcall_monitoringz%PluginManager.add_hookcall_monitoring sl & ( ( ( ( ( ( ( ( / + + + + + + + r3 c | j j d dfd
}dfd
}| || S )zwEnable tracing of hook calls.
Returns an undo function which, when called, removes the added tracing.
rd rf r8 rg rh ri rj r# r$ c J j xj dz
c_ | | d S )Nr )rootindent)rf rg ri hooktraces r1 r z,PluginManager.enable_tracing..before s3
N ! !Q & ! ! Ii ( ( ( ( (r3 r _Result[object]c | j d|d| j xj dz c_ d S )Nfinishz-->r ) exceptionr r r )r rf rg ri r s r1 r z+PluginManager.enable_tracing..after sL ( (Iug6H6H6J6JKKK N ! !Q & ! ! ! !r3 )rf r8 rg rh ri rj r# r$ )
r r rf r8 rg rh ri rj r# r$ )rc r rb r )r= r r r s @r1 enable_tracingz PluginManager.enable_tracing sp
JO''// ) ) ) ) ) ) ' ' ' ' ' ' ++FE:::r3 remove_pluginsIterable[_Plugin]c r t | j }fd|D }|rt || S |S )zReturn a proxy :py:class:`._hooks._HookCaller` instance for the named
method which manages calls to all registered plugins except the ones
from remove_plugins.c 4 h | ]}t | |S rZ )hasattr)r plugrK s r1 z3PluginManager.subset_hook_caller.. s( T T Tdd@S@S TT T T Tr3 )rP rd r )r= rK r origplugins_to_removes ` r1 subset_hook_callerz PluginManager.subset_hook_caller sN $DIt 4 4 T T T Tn T T T >$T+<== = r3 )rM r8 r# r$ )
rf r8 rg rh ri rj rk rl r# rm r: )r6 r rK rq r# rq )r6 r rK r8 r# r )NN)r6 r rK rq r# r )rK r8 r# r$ )rK r8 r# rl )r r r# r$ )r r rK r8 r# r )r# r )r6 r r# rl )r6 r r# r8 )rK r8 r# r )r6 r r# rq )rd r r r r# r$ r )r r8 rK rq r# r )r# r )r# r )r6 r r# r )r r r r r# r )r# r )rK r8 r r r# r ) r? r@ rA rB r< rp r rz r r r r r r r rw r r r r} r r r r r r r r rZ r3 r1 r\ r\ Q s# * * * * M M M M. . . . .`
AE 8' ' ' '
M M M M 4 / / / /H H H H ' ' ' '+ + + +1 1 1 1 - - - -^ 2+ + + +
/ / / / # # # #J; ; ; ;2
r3 r\ r0 r8 c < | j t j | S r: )r? r signature)r0 s r1 r r s m 6W .t 4 4 6 66r3 )r r r! r" r# r$ )r0 r" r# r8 )/
__future__r r sysr( r* typingr r r r r r r
r _callersr
_hooksr r r r r r r r r _resultr version_info importlibr r typing_extensionsr r r r8 r r r2 r r5 rE r\ r rZ r3 r1 r s " " " " " "
% % % % % % % % % % % % + + + + + + v 8888888 5''''''44444444hx 0'#s(2CDdJK c8H+=wsCx?PQSWWX I C C C C C C C C$} } } } } } } }@ 7 7 7 7 7 7r3