|>> 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.
T)warnsDeprecationWarningPendingDeprecationWarning)r+ r, r- __tracebackhide__s r! r( r( 8 s@ 4 w~ $&?@ R4 R R R6 R RRr* expected_warningWarningsCheckerc d S r& r' )r4 r$ s r! r0 r0 X s Cr* c d S r& r' )r4 r+ r, r- s r! r0 r0 a s Cr* c d}|sI|r5d t | }t d| d t | |d S |d }t | s"t |dt | d t | d 5 ||d
d i |cd d d S # 1 swxY w 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)joinsorted TypeErrorr5 callabletype)r4 r$ r, r- r3 argnamesr+ s r! r0 r0 k sA \
- yy 00H6 6 6 6
/ETRRRRAw~~ Vt T Td4jj T T TUU U
-
>
>
> - -4abb,V,, - - - - - - - - - - - - - - - - - -s B55B9<B9c e Zd ZdZdddeddf fdZeded fd Zd
e ddfd Z
de d fd Z de fd
Z
efdee ddfdZddZd fd Zdeee dee dee ddf fd Z xZS )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 r r Nc t | t d d| _ g | _ d S )NT)recordF)r super__init___entered_list)selfr __class__s r! rE zWarningsRecorder.__init__ s> y!!!
%%%
46
r* zwarnings.WarningMessagec | j S )z The list of recorded warnings.rG rH s r! listzWarningsRecorder.list s zr* ic | j | S )z Get a recorded warning by index.rK )rH rN s r! __getitem__z WarningsRecorder.__getitem__ s z!} r* c * t | j S )z&Iterate through the recorded warnings.)iterrG rL s r! __iter__zWarningsRecorder.__iter__ s DJ r* c * t | j S )z The number of recorded warnings.)lenrG rL s r! __len__zWarningsRecorder.__len__ s 4: r* clsc t | j D ]6\ }}t |j | r | j | c S 7d}t |d )z>Pop the first recorded warning, raise exception if not exists.Tz not found in warning list) enumeraterG
issubclasscategorypopAssertionError)rH rW rN wr3 s r! r\ zWarningsRecorder.pop so dj)) ) )DAq!*c**
)z~~a(((((
) A A ABBBr* c g | j dd< dS )z$Clear the list of recorded warnings.NrK rL s r! clearzWarningsRecorder.clear s
111
r* c | j rd}t d| d t }|J || _ t j d | S )NTz
Cannot enter z twicealways)rF RuntimeErrorrD __enter__rG r r )rH r3 rG rI s r! rd zWarningsRecorder.__enter__ sk = ? $ =t = = =>> >!!##
h''' r* exc_typeexc_valexc_tbc | j sd}t d| d t ||| d| _ d S )NTz Cannot exit z without entering firstF)rF rc rD __exit__)rH re rf rg r3 rI s r! ri zWarningsRecorder.__exit__ sY } O $ Md M M MNN N
7F333
r* )r N)r r )__name__
__module__ __qualname____doc__boolrE propertyr
rM intrP r rS rV Warningr r\ r` rd r
BaseExceptionr ri
__classcell__rI s @r! r r s
-2 7 7 7T 7d 7 7 7 7 7 7 d45 X S %> (#<= (/ C CtG} C3L C C C C 4
./ -( '
r* c
e Zd Zedfdddeeee eee df f deeee e f de
ddf fd Z d
eee d ee d ee
ddf fd
Z xZS )r5 NFr r4 .r9 r r c t | t d d}| t j t
d d }nt
|t r<|D ]6}t |t s t |t | z 7|}n8t |t r|f}n t |t | z || _ || _
d S )NTr z/exceptions must be derived from Warning, not %s )
stacklevel)r rD rE r warnr
isinstancetuplerZ rq r= r? r4 r9 )rH r4 r9 r msgexpected_warning_tupexcrI s r! rE zWarningsChecker.__init__ s y!!!
4(((? # M.Q 7 7 7 7#'
(%
0
0 :'
5
5!#w// 5#C$s))O4445#3
('
2
2 :$4#6 C$'7"8"8 899 9 4 $r* re rf rg c 2 t ||| d} fd}||| j t fd D s'd}t d j d | d d S j D ]]}t
|j j rAt j j
t |j r d S ^t d j d j d | d S d S d S d S d S d S ) NTc : t d D d S )Nc g | ] }|j
S r' )message).0rC s r!
z?WarningsChecker.__exit__..found_str..# s >>>vFN>>>r* )indentr rL s r! found_strz+WarningsChecker.__exit__..found_str" s% >>>>>qIII Ir* c 3 L K | ] }t |j j V d S r& )rZ r[ r4 )r rrH s r! z+WarningsChecker.__exit__..( s2 WWQ:aj$2GHHWWWWWWr* 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: )
rD ri r4 anyr r9 rZ r[ recompilesearchstrr )rH re rf rg r3 r r rI s ` r! ri zWarningsChecker.__exit__ s 7F333 J J J J J FN$0WWWWRVWWWWW (,%KT=R K Kr s 5 5 # # # # # # - - - - - - - - - - - - $ $ $ $ $ $ ! ! ! ! ! ! GCLL 9:
36 uS'#, ./0
36
#&25
*. S S
8CH%
& S69 SEH S
s "# S S S S@
HK 14 DM5g 1C+D DE E#ws|+, -
DM5g 1C+D DE
36
IP<- 15<- <- <-DM5g 1C+D DE<- <- E#ws|+, -<- <-
c !" <- <- <- <-~L L L L L x. L L L ^ ? ? ? ? ?& ? ? ? ? ?r*