Prefix contextmanagers with module name in doc examples (#8044)

* Prefix contextmanagers with module name in doc examples

* Import pytest explicitly for doctests

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
This commit is contained in:
Tim Hoffmann
2020-11-19 11:06:24 +01:00
committed by GitHub
parent 30d89fd07e
commit b7ba76653d
2 changed files with 14 additions and 11 deletions
+7 -5
View File
@@ -60,7 +60,8 @@ def deprecated_call(
... warnings.warn('use v3 of this api', DeprecationWarning)
... return 200
>>> with deprecated_call():
>>> import pytest
>>> with pytest.deprecated_call():
... assert api_call_v2() == 200
It can also be used by passing a function and ``*args`` and ``**kwargs``,
@@ -116,19 +117,20 @@ def warns(
This function can be used as a context manager, or any of the other ways
``pytest.raises`` can be used::
>>> with warns(RuntimeWarning):
>>> 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 warns(UserWarning, match='must be 0 or None'):
>>> with pytest.warns(UserWarning, match='must be 0 or None'):
... warnings.warn("value must be 0 or None", UserWarning)
>>> with warns(UserWarning, match=r'must be \d+$'):
>>> with pytest.warns(UserWarning, match=r'must be \d+$'):
... warnings.warn("value must be 42", UserWarning)
>>> with warns(UserWarning, match=r'must be \d+$'):
>>> with pytest.warns(UserWarning, match=r'must be \d+$'):
... warnings.warn("this is not here", UserWarning)
Traceback (most recent call last):
...