Fixed #25948 -- Added guidelines for SimpleTestCase.assertRaisesMessage() usage.

This commit is contained in:
Tim Graham 2015-12-22 18:19:29 -05:00
parent 0224f1cb04
commit 77f50c9cfc
2 changed files with 9 additions and 3 deletions

View File

@ -45,6 +45,12 @@ Python style
"""
...
* In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead
of :meth:`~unittest.TestCase.assertRaises` so you can check the exception
message. Use :meth:`~unittest.TestCase.assertRaisesRegex`
(``six.assertRaisesRegex()`` as long as we support Python 2) only if you need
to use regular expression matching.
Imports
-------

View File

@ -1345,9 +1345,9 @@ your test suite.
Asserts that execution of ``callable`` raises ``expected_exception`` and
that ``expected_message`` is found in the exception's message. Any other
outcome is reported as a failure. Similar to unittest's
:meth:`~unittest.TestCase.assertRaisesRegex` with the difference that
``expected_message`` isn't a regular expression.
outcome is reported as a failure. It's a simpler version of
:meth:`unittest.TestCase.assertRaisesRegex` with the difference that
``expected_message`` isn't treated as a regular expression.
If only the ``expected_exception`` and ``expected_message`` parameters are
given, returns a context manager so that the code being tested can be