From 54a7b021125d23a248e70ba17bf8b10bc8619234 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Ericson?= <de.ericson@gmail.com>
Date: Tue, 29 Oct 2019 20:27:22 +0100
Subject: [PATCH] Fixed #30927 -- Simplified an example of test for the
deprecation warning with assertWarnsMessage().
---
.../writing-code/submitting-patches.txt | 13 ++++---------
1 file changed, 4 insertions(+), 9 deletions(-)
diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt
index d70bc428d1..9f8acd9cd0 100644
--- a/docs/internals/contributing/writing-code/submitting-patches.txt
+++ b/docs/internals/contributing/writing-code/submitting-patches.txt
@@ -200,20 +200,15 @@ level:
class MyDeprecatedTests(unittest.TestCase):
...
-You can also add a test for the deprecation warning. You'll have to disable the
-"warning as error" behavior in your test by doing::
+You can also add a test for the deprecation warning::
- import warnings
+ from django.utils.deprecation import RemovedInDjangoXXWarning
def test_foo_deprecation_warning(self):
- with warnings.catch_warnings(record=True) as warns:
- warnings.simplefilter('always') # prevent warnings from appearing as errors
+ msg = 'Expected deprecation message'
+ with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg):
# invoke deprecated behavior
- self.assertEqual(len(warns), 1)
- msg = str(warns[0].message)
- self.assertEqual(msg, 'Expected deprecation message')
-
Finally, there are a couple of updates to Django's documentation to make:
#) If the existing feature is documented, mark it deprecated in documentation