gh-60492: Allow customizing test names in TextTestResult.

Thanks Chris Jerdonek for the implementation idea.

Author: felixxm

Doc/whatsnew/3.13.rst

@@ -674,6 +674,12 @@ unicodedata
 * The Unicode database has been updated to version 15.1.0. (Contributed by
   James Gerity in :gh:`109559`.)
 
+unittest
+--------
+
+* The new ``TextTestResult.getName()`` method allows customizing test names in
+  test results.
+
 venv
 ----
 

Lib/test/test_unittest/test_result.py

@@ -467,6 +467,30 @@ def testGetDescriptionWithoutDocstring(self):
                 'testGetDescriptionWithoutDocstring (' + __name__ +
                 '.Test_TextTestResult.testGetDescriptionWithoutDocstring)')
 
+    def testCustomGetNameWithoutDocstring(self):
+        class CustomGetNameTextTestResult(unittest.TextTestResult):
+            def getName(self, test):
+                return test.id()
+
+        result = CustomGetNameTextTestResult(None, True, 1)
+        expected_test_name = __name__ + ".Test_TextTestResult.testCustomGetNameWithoutDocstring"
+        self.assertEqual(result.getName(self), expected_test_name)
+        self.assertEqual(result.getDescription(self), expected_test_name)
+
+    def testCustomGetNameWithDocstring(self):
+        """Test docstring."""
+        class CustomGetNameTextTestResult(unittest.TextTestResult):
+            def getName(self, test):
+                return test.id()
+
+        result = CustomGetNameTextTestResult(None, True, 1)
+        expected_test_name = __name__ + ".Test_TextTestResult.testCustomGetNameWithDocstring"
+        self.assertEqual(result.getName(self), expected_test_name)
+        self.assertEqual(
+            result.getDescription(self),
+            expected_test_name + "\nTest docstring.",
+        )
+
     def testGetSubTestDescriptionWithoutDocstring(self):
         with self.subTest(foo=1, bar=2):
             result = unittest.TextTestResult(None, True, 1)

Lib/unittest/runner.py

@@ -48,10 +48,14 @@ def __init__(self, stream, descriptions, verbosity, *, durations=None):
 
     def getDescription(self, test):
         doc_first_line = test.shortDescription()
+        test_name = self.getName(test)
         if self.descriptions and doc_first_line:
-            return '\n'.join((str(test), doc_first_line))
+            return '\n'.join((test_name, doc_first_line))
         else:
-            return str(test)
+            return test_name
+
+    def getName(self, test):
+        return str(test)
 
     def startTest(self, test):
         super(TextTestResult, self).startTest(test)

Misc/NEWS.d/next/Library/2024-03-27-13-05-28.gh-issue-60492.EfCUSI.rst

@@ -0,0 +1,2 @@
+Add ``TextTestResult.getName()`` method to allow customizing test names.
+Patch by Mariusz Felisiak.