summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteve Cirelli <scirelli+git@gmail.com>2020-02-03 07:06:50 (GMT)
committerGitHub <noreply@github.com>2020-02-03 07:06:50 (GMT)
commit032de7324e30c6b44ef272cea3be205a3d768759 (patch)
treece07fdab45f022c3271ae041e81e0a5be81212bc
parent0f2f35e15f9fbee44ce042b724348419d8136bc5 (diff)
downloadcpython-032de7324e30c6b44ef272cea3be205a3d768759.zip
cpython-032de7324e30c6b44ef272cea3be205a3d768759.tar.gz
cpython-032de7324e30c6b44ef272cea3be205a3d768759.tar.bz2
bpo-39450 Stripped whitespace before parsing the docstring in TestCase.shortDescription (GH-18175)
-rw-r--r--Lib/unittest/case.py2
-rw-r--r--Lib/unittest/test/test_case.py9
-rw-r--r--Misc/NEWS.d/next/Library/2020-02-02-14-46-34.bpo-39450.48R274.rst2
3 files changed, 12 insertions, 1 deletions
diff --git a/Lib/unittest/case.py b/Lib/unittest/case.py
index fa64a6e..5e5d535 100644
--- a/Lib/unittest/case.py
+++ b/Lib/unittest/case.py
@@ -512,7 +512,7 @@ class TestCase(object):
the specified test method's docstring.
"""
doc = self._testMethodDoc
- return doc and doc.split("\n")[0].strip() or None
+ return doc.strip().split("\n")[0].strip() if doc else None
def id(self):
diff --git a/Lib/unittest/test/test_case.py b/Lib/unittest/test/test_case.py
index c2401c3..f855c4d 100644
--- a/Lib/unittest/test/test_case.py
+++ b/Lib/unittest/test/test_case.py
@@ -610,6 +610,15 @@ class Test_TestCase(unittest.TestCase, TestEquality, TestHashing):
'Tests shortDescription() for a method with a longer '
'docstring.')
+ def testShortDescriptionWhitespaceTrimming(self):
+ """
+ Tests shortDescription() whitespace is trimmed, so that the first
+ line of nonwhite-space text becomes the docstring.
+ """
+ self.assertEqual(
+ self.shortDescription(),
+ 'Tests shortDescription() whitespace is trimmed, so that the first')
+
def testAddTypeEqualityFunc(self):
class SadSnake(object):
"""Dummy class for test_addTypeEqualityFunc."""
diff --git a/Misc/NEWS.d/next/Library/2020-02-02-14-46-34.bpo-39450.48R274.rst b/Misc/NEWS.d/next/Library/2020-02-02-14-46-34.bpo-39450.48R274.rst
new file mode 100644
index 0000000..55fed51
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2020-02-02-14-46-34.bpo-39450.48R274.rst
@@ -0,0 +1,2 @@
+Striped whitespace from docstring before returning it from
+:func:`unittest.case.shortDescription`.