diff options
author | Senthil Kumaran <skumaran@gatech.edu> | 2019-01-09 20:25:59 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-09 20:25:59 -0800 |
commit | 882aba4716e147168035af76f97320c906a2246f (patch) | |
tree | a62464e753b9d589bee525391c8e18acc8b22492 | |
parent | e3db668f73e044f7727aef8f7fa7eca7b135847b (diff) | |
download | cpython-git-revert-11482-backport-cbb1645-2.7.tar.gz |
Revert "[2.7] bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (#11482)"revert-11482-backport-cbb1645-2.7
This reverts commit 02e33d9567aa4bd612f9f08053acbfd5e68480d0.
-rw-r--r-- | Lib/doctest.py | 2 | ||||
-rw-r--r-- | Lib/test/test_doctest.py | 50 | ||||
-rw-r--r-- | Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst | 2 |
3 files changed, 4 insertions, 50 deletions
diff --git a/Lib/doctest.py b/Lib/doctest.py index 1d822b576b..fedf67011d 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1651,6 +1651,8 @@ class OutputChecker: kind = 'ndiff with -expected +actual' else: assert 0, 'Bad diff option' + # Remove trailing whitespace on diff output. + diff = [line.rstrip() + '\n' for line in diff] return 'Differences (%s):\n' % kind + _indent(''.join(diff)) # If we're not using diff, then simply list the expected diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py index 88f4b61279..354c33baa9 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -2355,12 +2355,7 @@ def test_unittest_reportflags(): Then the default eporting options are ignored: >>> result = suite.run(unittest.TestResult()) - """ - """ - *NOTE*: These doctest are intentionally not placed in raw string to depict - the trailing whitespace using `\x20` in the diff below. - - >>> print(result.failures[0][1]) # doctest: +ELLIPSIS + >>> print result.failures[0][1] # doctest: +ELLIPSIS Traceback ... Failed example: favorite_color @@ -2373,7 +2368,7 @@ def test_unittest_reportflags(): Differences (ndiff with -expected +actual): a - <BLANKLINE> - +\x20 + + b <BLANKLINE> <BLANKLINE> @@ -2722,47 +2717,6 @@ def old_test4(): """ TestResults(failed=0, attempted=4) """ -def test_no_trailing_whitespace_stripping(): - r""" - The fancy reports had a bug for a long time where any trailing whitespace on - the reported diff lines was stripped, making it impossible to see the - differences in line reported as different that differed only in the amount of - trailing whitespace. The whitespace still isn't particularly visible unless - you use NDIFF, but at least it is now there to be found. - - *NOTE*: This snippet was intentionally put inside a raw string to get rid of - leading whitespace error in executing the example below - - >>> def f(x): - ... r''' - ... >>> print('\n'.join(['a ', 'b'])) - ... a - ... b - ... ''' - """ - """ - *NOTE*: These doctest are not placed in raw string to depict the trailing whitespace - using `\x20` - - >>> test = doctest.DocTestFinder().find(f)[0] - >>> flags = doctest.REPORT_NDIFF - >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) - ... # doctest: +ELLIPSIS - ********************************************************************** - File ..., line 3, in f - Failed example: - print('\n'.join(['a ', 'b'])) - Differences (ndiff with -expected +actual): - - a - + a - b - TestResults(failed=1, attempted=1) - - *NOTE*: `\x20` is for checking the trailing whitespace on the +a line above. - We cannot use actual spaces there, as a commit hook prevents from committing - patches that contain trailing whitespace. More info on Issue 24746. - """ - ###################################################################### ## Main ###################################################################### diff --git a/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst b/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst deleted file mode 100644 index c592516d14..0000000000 --- a/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst +++ /dev/null @@ -1,2 +0,0 @@ -Avoid stripping trailing whitespace in doctest fancy diff. Orignial patch by -R. David Murray & Jairo Trad. Enhanced by Sanyam Khurana. |