Skip to content

Add Sphinx parameter docs for match and message args to pytest.raises() #3202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 10, 2018
Merged

Add Sphinx parameter docs for match and message args to pytest.raises() #3202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5b527d
Add Sphinx parameter docs for `match` and `message` args to `pytest.r…
rouge8 Feb 10, 2018
ffee213
Update and rename 3202.trivial.rst to 3202.doc.rst
nicoddemus Feb 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _pytest/python_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
1 change: 1 addition & 0 deletions changelog/3202.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add Sphinx parameter docs for ``match`` and ``message`` args to ``pytest.raises``.