summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-12-22 18:19:29 -0500
committerTim Graham <timograham@gmail.com>2015-12-23 07:29:06 -0500
commit77f50c9cfc8b33bf86394816cde183e656ba28cd (patch)
treeafd5af052041824d2a8189dd0b623f0e5a71ae74
parent0224f1cb042cc14545369b230cf7036af6c296ab (diff)
Fixed #25948 -- Added guidelines for SimpleTestCase.assertRaisesMessage() usage.
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt6
-rw-r--r--docs/topics/testing/tools.txt6
2 files changed, 9 insertions, 3 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index ed07bd49a3..bdf1c4bb45 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -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
-------
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index 1eeb68e7d3..f9e302a0c1 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -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