a
    ˆÏ?e²*  ã                	   @   s„  d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm	Z	 ddlm
Z
 ddlmZ dd	lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ edƒZee
d dœdd„ƒZeddœeeeee f  ddœdd „ƒZ ee	def eeed!œd"d „ƒZ d.ee	def  eeedef d!œd#d „Z ed/ddœeee! eee! df f eeeee f  d$d%œd&d'„ƒZ"eeee! eee! df f e	def eeed(œd)d'„ƒZ"e!fddœeee! eee! df f eeeeee f  eed$ef d*œd+d'„Z"G d,d„ dej#ƒZ$eG d-d$„ d$e$ƒƒZ%dS )0z/Record warnings during test function execution.é    N©Úpformat)ÚTracebackType)ÚAny)ÚCallable)Ú	Generator)ÚIterator)ÚList)ÚOptional)ÚPattern)ÚTuple)ÚType)ÚTypeVar)ÚUnion)Úfinal)Úoverload)Úcheck_ispytest)ÚWARNS_NONE_ARG)Úfixture)ÚfailÚT)ÚWarningsRecorderNN©Úreturnc                  c   sB   t dd�} | �  t d¡ | V  W d  ƒ n1 s40    Y  dS )zØReturn a :class:`WarningsRecorder` instance that records all warnings emitted by test functions.

    See https://docs.pytest.org/en/latest/how-to/capture-warnings.html for information
    on warning categories.
    T©Ú	_ispytestÚdefaultN)r   ÚwarningsÚsimplefilter)Zwrec© r   úR/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/_pytest/recwarn.pyÚrecwarn   s    

r!   .©Úmatchr   )r#   r   c                 C   s   d S ©Nr   r"   r   r   r    Údeprecated_call*   s    r%   )ÚfuncÚargsÚkwargsr   c                 O   s   d S r$   r   )r&   r'   r(   r   r   r    r%   1   s    c                 O   s0   d}| dur| f| }t ttfg|¢R i |¤ŽS )a�  Assert that code produces a ``DeprecationWarning`` or ``PendingDeprecationWarning``.

    This function can be used as a context manager::

        >>> import warnings
        >>> def api_call_v2():
        ...     warnings.warn('use v3 of this api', DeprecationWarning)
        ...     return 200

        >>> import pytest
        >>> with pytest.deprecated_call():
        ...    assert api_call_v2() == 200

    It can also be used by passing a function and ``*args`` and ``**kwargs``,
    in which case it will ensure calling ``func(*args, **kwargs)`` produces one of
    the warnings types above. The return value is the return value of the function.

    In the context manager form you may use the keyword argument ``match`` to assert
    that the warning matches a text or regex.

    The context manager produces a list of :class:`warnings.WarningMessage` objects,
    one for each warning raised.
    TN)ÚwarnsÚDeprecationWarningÚPendingDeprecationWarning)r&   r'   r(   Ú__tracebackhide__r   r   r    r%   8   s    
ÚWarningsChecker)Úexpected_warningr#   r   c                C   s   d S r$   r   )r.   r#   r   r   r    r)   X   s    r)   )r.   r&   r'   r(   r   c                 O   s   d S r$   r   )r.   r&   r'   r(   r   r   r    r)   a   s    )r.   r'   r#   r(   r   c                O   s¦   d}|s8|r*d  t|ƒ¡}td|› d�ƒ‚t| |dd�S |d }t|ƒs`t|›dt|ƒ› d�ƒ‚t| dd	��& ||d
d… i |¤ŽW  d  ƒ S 1 s˜0    Y  dS )aœ  Assert that code raises a particular class of warning.

    Specifically, the parameter ``expected_warning`` can be a warning class or sequence
    of warning classes, and the code inside the ``with`` block must issue at least one
    warning of that class or classes.

    This helper produces a list of :class:`warnings.WarningMessage` objects, one for
    each warning raised (regardless of whether it is an ``expected_warning`` or not).

    This function can be used as a context manager, which will capture all the raised
    warnings inside it::

        >>> import pytest
        >>> with pytest.warns(RuntimeWarning):
        ...    warnings.warn("my warning", RuntimeWarning)

    In the context manager form you may use the keyword argument ``match`` to assert
    that the warning matches a text or regex::

        >>> with pytest.warns(UserWarning, match='must be 0 or None'):
        ...     warnings.warn("value must be 0 or None", UserWarning)

        >>> with pytest.warns(UserWarning, match=r'must be \d+$'):
        ...     warnings.warn("value must be 42", UserWarning)

        >>> with pytest.warns(UserWarning, match=r'must be \d+$'):
        ...     warnings.warn("this is not here", UserWarning)
        Traceback (most recent call last):
          ...
        Failed: DID NOT WARN. No warnings of type ...UserWarning... were emitted...

    **Using with** ``pytest.mark.parametrize``

    When using :ref:`pytest.mark.parametrize ref` it is possible to parametrize tests
    such that some runs raise a warning and others do not.

    This could be achieved in the same way as with exceptions, see
    :ref:`parametrizing_conditional_raising` for an example.

    Tz, z5Unexpected keyword arguments passed to pytest.warns: z"
Use context-manager form instead?)Ú
match_exprr   r   z object (type: z) must be callabler   é   N)ÚjoinÚsortedÚ	TypeErrorr-   ÚcallableÚtype)r.   r#   r'   r(   r,   Úargnamesr&   r   r   r    r)   k   s    .
ÿc                       sÔ   e Zd ZdZddœeddœ‡ fdd„Zeed d	œd
d„ƒZe	ddœdd„Z
ed d	œdd„Ze	d	œdd„Zefee ddœdd„Zdd	œdd„Zd d	œ‡ fdd„Zeee  ee ee ddœ‡ fdd„Z‡  ZS )r   aF  A context manager to record raised warnings.

    Each recorded warning is an instance of :class:`warnings.WarningMessage`.

    Adapted from `warnings.catch_warnings`.

    .. note::
        ``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated
        differently; see :ref:`ensuring_function_triggers`.

    Fr   N)r   r   c                   s&   t |ƒ tƒ jdd� d| _g | _d S )NT)ÚrecordF)r   ÚsuperÚ__init__Ú_enteredÚ_list)Úselfr   ©Ú	__class__r   r    r9   ·   s    zWarningsRecorder.__init__zwarnings.WarningMessager   c                 C   s   | j S )zThe list of recorded warnings.©r;   ©r<   r   r   r    Úlist¾   s    zWarningsRecorder.list)Úir   c                 C   s
   | j | S )z Get a recorded warning by index.r?   )r<   rB   r   r   r    Ú__getitem__Ã   s    zWarningsRecorder.__getitem__c                 C   s
   t | jƒS )z&Iterate through the recorded warnings.)Úiterr;   r@   r   r   r    Ú__iter__Ç   s    zWarningsRecorder.__iter__c                 C   s
   t | jƒS )z The number of recorded warnings.)Úlenr;   r@   r   r   r    Ú__len__Ë   s    zWarningsRecorder.__len__)Úclsr   c                 C   sF   t | jƒD ]$\}}t|j|ƒr
| j |¡  S q
d}t|›d�ƒ‚dS )z>Pop the first recorded warning, raise exception if not exists.Tz not found in warning listN)Ú	enumerater;   Ú
issubclassÚcategoryÚpopÚAssertionError)r<   rH   rB   Úwr,   r   r   r    rL   Ï   s
    zWarningsRecorder.popc                 C   s   g | j dd…< dS )z$Clear the list of recorded warnings.Nr?   r@   r   r   r    Úclear×   s    zWarningsRecorder.clearc                    sD   | j rd}td| ›d�ƒ‚tƒ  ¡ }|d us0J ‚|| _t d¡ | S )NTzCannot enter z twiceÚalways)r:   ÚRuntimeErrorr8   Ú	__enter__r;   r   r   )r<   r,   r;   r=   r   r    rR   Ý   s    

zWarningsRecorder.__enter__©Úexc_typeÚexc_valÚexc_tbr   c                    s4   | j sd}td| ›d�ƒ‚tƒ  |||¡ d| _ d S )NTzCannot exit z without entering firstF)r:   rQ   r8   Ú__exit__)r<   rT   rU   rV   r,   r=   r   r    rW   è   s
    zWarningsRecorder.__exit__)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Úboolr9   Úpropertyr	   rA   ÚintrC   r   rE   rG   ÚWarningr   rL   rO   rR   r
   ÚBaseExceptionr   rW   Ú__classcell__r   r   r=   r    r   ª   s   
ûc                       sˆ   e Zd Zedfddœeeee eee df f  eeee	e f  e
ddœ‡ fdd„Zeee  ee ee ddœ‡ fd	d
„Z‡  ZS )r-   NFr   .)r.   r/   r   r   c                   sœ   t |ƒ tƒ jdd� d}|d u r6tjtdd� d }nVt|tƒrj|D ]}t|t	ƒsDt
|t|ƒ ƒ‚qD|}n"t|t	ƒr||f}nt
|t|ƒ ƒ‚|| _|| _d S )NTr   z/exceptions must be derived from Warning, not %sé   )Ú
stacklevel)r   r8   r9   r   Úwarnr   Ú
isinstanceÚtuplerJ   r_   r3   r5   r.   r/   )r<   r.   r/   r   ÚmsgZexpected_warning_tupÚexcr=   r   r    r9   û   s     	


zWarningsChecker.__init__rS   c                    sÚ   t ƒ  |||¡ d}‡ fdd„}|d u rÖ|d u rÖ|d u rÖˆ jd urÖt‡ fdd„ˆ D ƒƒsxd}tdˆ j› d|ƒ › d�ƒ n^ˆ jd urÖˆ D ].}t|jˆ jƒr†t 	ˆ j¡ 
t|jƒ¡r† qÖq†tdˆ j› d	ˆ j› d
|ƒ › �ƒ d S )NTc                      s   t dd„ ˆ D ƒdd�S )Nc                 S   s   g | ]
}|j ‘qS r   )Úmessage)Ú.0r7   r   r   r    Ú
<listcomp>#  ó    z?WarningsChecker.__exit__.<locals>.found_str.<locals>.<listcomp>é   )Úindentr   r   r@   r   r    Ú	found_str"  s    z+WarningsChecker.__exit__.<locals>.found_strc                 3   s   | ]}t |jˆ jƒV  qd S r$   )rJ   rK   r.   )rj   Úrr@   r   r    Ú	<genexpr>(  rl   z+WarningsChecker.__exit__.<locals>.<genexpr>z"DID NOT WARN. No warnings of type z0 were emitted.
The list of emitted warnings is: Ú.z* matching the regex were emitted.
 Regex: z
 Emitted warnings: )r8   rW   r.   Úanyr   r/   rJ   rK   ÚreÚcompileÚsearchÚstrri   )r<   rT   rU   rV   r,   ro   rp   r=   r@   r    rW     s4    

ÿÿ
ÿþýÿzWarningsChecker.__exit__)rX   rY   rZ   r_   r
   r   r   r   rw   r   r\   r9   r`   r   rW   ra   r   r   r=   r    r-   ù   s"   ûùÿø
û)N).)&r[   rt   r   Úpprintr   Útypesr   Útypingr   r   r   r   r	   r
   r   r   r   r   r   Z_pytest.compatr   r   Z_pytest.deprecatedr   r   Z_pytest.fixturesr   Z_pytest.outcomesr   r   r!   rw   r%   r_   r)   Úcatch_warningsr   r-   r   r   r   r    Ú<module>   sˆ   ÿþþ ÿ
þ  ÿýü
û
ÿý
û?O