floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add warning about using pytest.raises(Exception) 

Related to #4475
This commit is contained in:
Bruno Oliveira 2023-11-03 08:45:29 -03:00
parent 05c69889d2
commit 9af595a17e
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/_pytest/python_api.py
View File

@ -862,6 +862,20 @@ def raises( # noqa: F811
>>> assert exc_info.type is ValueError >>> assert exc_info.type is ValueError
>>> assert exc_info.value.args[0] == "value must be 42" >>> assert exc_info.value.args[0] == "value must be 42"
.. warning::
Given that ``pytest.raises`` matches subclasses, be wary of using it to match :class:`Exception` like this::
with pytest.raises(Exception): # Careful, this will catch ANY exception raised.
some_function()
Because :class:`Exception` is the base class of almost all exceptions, it is easy for this to hide
real bugs, where the user wrote this expecting a specific exception, but some other exception is being
raised due to a bug introduced during a refactoring.
Avoid using ``pytest.raises`` to catch :class:`Exception` unless certain that you really want to catch
**any** exception raised.
.. note:: .. note::
When using ``pytest.raises`` as a context manager, it's worthwhile to When using ``pytest.raises`` as a context manager, it's worthwhile to