improve `pytest.raises`

This commit is contained in:
Babak Keyvani 2022-04-30 17:56:36 -06:00
parent e580534df0
commit 3444d35c54
4 changed files with 14 additions and 0 deletions

View File

@ -44,6 +44,7 @@ Aron Coyle
Aron Curzon Aron Curzon
Aviral Verma Aviral Verma
Aviv Palivoda Aviv Palivoda
Babak Keyvani
Barney Gale Barney Gale
Ben Gartner Ben Gartner
Ben Webb Ben Webb

View File

@ -0,0 +1,2 @@
Improve :py:func:`pytest.raises`. Previously passing an empty tuple would give a confusing
error. We now raise immediately with a more helpful message.

View File

@ -899,6 +899,13 @@ def raises(
""" """
__tracebackhide__ = True __tracebackhide__ = True
if expected_exception == ():
raise ValueError(
"Passing expected_exception=() is an error, because it's impossible to "
"raise an exception which is not an instance of any type. Raising exceptions "
"is already understood as failing the test, so you don't need any special "
"code to say 'this should never raise an exception'."
)
if isinstance(expected_exception, type): if isinstance(expected_exception, type):
excepted_exceptions: Tuple[Type[E], ...] = (expected_exception,) excepted_exceptions: Tuple[Type[E], ...] = (expected_exception,)
else: else:

View File

@ -19,6 +19,10 @@ class TestRaises:
excinfo = pytest.raises(ValueError, int, "hello") excinfo = pytest.raises(ValueError, int, "hello")
assert "invalid literal" in str(excinfo.value) assert "invalid literal" in str(excinfo.value)
def test_raises_does_not_allow_empty_tuple(self):
with pytest.raises(ValueError):
pytest.raises(expected_exception=())
def test_raises_callable_no_exception(self) -> None: def test_raises_callable_no_exception(self) -> None:
class A: class A:
def __call__(self): def __call__(self):