B GFFb9@sddlZddlZddlZddlmZddlmZmZddlm Z m Z m Z m Z ej dkrdddlmZnddlZdd ZGd d d eZGd d d ZGdddZddZdS)N)_tracing)_Result _multicall)HookImpl _HookRelay _HookCallernormalize_hookimpl_opts))metadatacCs"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)PluginValidationErrorzplugin 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)r rrsrc@s6eZdZdZddZeddZd ddZd d ZdS) DistFacadez$Emulate a pkg_resources DistributioncCs ||_dS)N)_dist)rdistrrrr'szDistFacade.__init__cCs |jdS)Nname)r )rrrr project_name*szDistFacade.project_nameNcCst|j||S)N)getattrr')rattrdefaultrrr __getattr__.szDistFacade.__getattr__cCstt|jddgS)Nr'r*)sorteddirr')rrrr__dir__1szDistFacade.__dir__)N) r!r"r#r$rpropertyr*r.r1rrrrr&$s   r&c@seZdZdZddZddZd3ddZd d Zd4d d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd5d%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2ZdS)6 PluginManageraCore :py:class:`.PluginManager` class which manages registration of plugin objects and 1:N hook calling. You can register new hooks by calling :py:meth:`add_hookspecs(module_or_class) <.PluginManager.add_hookspecs>`. You can register plugin objects (which contain hooks) by calling :py:meth:`register(plugin) <.PluginManager.register>`. The :py:class:`.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 :py:meth:`.PluginManager.enable_tracing` which will subsequently send debug information to the trace helper. cCs:||_i|_i|_g|_td|_t|_ t |_ dS)NZ pluginmanage) r* _name2plugin_plugin2hookcallers_plugin_distinforZ TagTracergettracerhookr_inner_hookexec)rr*rrrrDszPluginManager.__init__cCs|||||S)N)r:)r hook_namemethodskwargs firstresultrrr _hookexecMszPluginManager._hookexecNc Cs"|p ||}||jks"||jkrL|j|ddkr8dStd|||jf||j|<g|j|<}xt|D]}|||}|dk rnt|t||}t ||||}|dp|}t|j |d}|dkrt ||j }t |j ||n |r|||||||||qnW|S)zRegister a plugin and return its canonical name or ``None`` if the name is blocked from registering. Raise a :py:class:`ValueError` if the plugin is already registered.Nz#Plugin already registered: %s=%s %sZspecname)get_canonical_namer4r5r7 ValueErrorr0parse_hookimpl_optsr r+rr9rr?setattrhas_spec _verify_hookZ_maybe_apply_history _add_hookimplappend) rrr) plugin_nameZ hookcallersZ hookimpl_optsmethodhookimplr9rrrregisterRs4        zPluginManager.registercCsbt||}t|sdSyt||jdd}Wntk rFi}YnX|dk r^t|ts^d}|S)NZ_impl)r+inspectZ isroutiner*r isinstancedict)rrr)rJZresrrrrCxs   z!PluginManager.parse_hookimpl_optscCsn|dkr"|dk std||}|dkr4||}|j|rH|j|=x |j|gD]}||qXW|S)zlunregister 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_pluginr4r7r5popZ_remove_plugin)rrr)Z hookcallerrrr unregisters   zPluginManager.unregistercCs|j|dd|j|<dS)zHblock registrations of the given name, unregister if already registered.)r)N)rTr4)rr)rrr set_blockeds zPluginManager.set_blockedcCs||jko|j|dkS)z4return ``True`` if the given plugin name is blocked.N)r4)rr)rrr is_blockedszPluginManager.is_blockedcCsg}xt|D]}|||}|dk rt|j|d}|dkr\t||j||}t|j||n*|||x|D]}| ||qrW| |qW|st d|j d|dS)zadd new hook specifications defined in the given ``module_or_class``. Functions are recognized if they have been decorated accordingly.Nzdid not find any z hooks in ) r0parse_hookspec_optsr+r9rr?rDZset_specification get_hookimplsrFrHrBr*)rmodule_or_classnamesr)Z spec_optshcZ hookfunctionrrr add_hookspecss  zPluginManager.add_hookspecscCst||}t||jddS)N_spec)r+r*)rrYr)rJrrrrWs z!PluginManager.parse_hookspec_optscCs t|jS)z%return the set of registered plugins.)setr5)rrrr get_pluginsszPluginManager.get_pluginscCs ||jkS)z4Return ``True`` if the plugin is already registered.)r5)rrrrr is_registeredszPluginManager.is_registeredcCst|ddptt|S)aVReturn canonical name for a plugin object. Note that a plugin may be registered under a different name which was specified by the caller of :py:meth:`register(plugin, name) <.PluginManager.register>`. To obtain the name of an registered plugin use :py:meth:`get_name(plugin) <.PluginManager.get_name>` instead.r!N)r+strid)rrrrrrAsz PluginManager.get_canonical_namecCs |j|S)z/Return a plugin or ``None`` for the given name.)r4r7)rr)rrrrRszPluginManager.get_plugincCs||dk S)z>Return ``True`` if a plugin with the given name is registered.N)rR)rr)rrr has_pluginszPluginManager.has_plugincCs(x"|jD]\}}||kr |Sq WdS)z@Return name for registered plugin or ``None`` if not registered.N)r4items)rrr)valrrrrQszPluginManager.get_namecCs|r&|jr&t|jd|j|jf|jjr>t|jj|j t |j t |jj }|rzt|jd|j|jt |j |f|jrt |j st|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 hookspeczsPlugin %r for hook %r hookimpl definition: %s Declared as hookwrapper=True but function is not a generator function)Z is_historicZ hookwrapperrrrIr)specZ warn_on_implrrr^Zargnames _formatdefrMZisgeneratorfunction)rr9rKZ notinspecrrrrFs* zPluginManager._verify_hookcCsdx^|jjD]R}|ddkr t|j|}|s x,|D] }|js8t|jd||jfq8Wq WdS)zVerify that all hooks which have not been verified against a hook specification are optional, otherwise raise :py:class:`.PluginValidationError`.r_zunknown hook %r in plugin %rN)r9__dict__r+rErXZ optionalhookrr)rr)r9rKrrr check_pendings  zPluginManager.check_pendingcCsd}xttD]~}xx|jD]n}|j|ks|dk r>|j|ks||js||jrXq|}|j ||jd|j |t |f|d7}qWqW|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. rN)r)r) listimportlib_metadataZ distributionsZ entry_pointsgroupr)rRrVloadrLr6rHr&)rrmr)countr(Zeprrrrload_setuptools_entrypoints s    z)PluginManager.load_setuptools_entrypointscCs t|jS)zTreturn list of distinfo/plugin tuples for all setuptools registered plugins.)rkr6)rrrrlist_plugin_distinfo%sz"PluginManager.list_plugin_distinfocCst|jS)z!return list of name/plugin pairs.)rkr4rd)rrrrlist_name_plugin*szPluginManager.list_name_plugincCs |j|S)z.get all hook callers for the specified plugin.)r5r7)rrrrrget_hookcallers.szPluginManager.get_hookcallerscs.jfdd}|_fdd}|S)aPadd 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:`pluggy._callers._Result` object which represents the result of the overall hook call. cs<tfdd}||S)NcsS)Nrr)r> hook_implsr;r=oldcallrrDzPPluginManager.add_hookcall_monitoring..traced_hookexec..)rZ from_call get_result)r;rtr=r>outcome)afterbeforeru)r>rtr;r=rtraced_hookexecAs  z>PluginManager.add_hookcall_monitoring..traced_hookexeccs _dS)N)r:r)rurrrundoKsz3PluginManager.add_hookcall_monitoring..undo)r:)rr{rzr|r}r)rzr{rurradd_hookcall_monitoring2s z%PluginManager.add_hookcall_monitoringcs2|jjdfdd}fdd}|||S)z9enable tracing of hook calls and return an undo function.r9csjjd7_||dS)Nr)rootindent)r;r<r=) hooktracerrr{Tsz,PluginManager.enable_tracing..beforecs0|jdkrd|d|jjd8_dS)NZfinishz-->r)excinforxrr)ryr;r<r=)rrrrzXs z+PluginManager.enable_tracing..after)r8rr7r~)rr{rzr)rrenable_tracingPs  zPluginManager.enable_tracingcst|j}fdd|D}|r~t|j|j|jj|jj}x<|D]0}|j }||krF| ||j |g |qFW|S|S)zReturn a new :py:class:`._hooks._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)r)rr dsz4PluginManager.subset_hook_caller..)r+r9rr)r?rf namespaceZoptsrXrrGr5 setdefaultrH)rr)Zremove_pluginsZorigZplugins_to_remover[rKrr)r)rsubset_hook_caller_s  z PluginManager.subset_hook_caller)N)NN)N)r!r"r#r$rr?rLrCrTrUrVr\rWr_r`rArRrcrQrFrjrprqrrrsr~rrrrrrr35s2   & # r3cCs|jt|S)N)r!rMZ signature)funcrrrrgtsrg)rMsysrrZ_callersrrZ_hooksrrrr version_info importlibr rlrrrr&r3rgrrrrs    A