Refactor testing

Author: StanFromIreland

Doc/library/test.rst

@@ -1082,6 +1082,14 @@ The :mod:`!test.support` module defines the following functions:
 
    .. versionadded:: 3.6
 
+
+.. function:: check_deprecated_module_attributes(test_case, module, *names, remove)
+
+   Assert that accessing each attribute in *names* on *module* emits a
+   :exc:`DeprecationWarning` naming the attribute and the Python version
+   *remove*, given as a ``(major, minor)`` tuple, in which it will be removed.
+
+
 .. function:: skip_if_broken_multiprocessing_synchronize()
 
    Skip tests if the :mod:`multiprocessing.synchronize` module is missing, if

Lib/test/support/__init__.py

@@ -1943,6 +1943,24 @@ def test__all__(self):
     test_case.assertCountEqual(module.__all__, expected)
 
 
+def check_deprecated_module_attributes(test_case, module, *names, remove):
+    """Assert that accessing each of 'names' on 'module' emits a
+    DeprecationWarning naming the attribute and the Python version 'remove',
+    given as a (major, minor) tuple, in which it will be removed.
+    """
+    major, minor = remove
+    for name in names:
+        with test_case.subTest(name=name):
+            with test_case.assertWarns(DeprecationWarning) as cm:
+                getattr(module, name)
+            test_case.assertEqual(
+                str(cm.warning),
+                f"{name!r} is deprecated and slated for removal "
+                f"in Python {major}.{minor}",
+            )
+            test_case.assertEqual(cm.filename, __file__)
+
+
 def suppress_msvcrt_asserts(verbose=False):
     try:
         import msvcrt

Lib/test/test_argparse.py

@@ -18,6 +18,7 @@
 import warnings
 
 from enum import StrEnum
+from test import support
 from test.support import (
     captured_stderr,
     force_not_colorized,
@@ -8070,13 +8071,10 @@ def test_fake_color_theme_raises(self):
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__version__(self):
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__version__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(argparse, "__version__")
-        self.assertEqual(cm.filename, __file__)
+    def test_deprecated_module_attributes(self):
+        support.check_deprecated_module_attributes(
+            self, argparse, "__version__", remove=(3, 20),
+        )
 
 
 def tearDownModule():

Lib/test/test_bz2.py

@@ -1250,13 +1250,10 @@ def test_bzlib_version(self):
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__author__(self):
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__author__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(bz2, "__author__")
-        self.assertEqual(cm.filename, __file__)
+    def test_deprecated_module_attributes(self):
+        support.check_deprecated_module_attributes(
+            self, bz2, "__author__", remove=(3, 20),
+        )
 
 
 def tearDownModule():

Lib/test/test_concurrent_futures/test_future.py

@@ -341,15 +341,12 @@ def get_snapshot():
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__author__(self):
+    def test_deprecated_module_attributes(self):
         for mod in (futures, futures.process, futures.thread):
             with self.subTest(mod=mod.__name__):
-                with self.assertWarnsRegex(
-                    DeprecationWarning,
-                    "'__author__' is deprecated and slated for removal in Python 3.20",
-                ) as cm:
-                    getattr(mod, "__author__")
-                self.assertEqual(cm.filename, __file__)
+                support.check_deprecated_module_attributes(
+                    self, mod, "__author__", remove=(3, 20),
+                )
 
 
 def setUpModule():

Lib/test/test_csv.py

@@ -2095,13 +2095,10 @@ def test_disallow_instantiation(self):
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__version__(self):
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__version__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(csv, "__version__")
-        self.assertEqual(cm.filename, __file__)
+    def test_deprecated_module_attributes(self):
+        support.check_deprecated_module_attributes(
+            self, csv, "__version__", remove=(3, 20),
+        )
 
 
 if __name__ == '__main__':

Lib/test/test_ctypes/__init__.py

@@ -9,18 +9,15 @@
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__version__(self):
+    def test_deprecated_module_attributes(self):
         import ctypes
         import _ctypes
 
         for mod in (ctypes, _ctypes):
             with self.subTest(mod=mod):
-                with self.assertWarnsRegex(
-                    DeprecationWarning,
-                    "'__version__' is deprecated and slated for removal in Python 3.20",
-                ) as cm:
-                    getattr(mod, "__version__")
-                self.assertEqual(cm.filename, __file__)
+                support.check_deprecated_module_attributes(
+                    self, mod, "__version__", remove=(3, 20),
+                )
 
 
 def load_tests(*args):

Lib/test/test_ctypes/test_macholib.py

@@ -30,6 +30,7 @@
 import os
 import sys
 import unittest
+from test import support
 
 from ctypes.macholib.dyld import dyld_find
 from ctypes.macholib.dylib import dylib_info
@@ -109,15 +110,12 @@ def test_framework_info(self):
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__version__(self):
+    def test_deprecated_module_attributes(self):
         import ctypes.macholib
 
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__version__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(ctypes.macholib, "__version__")
-        self.assertEqual(cm.filename, __file__)
+        support.check_deprecated_module_attributes(
+            self, ctypes.macholib, "__version__", remove=(3, 20),
+        )
 
 
 if __name__ == "__main__":

Lib/test/test_decimal.py

@@ -6032,13 +6032,10 @@ def doit(ty):
 
 
 class TestModule:
-    def test_deprecated__version__(self):
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__version__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(self.decimal, "__version__")
-        self.assertEqual(cm.filename, __file__)
+    def test_deprecated_module_attributes(self):
+        support.check_deprecated_module_attributes(
+            self, self.decimal, "__version__", remove=(3, 20),
+        )
 
 
 @requires_cdecimal

Lib/test/test_httpservers.py

@@ -1742,13 +1742,10 @@ def test_https_client(self):
 
 
 class TestModule(unittest.TestCase):
-    def test_deprecated__version__(self):
-        with self.assertWarnsRegex(
-            DeprecationWarning,
-            "'__version__' is deprecated and slated for removal in Python 3.20",
-        ) as cm:
-            getattr(http.server, "__version__")
-        self.assertEqual(cm.filename, __file__)
+    def test_deprecated_module_attributes(self):
+        support.check_deprecated_module_attributes(
+            self, http.server, "__version__", remove=(3, 20),
+        )
 
 
 def setUpModule():