diff --git a/_pytest/python_api.py b/_pytest/python_api.py index 81960295b38..e6f002849d5 100644 --- a/_pytest/python_api.py +++ b/_pytest/python_api.py @@ -453,6 +453,10 @@ def raises(expected_exception, *args, **kwargs): Assert that a code block/function call raises ``expected_exception`` and raise a failure exception otherwise. + :arg message: if specified, provides a custom failure message if the + exception is not raised + :arg match: if specified, asserts that the exception matches a text or regex + This helper produces a ``ExceptionInfo()`` object (see below). You may use this function as a context manager:: diff --git a/changelog/3202.doc.rst b/changelog/3202.doc.rst new file mode 100644 index 00000000000..a6f99fbf63a --- /dev/null +++ b/changelog/3202.doc.rst @@ -0,0 +1 @@ +Add Sphinx parameter docs for ``match`` and ``message`` args to ``pytest.raises``.