-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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.
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
Pytest.raises custom error message #1616
Changes from all commits
d21886c
8ddbca3
e6ff01a
ca09367
c29130d
f8d4cad
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -85,6 +85,15 @@ and if you need to have access to the actual exception info you may use:: | |
the actual exception raised. The main attributes of interest are | ||
``.type``, ``.value`` and ``.traceback``. | ||
|
||
.. versionchanged:: 2.10 | ||
|
||
In the context manager form you may use the keyword argument | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks! One last thing, please add a versionadded directive before this paragraph:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't it be after the paragraph? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also wouldn't a versionchanged be more appropriate as the function was changed? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm that's a good question. The other places in pytest documentation which use this feature put it before the paragraph... You are right, that's how Python's own documentation does it at least. 😁 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Good point. I was thinking along the lines of adding a new parameter, but I think your suggestion makes more sense. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think then that I should keep with the project conventions. Consistency is more important. |
||
``message`` to specify a custom failure message:: | ||
|
||
>>> with raises(ZeroDivisionError, message="Expecting ZeroDivisionError"): | ||
... pass | ||
... Failed: Expecting ZeroDivisionError | ||
|
||
If you want to write test code that works on Python 2.4 as well, | ||
you may also use two other ways to test for an expected exception:: | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -76,3 +76,23 @@ def test_no_raise_message(self): | |
pytest.raises(ValueError, int, '0') | ||
except pytest.raises.Exception as e: | ||
assert e.msg == "DID NOT RAISE {0}".format(repr(ValueError)) | ||
else: | ||
assert False, "Expected pytest.raises.Exception" | ||
|
||
try: | ||
with pytest.raises(ValueError): | ||
pass | ||
except pytest.raises.Exception as e: | ||
assert e.msg == "DID NOT RAISE {0}".format(repr(ValueError)) | ||
else: | ||
assert False, "Expected pytest.raises.Exception" | ||
|
||
def test_costum_raise_message(self): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. costum -> custom, but I'll fix it up when merging |
||
message = "TEST_MESSAGE" | ||
try: | ||
with pytest.raises(ValueError, message=message): | ||
pass | ||
except pytest.raises.Exception as e: | ||
assert e.msg == message | ||
else: | ||
assert False, "Expected pytest.raises.Exception" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update the docstring to include this new keyword argument support; make sure to mention it is only valid in the context manager form. 😁
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done