B t\8@s|ddlZddlmZddlmZmZmZmZddlZddZ Gddde Z Gd d d e Z eed rpd d Zndd ZdS)N)_tracing)HookImpl _HookRelay _HookCallernormalize_hookimpl_optscCs"tj|t||jj|jjddS)N)linenofilename)warnings warn_explicittype__code__co_firstlineno co_filename)Zwarningfunctionr-lib/python3.7/site-packages/pluggy/manager.py_warn_for_functions rcs eZdZdZfddZZS)PluginValidationErrorz plugin failed validation. :param object plugin: the plugin which failed validation, may be a module or an arbitrary object. cs||_tt||dS)N)pluginsuper Exception__init__)selfrmessage) __class__rrrszPluginValidationError.__init__)__name__ __module__ __qualname____doc__r __classcell__rr)rrrsrc@seZdZdZd3ddZddZd4ddZd d Zd5d d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd6d%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2ZdS)7 PluginManagera Core Pluginmanager class which manages registration of plugin objects and 1:N hook calling. You can register new hooks by calling ``add_hookspec(module_or_class)``. You can register plugin objects (which contain hooks) by calling ``register(plugin)``. The Pluginmanager is initialized with a prefix that is searched for in the names of the dict of registered plugin objects. For debugging purposes you can call ``enable_tracing()`` which will subsequently send debug information to the trace helper. NcCsh||_i|_i|_g|_td|_t|jj d|_ |dk rTt j dt dd||_dd|_dS) zuIf ``implprefix`` is given implementation functions will be recognized if their name matches the implprefix. Z pluginmanagehookNzySupport for the `implprefix` arg is now deprecated and will be removed in an upcoming release. Please use HookimplMarker.) stacklevelcSs$|j|||jr|jjdnddS)N firstresultF)r%)Z multicallspecoptsget)r"methodskwargsrrr;sz(PluginManager.__init__..) project_name _name2plugin_plugin2hookcallers_plugin_distinforZ TagTracerr(Ztracerrootr"r warnDeprecationWarning _implprefix_inner_hookexec)rr,Z implprefixrrrr*szPluginManager.__init__cCs||||S)N)r4)rr"r)r*rrr _hookexecAszPluginManager._hookexecc Cs|p ||}||jks"||jkrL|j|ddkr8dStd|||jf||j|<g|j|<}xt|D]}|||}|dk rnt|t||}t ||||}t|j |d}|dkrt ||j }t |j ||n|r|||||||||qnW|S)z Register a plugin and return its canonical name or None if the name is blocked from registering. Raise a ValueError if the plugin is already registered. Nz#Plugin already registered: %s=%s %s)get_canonical_namer-r.r( ValueErrordirparse_hookimpl_optsrgetattrrr"rr5setattrhas_spec _verify_hookZ_maybe_apply_history _add_hookimplappend) rrname plugin_nameZ hookcallersZ hookimpl_optsmethodhookimplr"rrrregisterFs2       zPluginManager.registercCst||}t|sdSyt||jdd}Wntk rFi}YnX|dk r`t|ts`d}n,|dkr|jr||jrt t d|i}|S)NZ_implzhThe `implprefix` system is deprecated please decorate this function using an instance of HookimplMarker.) r;inspectZ isroutiner,r isinstancedictr3 startswithrr2)rrrArCZresrrrr:ks    z!PluginManager.parse_hookimpl_optscCsn|dkr"|dk std||}|dkr4||}|j|rH|j|=x |j|gD]}||qXW|S)zn unregister a plugin object and all its contained hook implementations from internal data structures. Nz+one of name or plugin needs to be specified)AssertionErrorget_name get_pluginr-r(r.popZ_remove_plugin)rrrAZ hookcallerrrr unregisters   zPluginManager.unregistercCs|j|dd|j|<dS)zJ block registrations of the given name, unregister if already registered. )rAN)rNr-)rrArrr set_blockeds zPluginManager.set_blockedcCs||jko|j|dkS)zA return True if the name blogs registering plugins of that name. N)r-)rrArrr is_blockedszPluginManager.is_blockedcCsg}xt|D]}|||}|dk rt|j|d}|dkr\t||j||}t|j||n*|||x|D]}| ||qrW| |qW|st d|j |fdS)z add new hook specifications defined in the given module_or_class. Functions are recognized if they have been decorated accordingly. Nzdid not find any %r hooks in %r) r9parse_hookspec_optsr;r"rr5r<Zset_specification get_hookimplsr>r@r8r,)rmodule_or_classnamesrAZ spec_optshcZ hookfunctionrrr add_hookspecss  zPluginManager.add_hookspecscCst||}t||jddS)N_spec)r;r,)rrSrArCrrrrQs z!PluginManager.parse_hookspec_optscCs t|jS)z' return the set of registered plugins. )setr.)rrrr get_pluginsszPluginManager.get_pluginscCs ||jkS)z2 Return True if the plugin is already registered. )r.)rrrrr is_registeredszPluginManager.is_registeredcCst|ddptt|S)a  Return canonical name for a plugin object. Note that a plugin may be registered under a different name which was specified by the caller of register(plugin, name). To obtain the name of an registered plugin use ``get_name(plugin)`` instead.rN)r;strid)rrrrrr7sz PluginManager.get_canonical_namecCs |j|S)z- Return a plugin or None for the given name. )r-r()rrArrrrLszPluginManager.get_plugincCs||dk S)z< Return True if a plugin with the given name is registered. N)rL)rrArrr has_pluginszPluginManager.has_plugincCs(x"|jD]\}}||kr |Sq WdS)z> Return name for registered plugin or None if not registered. N)r-items)rrrAvalrrrrKszPluginManager.get_namecCs~|r&|jr&t|jd|j|jf|jjr>t|jj|j t |j t |jj }|rzt|jd|j|jt |j |fdS)Nz6Plugin %r hook %r historic incompatible to hookwrapperz~Plugin %r for hook %r hookimpl definition: %s Argument(s) %s are declared in the hookimpl but can not be found in the hookspec) Z is_historicZ hookwrapperrrrBrAr&Z warn_on_implrrrXZargnames _formatdef)rr"rDZ notinspecrrrr>s zPluginManager._verify_hookcCsdx^|jjD]R}|ddkr t|j|}|s x,|D] }|js8t|jd||jfq8Wq WdS)z Verify that all hooks which have not been verified against a hook specification are optional, otherwise raise PluginValidationErrorr_zunknown hook %r in plugin %rN)r"__dict__r;r=rRZ optionalhookrr)rrAr"rDrrr check_pendings  zPluginManager.check_pendingc Csddlm}m}m}d}x|||dD]}||js&||jrDq&y |}WnL|k rfw&Yn8|k r} ztdd|j| fdWdd} ~ XYnX|j ||jd|j ||j f|d7}q&W|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: return the number of loaded plugins by this call. r)iter_entry_pointsDistributionNotFoundVersionConflict)rANz"Plugin %r could not be loaded: %s!)rrr) Z pkg_resourcesrdrerfrLrArPloadrrEr/r@Zdist) rgrouprArdrerfcountZeprerrrload_setuptools_entrypointss" $ z)PluginManager.load_setuptools_entrypointscCs t|jS)zV return list of distinfo/plugin tuples for all setuptools registered plugins. )listr/)rrrrlist_plugin_distinfosz"PluginManager.list_plugin_distinfocCst|jS)z# return list of name/plugin pairs. )rlr-r^)rrrrlist_name_plugin$szPluginManager.list_name_plugincCs |j|S)z0 get all hook callers for the specified plugin. )r.r()rrrrrget_hookcallers(szPluginManager.get_hookcallerscCst|||jS)aB add before/after tracing functions for all hooks and return an undo function which, when called, will remove 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 :py:class:`_Result`` object which represents the result of the overall hook call. )rZ_TracedHookExecutionZundo)rbeforeafterrrradd_hookcall_monitoring,s z%PluginManager.add_hookcall_monitoringcs,|jjfdd}fdd}|||S)z; enable tracing of hook calls and return an undo function. csjjd7_||dS)Nr)r0indent) hook_namer)r*) hooktracerrrp?sz,PluginManager.enable_tracing..beforecs0|jdkrd|d|jjd8_dS)NZfinishz-->r)excinfoZ get_resultr0rs)Zoutcomertr)r*)rurrrqCs z+PluginManager.enable_tracing..after)r"Z_tracerr)rrprqr)rurenable_tracing;s  zPluginManager.enable_tracingcst|j}fdd|D}|r~t|j|j|jj|jj}x<|D]0}|j }||krF| ||j |g |qFW|S|S)z Return a new _HookCaller instance for the named method which manages calls to all registered plugins except the ones from remove_plugins. csg|]}t|r|qSr)hasattr).0Zplug)rArr Osz4PluginManager.subset_hook_caller..)r;r"rrAr5r& namespacer'rRrr?r. setdefaultr@)rrAZremove_pluginsZorigZplugins_to_removerUrDrr)rArsubset_hook_callerJs  z PluginManager.subset_hook_caller)N)N)NN)N)rrrrrr5rEr:rNrOrPrVrQrYrZr7rLr]rKr>rcrkrmrnrorrrwr}rrrrr!s2   %  !r! signaturecCsd|jtt|fS)Nz%s%s)rr[rFr~)funcrrrr`asr`cCsd|jtjt|fS)Nz%s%s)rrFZ formatargspecZ getargspec)rrrrr`gs)rFrZhooksrrrrr rrrobjectr!rxr`rrrrs   E