B Wc* @sdZddlZddlZddlmZddlmZddlmZddlm Z ddlm Z ddlm Z dd lm Z dd lm Z dd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZedZee ddddZedde eeeefdddd Z ee defeeed!d"d Z d.e e defeeedefd!d#d Z ed/ddeee!eee!dffe eeeefd$d%d&d'Z"eeee!eee!dffe defeeed(d)d'Z"e!fddeee!eee!dffee eeeefeed$efd*d+d'Z"Gd,ddej#Z$eGd-d$d$e$Z%dS)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)failT)WarningsRecorderNN)returnc cs.tdd}|td|VWdQRXdS)zReturn 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) _ispytestdefaultN)rwarnings simplefilter)Zwrecr.lib/python3.7/site-packages/_pytest/recwarn.pyrecwarns  r.)matchr)rrcCsdS)Nr)rrrrdeprecated_call*sr )funcargskwargsrcOsdS)Nr)r!r"r#rrrr 1scOs*d}|dk r|f|}tttff||S)aAssert 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)warnsDeprecationWarningPendingDeprecationWarning)r!r"r#__tracebackhide__rrrr 8s WarningsChecker)expected_warningrrcCsdS)Nr)r)rrrrr$Xsr$)r)r!r"r#rcOsdS)Nr)r)r!r"r#rrrr$as)r)r"rr#rc Osd}|s8|r*dt|}td|dt||ddS|d}t|s`t|dt|dt|dd ||d d |SQRXd S) aAssert 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_exprrrz object (type: z) must be callable)rN)joinsorted TypeErrorr(callabletype)r)rr"r#r'Zargnamesr!rrrr$ks.cseZdZdZddeddfddZeedd d d Ze dd d dZ e dd ddZ e d ddZ efeeddddZdd ddZdd fdd Zeeeeeeeddfdd ZZS)raFA 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`. F)rN)rrcs&t|tjddd|_g|_dS)NT)recordF)rsuper__init___entered_list)selfr) __class__rrr3szWarningsRecorder.__init__zwarnings.WarningMessage)rcCs|jS)zThe list of recorded warnings.)r5)r6rrrlistszWarningsRecorder.list)ircCs |j|S)z Get a recorded warning by index.)r5)r6r9rrr __getitem__szWarningsRecorder.__getitem__cCs t|jS)z&Iterate through the recorded warnings.)iterr5)r6rrr__iter__szWarningsRecorder.__iter__cCs t|jS)z The number of recorded warnings.)lenr5)r6rrr__len__szWarningsRecorder.__len__)clsrcCsFx.t|jD] \}}t|j|r |j|Sq Wd}t|ddS)z>Pop the first recorded warning, raise exception if not exists.Tz not found in warning listN) enumerater5 issubclasscategorypopAssertionError)r6r?r9wr'rrrrCs  zWarningsRecorder.popcCsg|jdd<dS)z$Clear the list of recorded warnings.N)r5)r6rrrclearszWarningsRecorder.clearcsD|jrd}td|dt}|dk s0t||_td|S)NTz Cannot enter z twicealways)r4 RuntimeErrorr2 __enter__rDr5rr)r6r'r5)r7rrrIs   zWarningsRecorder.__enter__)exc_typeexc_valexc_tbrcs4|jsd}td|dt|||d|_dS)NTz Cannot exit z without entering firstF)r4rHr2__exit__)r6rJrKrLr')r7rrrMs zWarningsRecorder.__exit__)__name__ __module__ __qualname____doc__boolr3propertyrr8intr:rr<r>Warningr rCrFrIr BaseExceptionrrM __classcell__rr)r7rrs  cseZdZedfddeeeeeeedffeeee efe ddfddZ eee ee ee ddfd d ZZS) r(NF)r.)r)r*rrcst|tjddd}|dkr6tjtddd}nZt|trnx&|D]}t|t sFt |t |qFW|}n"t|t r|f}nt |t |||_ ||_ dS)NT)rz/exceptions must be derived from Warning, not %s) stacklevel)rr2r3rwarnr isinstancetuplerArUr.r0r)r*)r6r)r*rmsgZexpected_warning_tupexc)r7rrr3s     zWarningsChecker.__init__)rJrKrLrcst|||d}fdd}|dkr|dkr|dkr؈jdk rtfddDsxd}tdjd|dn`jdk rxTD],}t|jjrt j t |j rPqWtdjd jd |dS) NTcstddDddS)NcSsg|] }|jqSr)message).0r1rrr #sz?WarningsChecker.__exit__..found_str..)indent)rr)r6rr found_str"sz+WarningsChecker.__exit__..found_strc3s|]}t|jjVqdS)N)rArBr))r`r)r6rr (sz+WarningsChecker.__exit__..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: ) r2rMr)anyrr*rArBrecompilesearchstrr_)r6rJrKrLr'rdre)r7)r6rrMs     zWarningsChecker.__exit__)rNrOrPrUr rr r rlr rRr3rVrrMrWrr)r7rr(s8 )N).)&rQrirZpprintrtypesrtypingrrrrrr r r r r rZ_pytest.compatrrZ_pytest.deprecatedrrZ_pytest.fixturesrZ_pytest.outcomesrrrrlr rUr$catch_warningsrr(rrrrsb                    2 4:O