HEX

File: //home/arjun/projects/env/lib/python3.10/site-packages/pluggy/__pycache__/_hooks.cpython-310.pyc
o

weE]�@sbdZddlmZddlZddlZddlZddlmZddlm	Z	ddlm
Z
ddlmZddlmZdd	lm
Z
dd
lmZddlmZddlmZdd
lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZed�Zededefd�ZeeefZeZ ee!edee!efe"geeeeffZ#edeeedeedfffZ$Gdd�de�Z%Gdd�de�Z&e
Gd d!�d!��Z'e
Gd"d#�d#��Z(d8d'd(�Z)e*ed)�Z+d9d-d.�Z,e
Gd/d0�d0��Z-e-Z.eeee!efeee
gdffZ/Gd1d2�d2�Z0e0Z1Gd3d4�d4e0�Z2e
Gd5d�d��Z3e
Gd6d7�d7��Z4dS):zA
Internal hook annotation, representation and calling machinery.
�)�annotationsN)�
ModuleType)�AbstractSet)�Any)�Callable)�Final)�final)�	Generator)�List)�Mapping)�Optional)�overload)�Sequence)�Tuple)�
TYPE_CHECKING)�	TypedDict)�TypeVar)�Union�)�Result�_T�_F.)�bound�HookImplc@s*eZdZUdZded<ded<ded<dS)�HookspecOptsz!Options for a hook specification.�bool�firstresult�historic�Warning | None�warn_on_implN��__name__�
__module__�__qualname__�__doc__�__annotations__�r&r&�F/home/arjun/projects/env/lib/python3.10/site-packages/pluggy/_hooks.pyr)s

rc@sBeZdZUdZded<ded<ded<ded<ded<ded	<d
S)�HookimplOptsz"Options for a hook implementation.r�wrapper�hookwrapper�optionalhook�tryfirst�trylast�
str | None�specnameNr r&r&r&r'r(4s
r(c@s`eZdZdZdZddd�Ze					
dddd��Ze				dddd��Z	
					
dd dd�Zd
S)!�HookspecMarkeraDecorator for marking functions as hook specifications.

    Instantiate it with a project_name to get a decorator.
    Calling :meth:`PluginManager.add_hookspecs` later will discover all marked
    functions if the :class:`PluginManager` uses the same project name.
    ��project_namer2�str�return�NonecC�
||_dS�Nr1��selfr2r&r&r'�__init__T�
zHookspecMarker.__init__FN�functionrrrrrrcC�dSr7r&�r9r<rrrr&r&r'�__call__W�zHookspecMarker.__call__.�Callable[[_F], _F]cCr=r7r&r>r&r&r'r?ar@�	_F | None�_F | Callable[[_F], _F]cs(d����fdd�}|dur||�S|S)apIf passed a function, directly sets attributes on the function
        which will make it discoverable to :meth:`PluginManager.add_hookspecs`.

        If passed no function, returns a decorator which can be applied to a
        function later using the attributes supplied.

        :param firstresult:
            If ``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. See :ref:`firstresult`.

        :param historic:
            If ``True``, every call to the hook will be memorized and replayed
            on plugins registered after the call was made. See :ref:`historic`.

        :param warn_on_impl:
            If given, every implementation of this hook will trigger the given
            warning. See :ref:`warn_on_impl`.
        �funcrr4cs2�r�rtd�����d�}t|�jd|�|S)Nz'cannot have a historic firstresult hook)rrr�_spec)�
ValueError�setattrr2�rD�opts�rrr9rr&r'�setattr_hookspec_opts�s�z6HookspecMarker.__call__.<locals>.setattr_hookspec_optsN�rDrr4rr&)r9r<rrrrKr&rJr'r?ks�r2r3r4r5)FFN)
r<rrrrrrrr4r)....)
r<r5rrrrrrr4rA)NFFN)
r<rBrrrrrrr4rC�r!r"r#r$�	__slots__r:r
r?r&r&r&r'r0Is(
�	��r0c@sreZdZdZdZddd�Ze												dddd��Ze														d d!dd��Z							d"d#dd�ZdS)$�HookimplMarkeraDecorator for marking functions as hook implementations.

    Instantiate it with a ``project_name`` to get a decorator.
    Calling :meth:`PluginManager.register` later will discover all marked
    functions if the :class:`PluginManager` uses the same project name.
    r1r2r3r4r5cCr6r7r1r8r&r&r'r:�r;zHookimplMarker.__init__.r<rr*rr+r,r-r/r.r)cCr=r7r&�r9r<r*r+r,r-r/r)r&r&r'r?��zHookimplMarker.__call__rAcCr=r7r&rQr&r&r'r?�rRNFrBrCc	s.d�������fdd�}|dur|S||�S)a
If passed a function, directly sets attributes on the function
        which will make it discoverable to :meth:`PluginManager.register`.

        If passed no function, returns a decorator which can be applied to a
        function later using the attributes supplied.

        :param optionalhook:
            If ``True``, a missing matching hook specification will not result
            in an error (by default it is an error if no matching spec is
            found). See :ref:`optionalhook`.

        :param tryfirst:
            If ``True``, this hook implementation will run as early as possible
            in the chain of N hook implementations for a specification. See
            :ref:`callorder`.

        :param trylast:
            If ``True``, this hook implementation will run as late as possible
            in the chain of N hook implementations for a specification. See
            :ref:`callorder`.

        :param wrapper:
            If ``True`` ("new-style hook wrapper"), the hook implementation
            needs to execute exactly one ``yield``. The code before the
            ``yield`` is run early before any non-hook-wrapper function is run.
            The code after the ``yield`` is run after all non-hook-wrapper
            functions have run. The ``yield`` receives the result value of the
            inner calls, or raises the exception of inner calls (including
            earlier hook wrapper calls). The return value of the function
            becomes the return value of the hook, and a raised exception becomes
            the exception of the hook. See :ref:`hookwrapper`.

        :param hookwrapper:
            If ``True`` ("old-style hook wrapper"), the hook implementation
            needs to execute exactly one ``yield``. The code before the
            ``yield`` is run early before any non-hook-wrapper function is run.
            The code after the ``yield`` is run after all non-hook-wrapper
            function have run  The ``yield`` receives a :class:`Result` object
            representing the exception or result outcome of the inner calls
            (including earlier hook wrapper calls). This option is mutually
            exclusive with ``wrapper``. See :ref:`old_style_hookwrapper`.

        :param specname:
            If provided, the given name will be used instead of the function
            name when matching this hook implementation to a hook specification
            during registration. See :ref:`specname`.

        .. versionadded:: 1.2.0
            The ``wrapper`` parameter.
        rDrr4cs(������d�}t|�jd|�|S)N)r)r*r+r,r-r/�_impl)rGr2rH�r*r+r9r/r,r-r)r&r'�setattr_hookimpl_opts�s�z6HookimplMarker.__call__.<locals>.setattr_hookimpl_optsNrLr&)	r9r<r*r+r,r-r/r)rUr&rTr'r?�s=rM)......)r<rr*rr+rr,rr-rr/r.r)rr4r).......)r<r5r*rr+rr,rr-rr/r.r)rr4rA)NFFFFNF)r<rBr*rr+rr,rr-rr/r.r)rr4rCrNr&r&r&r'rP�s:
���rPrIr4r5cCsL|�dd�|�dd�|�dd�|�dd�|�dd�|�dd�dS)Nr,Fr-r)r*r+r/)�
setdefault)rIr&r&r'�normalize_hookimpl_optssrW�pypy_version_inforD�object�'tuple[tuple[str, ...], tuple[str, ...]]c	sZt�|�rz|j}Wn"tyYdSwt�|�s-zt|d|�}Wn
ty,YdSwzt�t�|�r8|j	n|�}Wn
t
yFYdSwtjjtjj
f��fdd�|j��D�}t|�}tdd�|��D��pkd}|r�t|�}|d|�t||d��}}nd}ts�d	}nd
}|r�t|dd�}t�|�s�d
|vr�|d|vr�|dd�}||fS)z�Return 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.
    )r&r&r?cs i|]\}}|j�vr||�qSr&)�kind)�.0�name�param��_valid_param_kindsr&r'�
<dictcomp>8s

�zvarnames.<locals>.<dictcomp>css"�|]}|j|jur|jVqdSr7)�default�empty)r\r^r&r&r'�	<genexpr>?s���zvarnames.<locals>.<genexpr>Nr&�r9)r9�objr#��.rr)�inspect�isclassr:�AttributeError�	isroutine�getattr�	Exception�	signature�ismethod�__func__�	TypeError�	Parameter�POSITIONAL_ONLY�POSITIONAL_OR_KEYWORD�
parameters�items�tuple�values�len�_PYPY)	rD�sig�
_valid_params�args�defaults�index�kwargs�implicit_names�qualnamer&r_r'�varnamessV

�
����
���	
 r�c@s0eZdZdZdZd
dd�Zerdd
d�ZdSdS)�	HookRelayzaHook holder object for performing 1:N hook calls where N is the number
    of registered plugins.)�__dict__r4r5cCsdS��:meta private:Nr&rer&r&r'r:bszHookRelay.__init__r]r3�
HookCallercCr=r7r&)r9r]r&r&r'�__getattr__gszHookRelay.__getattr__N)r4r5)r]r3r4r�)r!r"r#r$rOr:rr�r&r&r&r'r�[s
�r�c@s�eZdZdZdZ		d:d;dd�Zd<dd�Zd=dd�Zd<dd�Zd>dd�Z	d?dd�Z
d@d"d#�ZdAd$d%�ZdBd(d)�Z
dCd,d-�Z		d:dDd1d2�ZdEd5d6�ZdFd8d9�ZdS)Gr�zCA caller of all registered implementations of a hook specification.)r]�spec�	_hookexec�
_hookimpls�
_call_historyNr]r3�hook_execute�	_HookExec�specmodule_or_class�_Namespace | None�	spec_opts�HookspecOpts | Noner4r5cCsF||_||_g|_d|_d|_|dur!|dusJ�|�||�dSdSr�)r]r�r�r�r��set_specification)r9r]r�r�r�r&r&r'r:}s	�zHookCaller.__init__rcCs
|jduSr7)r�rer&r&r'�has_spec�r;zHookCaller.has_spec�
_NamespacercCsN|jdurtd|jj�d|jj����t||j|�|_|�d�r%g|_dSdS)NzHook z( is already registered within namespace r)r�rFr]�	namespace�HookSpec�getr�)r9r�r�r&r&r'r��s
��

�zHookCaller.set_specificationcCs
|jduS)z2Whether this caller is :ref:`historic <historic>`.N)r�rer&r&r'�is_historic��
zHookCaller.is_historic�plugin�_PlugincCs<t|j�D]\}}|j|kr|j|=dSqtd|�d���)Nzplugin z
 not found)�	enumerater�r�rF)r9r��i�methodr&r&r'�_remove_plugin�s
�zHookCaller._remove_plugin�list[HookImpl]cCs
|j��S)z6Get all registered hook implementations for this hook.)r��copyrer&r&r'�
get_hookimpls�r�zHookCaller.get_hookimpls�hookimplrcCs�t|j�D]\}}|js|jr|}nqt|j�}|js|jr(|t|j�}}nd|}}|jr9|j�||�dS|jrE|j�||�dS|d}||kra|j|jra|d8}||kra|j|jsS|j�|d|�dS)z,Add an implementation to the callback chain.rrN)r�r�r*r)rzr-�insertr,)r9r�r�r��
splitpoint�start�endr&r&r'�
_add_hookimpl�s$�

�zHookCaller._add_hookimplcC�d|j�d�S)Nz<HookCaller �>�r]rer&r&r'�__repr__��zHookCaller.__repr__r��Mapping[str, object]csZ|jr)|jjD]#}|�vr(d��fdd�|jjD��}tjd�|�dd�dSqdSdS)Nz, c3s$�|]
}|���vrt|�VqdSr7)�keys�repr)r\�argname�r�r&r'rd�s���z;HookCaller._verify_all_args_are_provided.<locals>.<genexpr>zSArgument(s) {} which are declared in the hookspec cannot be found in this hook call�)�
stacklevel)r��argnames�join�warnings�warn�format)r9r�r��	notincallr&r�r'�_verify_all_args_are_provided�s����z(HookCaller._verify_all_args_are_providedrYrcKsH|��rJd��|�|�|jr|jj�dd�nd}|�|j|j||�S)z�Call the hook.

        Only accepts keyword arguments, which should match the hook
        specification.

        Returns the result(s) of calling all registered plugins, see
        :ref:`calling`.
        �ACannot directly call a historic hook - use call_historic instead.rF)r�r�r�rIr�r�r]r�)r9r�rr&r&r'r?�s
��
zHookCaller.__call__�result_callback�Callable[[Any], None] | None�Mapping[str, object] | NonecCst|jdusJ�|p
i}|�|�|j�||f�|�|j|j|d�}|dur(dSt|t�r6|D]}||�q/dSdS)a<Call the hook with given ``kwargs`` for all registered plugins and
        for all plugins which will be registered afterwards, see
        :ref:`historic`.

        :param result_callback:
            If provided, will be called for each non-``None`` result obtained
            from a hook implementation.
        NF)r�r��appendr�r]r��
isinstance�list)r9r�r��res�xr&r&r'�
call_historic�s



�zHookCaller.call_historic�methods�Sequence[Callable[..., object]]c	Cs�|��rJd��|�|�ddddddd�}|j��}|D]A}tdd||�}t|�d}|dkrV||jrV||jsV||jsV|d8}|dkrV||jrV||jsV||jr?|�	|d|�q|j
rj|j
j�dd�nd}|�
|j|||�S)	z�Call the hook with some additional temporarily participating
        methods using the specified ``kwargs`` as call parameters, see
        :ref:`call_extra`.r�FN)r)r*r+r-r,r/z<temp>rrr)r�r�r�r�rrzr,r*r)r�r�rIr�r�r])	r9r�r�rI�	hookimplsr�r�r�rr&r&r'�
call_extra	sD��
�
�������zHookCaller.call_extrar�cCsh|��r0|jdusJ�|jD]#\}}|�|j|g|d�}|r/|dur/t|t�s)J�||d�qdSdS)zAApply call history to a new hookimpl if it is marked as historic.NFr)r�r�r�r]r�r�)r9r�r�r�r�r&r&r'�_maybe_apply_history*s��zHookCaller._maybe_apply_history)NN)
r]r3r�r�r�r�r�r�r4r5)r4r)r�r�r�rr4r5)r�r�r4r5�r4r�)r�rr4r5�r4r3)r�r�r4r5)r�rYr4r)r�r�r�r�r4r5)r�r�r�r�r4r)r�rr4r5)r!r"r#r$rOr:r�r�r�r�r�r�r�r�r?r�r�r�r&r&r&r'r�rs(�








�
!r�c@sReZdZdZdZdd	d
�Zeddd
��Zeddd��Zeddd��Z	ddd�Z
dS)�_SubsetHookCallerztA proxy to another HookCaller which manages calls to all registered
    plugins except the ones from remove_plugins.)�_orig�_remove_plugins�origr��remove_plugins�AbstractSet[_Plugin]r4r5cCs ||_||_|j|_|j|_dSr7)r�r�r]r�)r9r�r�r&r&r'r:Msz_SubsetHookCaller.__init__r�cs�fdd��jjD�S)Ncsg|]
}|j�jvr|�qSr&)r�r�)r\�implrer&r'�
<listcomp>Us
�z0_SubsetHookCaller._hookimpls.<locals>.<listcomp>)r�r�rer&rer'r�Ss
�z_SubsetHookCaller._hookimpls�HookSpec | NonecC�|jjSr7)r�r�rer&r&r'r�[�z_SubsetHookCaller.spec�_CallHistory | NonecCr�r7)r�r�rer&r&r'r�_r�z_SubsetHookCaller._call_historyr3cCr�)Nz<_SubsetHookCaller r�r�rer&r&r'r�cr�z_SubsetHookCaller.__repr__N)r�r�r�r�r4r5r�)r4r�)r4r�r�)r!r"r#r$rOr:�propertyr�r�r�r�r&r&r&r'r�:s
r�c@s(eZdZdZdZdd
d�Zddd�ZdS)rz/A hook implementation in a :class:`HookCaller`.)r<r��
kwargnamesr�rI�plugin_namer)r*r+r,r-r�r�r�r3r<�_HookImplFunction[object]�hook_impl_optsr(r4r5cCsh||_t|j�\}}||_||_||_||_||_|d|_|d|_|d|_	|d|_
|d|_dS)r�r)r*r+r,r-N)r<r�r�r�r�rIr�r)r*r+r,r-)r9r�r�r<r�r�r�r&r&r'r:ys	



zHookImpl.__init__cCsd|j�d|j�d�S)Nz<HookImpl plugin_name=z	, plugin=r�)r�r�rer&r&r'r��szHookImpl.__repr__N)
r�r�r�r3r<r�r�r(r4r5r�)r!r"r#r$rOr:r�r&r&r&r'rgs

$c@seZdZdZd
d
d�ZdS)r�)r�r<r]r�r�rIrr�r�r]r3rIrr4r5cCs@||_t||�|_||_t|j�\|_|_||_|�d�|_	dS)Nr)
r�rmr<r]r�r�r�rIr�r)r9r�r]rIr&r&r'r:�szHookSpec.__init__N)r�r�r]r3rIrr4r5)r!r"r#rOr:r&r&r&r'r��s
r�)rIr(r4r5)rDrYr4rZ)5r$�
__future__rri�sysr��typesr�typingrrrrrr	r
rrr
rrrrrr�_resultrrrYr�typer�r�r3rr��_HookImplFunctionrr(r0rPrW�hasattrr{r�r��
_HookRelay�_CallHistoryr��_HookCallerr�rr�r&r&r&r'�<module>sl��"M
v
	
A&F-9