U Ha0@sdZddlZddlZddlZddlmZmZGdddeZGdddeZ d d Z e ed rhd d Z ndd Z e edoej jdkZddZGdddeZGdddeZGdddeZGdddeZdS)zA Internal hook annotation, representation and calling machinery. N)_legacymulticall _multicallc@s"eZdZdZddZdddZdS) HookspecMarkera- Decorator helper class for marking functions as hook specifications. You can instantiate it with a project_name to get a decorator. Calling :py:meth:`.PluginManager.add_hookspecs` later will discover all marked functions if the :py:class:`.PluginManager` uses the same project_name. cCs ||_dSN project_nameselfrr 0/tmp/pip-unpacked-wheel-xuf3ljf8/pluggy/hooks.py__init__szHookspecMarker.__init__NFcs*fdd}|dk r"||S|SdS)al if passed a function, directly sets attributes on the function which will make it discoverable to :py:meth:`.PluginManager.add_hookspecs`. If passed no function, returns a decorator which can be applied to a function later using the attributes supplied. If ``firstresult`` is ``True`` the 1:N hook call (N being the number of registered hook implementation functions) will stop at I<=N when the I'th function returns a non-``None`` result. If ``historic`` is ``True`` calls to a hook will be memorized and replayed on later registered plugins. cs0rrtdt|jdtd|S)Nz'cannot have a historic firstresult hook_spec) firstresulthistoric warn_on_impl) ValueErrorsetattrrdictfuncrrr rr r setattr_hookspec_opts&s z6HookspecMarker.__call__..setattr_hookspec_optsNr )r functionrrrrr rr __call__szHookspecMarker.__call__)NFFN__name__ __module__ __qualname____doc__r rr r r r r src@s"eZdZdZddZdddZdS) HookimplMarkera* Decorator helper class for marking functions as hook implementations. You can instantiate with a ``project_name`` to get a decorator. Calling :py:meth:`.PluginManager.register` later will discover all marked functions if the :py:class:`.PluginManager` uses the same project_name. cCs ||_dSrrr r r r r BszHookimplMarker.__init__NFcs,fdd}|dkr |S||SdS)a if passed a function, directly sets attributes on the function which will make it discoverable to :py:meth:`.PluginManager.register`. If passed no function, returns a decorator which can be applied to a function later using the attributes supplied. If ``optionalhook`` is ``True`` a missing matching hook specification will not result in an error (by default it is an error if no matching spec is found). If ``tryfirst`` is ``True`` this hook implementation will run as early as possible in the chain of N hook implementations for a specification. If ``trylast`` is ``True`` this hook implementation will run as late as possible in the chain of N hook implementations. If ``hookwrapper`` is ``True`` the hook implementations needs to execute exactly one ``yield``. The code before the ``yield`` is run early before any non-hookwrapper function is run. The code after the ``yield`` is run after all non-hookwrapper function have run. The ``yield`` receives a :py:class:`.callers._Result` object representing the exception or result outcome of the inner calls (including other hookwrapper calls). c s"t|jdtd|S)N_impl) hookwrapper optionalhooktryfirsttrylast)rrrrr"r#r r$r%r r setattr_hookimpl_optses z6HookimplMarker.__call__..setattr_hookimpl_optsNr )r rr"r#r$r%r'r r&r rEs  zHookimplMarker.__call__)NFFFFrr r r r r :sr cCs4|dd|dd|dd|dddS)Nr$Fr%r"r#) setdefault)optsr r r normalize_hookimpl_optsxs   r*getfullargspeccCs t|Sr)inspectr+rr r r _getargspecsr-cCs t|Sr)r, getargspecrr r r r-spypy_version_infocCsrt|di}z |dWStk r*YnXt|rZz |j}Wqtk rVYdSXn2t|szt|d|}Wntk rYdSXz t|}Wnt k rYdSXt |j |j }}|rt | }|d|t ||d}}nd}tsdnd}|rBt|s6d t|d dkrB|d |krB|d d}z||f|d<Wnt k rhYnX||fS) zReturn tuple of positional and keywrord argument names for a function, method, class or callable. In case of a class, its ``__init__`` method is considered. For methods the ``self`` parameter is not included. __dict__Z _varnames)r r rNr r )r obj.rrr)getattrKeyErrorr,isclassr AttributeError isroutine Exceptionr- TypeErrortupleargsdefaultslen_PYPY3ismethod)rcachespecr=r>indexkwargsZimplicit_namesr r r varnamessJ            rFc@seZdZdZdS) _HookRelayzh hook holder object for performing 1:N hook calls where N is the number of registered plugins. N)rrrrr r r r rGsrGc@speZdZdddZddZddZdd Zd d Zd d ZddZ ddZ ddZ dddZ ddZ ddZdS) _HookCallerNcCsT||_g|_g|_||_d|_d|_t|_d|_|dk rP|dk sDt | ||dSr) name _wrappers _nonwrappers _hookexecargnames kwargnamesr multicallrCAssertionErrorset_specification)r rIZ hook_executespecmodule_or_class spec_optsr r r r s z_HookCaller.__init__cCs |jdk Sr)rCr2r r r has_specsz_HookCaller.has_speccCs0|r tt||j||_|dr,g|_dS)Nr)rTrPHookSpecrIrCget _call_history)r rRrSr r r rQs  z_HookCaller.set_specificationcCs t|dS)NrW)hasattrr2r r r is_historicsz_HookCaller.is_historiccs:fdd}||jdkr6||jdkr6tdfdS)Ncs,t|D]\}}|jkr||=dSqdS)NT) enumerateplugin)wrappersimethodr[r r removes z*_HookCaller._remove_plugin..removezplugin %r not found)rJrKr)r r[r`r r_r _remove_plugins z_HookCaller._remove_plugincCs |j|jSr)rKrJr2r r r get_hookimplssz_HookCaller.get_hookimplscCs|jr|j}n|j}|jr(|d|nJ|jr:||n8t|d}|dkrb||jrb|d8}qF||d|d|jkrt dt t |_ dS)z5Add an implementation to the callback chain. rr __multicall__zVSupport for __multicall__ is now deprecated and will beremoved in an upcoming release.N)r"rJrKr%insertr$appendr?rMwarningswarnDeprecationWarningrrO)r hookimplmethodsr]r r r _add_hookimpls"    z_HookCaller._add_hookimplcCs d|jfS)Nz<_HookCaller %r>)rIr2r r r __repr__ sz_HookCaller.__repr__cOsv|r td|rt|jrd|jjrdt|jjtdgt|}|rdtjd t |dd| || |S)Nz,hook calling supports only keyword argumentsrczTArgument(s) {} which are declared in the hookspec can not be found in this hook call) stacklevel) r;rYrPrCrMsetkeysrfrgformatr<rLrb)r r=rEZ notincallr r r rs  z_HookCaller.__call__cCsd|dk rtdt|}|j|p$i|f||||}|dkrJdS|pPgD] }||qRdS)a`Call the hook with given ``kwargs`` for all registered plugins and for all plugins which will be registered afterwards. If ``result_callback`` is not ``None`` it will be called for for each non-``None`` result obtained from a hook implementation. .. note:: The ``proc`` argument is now deprecated. NzXSupport for `proc` argument is now deprecated and will beremoved in an upcoming release.)rfrgrhrWrerLrb)r result_callbackrEprocresxr r r call_historic s  z_HookCaller.call_historicc Csft|jt|jf}|D]*}tdddd}tdd||}||qz|f|WS|\|_|_XdS)z Call the hook with some additional temporarily participating methods using the specified ``kwargs`` as call parameters. F)r"r%r$Nz)listrKrJrHookImplrk)r rjrEoldr^r)rir r r call_extra;s z_HookCaller.call_extracCsD|r@|jD]0\}}|||g|}|r|dk r||dqdS)zJApply call history to a new hookimpl if it is marked as historic. Nr)rYrWrL)r r^rErrrtr r r _maybe_apply_historyHs  z _HookCaller._maybe_apply_history)NN)NNN)rrrr rTrQrYrarbrkrlrrvrzr{r r r r rHs    rHc@seZdZddZddZdS)rxcCs:||_t|j\|_|_||_||_||_|j|dSr) rrFrMrNr[r) plugin_namer1update)r r[r|rZhook_impl_optsr r r r Ss zHookImpl.__init__cCsd|j|jfS)Nz$)r|r[r2r r r rl[szHookImpl.__repr__N)rrrr rlr r r r rxRsrxc@seZdZddZdS)rUcCsT||_t|||_}||_t|\|_|_||_dgt|j|_| d|_ dS)Nrcr) namespacer5rrIrFrMrNr)rwrVr)r r~rIr)rr r r r `szHookSpec.__init__N)rrrr r r r r rU_srU)rr,sysrfcallersrrobjectrr r*rXr- version_infomajorr@rFrGrHrxrUr r r r s"0>  4