Add docs on pytest.warns(None) deprecation
This commit is contained in:
parent
47df71d23f
commit
aeae183c75
|
@ -0,0 +1 @@
|
|||
Added extra documentation on alternatives to common misuses of `pytest.warns(None)` ahead of its deprecation.
|
|
@ -221,11 +221,32 @@ Using ``pytest.warns(None)``
|
|||
|
||||
.. deprecated:: 7.0
|
||||
|
||||
:func:`pytest.warns(None) <pytest.warns>` is now deprecated because many people used
|
||||
it to mean "this code does not emit warnings", but it actually had the effect of
|
||||
checking that the code emits at least one warning of any type - like ``pytest.warns()``
|
||||
:func:`pytest.warns(None) <pytest.warns>` is now deprecated because it was frequently misused.
|
||||
Its correct usage was checking that the code emits at least one warning of any type - like ``pytest.warns()``
|
||||
or ``pytest.warns(Warning)``.
|
||||
|
||||
If you are looking to:
|
||||
|
||||
- ensure that **no** warnings are emitted, consider using
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
with warnings.catch_warnings():
|
||||
warnings.simplefilter("error")
|
||||
|
||||
- suppress warnings, you could use
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
with warnings.catch_warnings():
|
||||
warnings.simplefilter("ignore")
|
||||
|
||||
- ensure that **any** warning is emitted, please use
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
with pytest.warns():
|
||||
pass
|
||||
|
||||
The ``--strict`` command-line option
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -89,7 +89,10 @@ NODE_CTOR_FSPATH_ARG = UnformattedWarning(
|
|||
|
||||
WARNS_NONE_ARG = PytestRemovedIn8Warning(
|
||||
"Passing None to catch any warning has been deprecated, pass no arguments instead:\n"
|
||||
" Replace pytest.warns(None) by simply pytest.warns()."
|
||||
"Replace pytest.warns(None) by simply pytest.warns().\n"
|
||||
"See https://docs.pytest.org/en/latest/deprecations.html"
|
||||
"#using-pytest-warns-none"
|
||||
" on asserting no warnings were emitted."
|
||||
)
|
||||
|
||||
KEYWORD_MSG_ARG = UnformattedWarning(
|
||||
|
|
|
@ -138,8 +138,11 @@ def test_warns_none_is_deprecated():
|
|||
with pytest.warns(
|
||||
PytestDeprecationWarning,
|
||||
match=re.escape(
|
||||
"Passing None to catch any warning has been deprecated, pass no arguments instead:\n "
|
||||
"Replace pytest.warns(None) by simply pytest.warns()."
|
||||
"Passing None to catch any warning has been deprecated, pass no arguments instead:\n"
|
||||
"Replace pytest.warns(None) by simply pytest.warns().\n"
|
||||
"See https://docs.pytest.org/en/latest/deprecations.html"
|
||||
"#using-pytest-warns-none"
|
||||
" on asserting no warnings were emitted."
|
||||
),
|
||||
):
|
||||
with pytest.warns(None): # type: ignore[call-overload]
|
||||
|
|
Loading…
Reference in New Issue