Mailman 3 January 2019 - Python-checkins

bpo-35404: Clarify how to import _structure in email.message doc (GH-10886)
by Brian Curtin Jan. 10, 2019

Jan. 10, 2019

https://github.com/python/cpython/commit/e394ba32147f687b6bc7518d461f1d8421… commit: e394ba32147f687b6bc7518d461f1d84211698e0 branch: master author: Charles-Axel Dein <charlesaxel.dein(a)gmail.com> committer: Brian Curtin <brian(a)python.org> date: 2019-01-09T15:52:10-07:00 summary: bpo-35404: Clarify how to import _structure in email.message doc (GH-10886) files: M Doc/library/email.message.rst diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index 77b8099a7d4c..f1806a0866bb 100644 --- a/Doc/library/email.message.rst +++ b/Doc/library/email.message.rst @@ -487,7 +487,6 @@ message objects. from email import message_from_binary_file with open('../Lib/test/test_email/data/msg_16.txt', 'rb') as f: msg = message_from_binary_file(f) - from email.iterators import _structure .. doctest:: @@ -509,6 +508,7 @@ message objects. .. doctest:: + >>> from email.iterators import _structure >>> for part in msg.walk(): ... print(part.get_content_maintype() == 'multipart', ... part.is_multipart())

1 0

Add example to the documentation for calling unittest.mock.patch with create=True (GH-11056)
by Miss Islington (bot) Jan. 10, 2019

Jan. 10, 2019

https://github.com/python/cpython/commit/2b3db493690c286565b91b3d604cda38ad… commit: 2b3db493690c286565b91b3d604cda38adb24636 branch: 3.7 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: GitHub <noreply(a)github.com> date: 2019-01-09T13:50:02-08:00 summary: Add example to the documentation for calling unittest.mock.patch with create=True (GH-11056) (cherry picked from commit d6acf17c05315cd34124d678057d9543adbad404) Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> files: M Doc/library/unittest.mock.rst diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst index f1b25958a670..6daf0feca3ce 100644 --- a/Doc/library/unittest.mock.rst +++ b/Doc/library/unittest.mock.rst @@ -1097,13 +1097,13 @@ patch Instead of ``autospec=True`` you can pass ``autospec=some_object`` to use an arbitrary object as the spec instead of the one being replaced. - By default :func:`patch` will fail to replace attributes that don't exist. If - you pass in ``create=True``, and the attribute doesn't exist, patch will - create the attribute for you when the patched function is called, and - delete it again afterwards. This is useful for writing tests against - attributes that your production code creates at runtime. It is off by - default because it can be dangerous. With it switched on you can write - passing tests against APIs that don't actually exist! + By default :func:`patch` will fail to replace attributes that don't exist. + If you pass in ``create=True``, and the attribute doesn't exist, patch will + create the attribute for you when the patched function is called, and delete + it again after the patched function has exited. This is useful for writing + tests against attributes that your production code creates at runtime. It is + off by default because it can be dangerous. With it switched on you can + write passing tests against APIs that don't actually exist! .. note:: @@ -1225,6 +1225,27 @@ into a :func:`patch` call using ``**``: ... KeyError +By default, attempting to patch a function in a module (or a method or an +attribute in a class) that does not exist will fail with :exc:`AttributeError`:: + + >>> @patch('sys.non_existing_attribute', 42) + ... def test(): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + Traceback (most recent call last): + ... + AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing' + +but adding ``create=True`` in the call to :func:`patch` will make the previous example +work as expected:: + + >>> @patch('sys.non_existing_attribute', 42, create=True) + ... def test(mock_stdout): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + patch.object ~~~~~~~~~~~~

1 0

Add example to the documentation for calling unittest.mock.patch with create=True (GH-11056)
by Pablo Galindo Jan. 10, 2019

Jan. 10, 2019

https://github.com/python/cpython/commit/d6acf17c05315cd34124d678057d9543ad… commit: d6acf17c05315cd34124d678057d9543adbad404 branch: master author: Pablo Galindo <Pablogsal(a)gmail.com> committer: GitHub <noreply(a)github.com> date: 2019-01-09T21:43:24Z summary: Add example to the documentation for calling unittest.mock.patch with create=True (GH-11056) files: M Doc/library/unittest.mock.rst diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst index bfab00eb7514..c011e54e3e73 100644 --- a/Doc/library/unittest.mock.rst +++ b/Doc/library/unittest.mock.rst @@ -1119,13 +1119,13 @@ patch Instead of ``autospec=True`` you can pass ``autospec=some_object`` to use an arbitrary object as the spec instead of the one being replaced. - By default :func:`patch` will fail to replace attributes that don't exist. If - you pass in ``create=True``, and the attribute doesn't exist, patch will - create the attribute for you when the patched function is called, and - delete it again afterwards. This is useful for writing tests against - attributes that your production code creates at runtime. It is off by - default because it can be dangerous. With it switched on you can write - passing tests against APIs that don't actually exist! + By default :func:`patch` will fail to replace attributes that don't exist. + If you pass in ``create=True``, and the attribute doesn't exist, patch will + create the attribute for you when the patched function is called, and delete + it again after the patched function has exited. This is useful for writing + tests against attributes that your production code creates at runtime. It is + off by default because it can be dangerous. With it switched on you can + write passing tests against APIs that don't actually exist! .. note:: @@ -1247,6 +1247,27 @@ into a :func:`patch` call using ``**``:: ... KeyError +By default, attempting to patch a function in a module (or a method or an +attribute in a class) that does not exist will fail with :exc:`AttributeError`:: + + >>> @patch('sys.non_existing_attribute', 42) + ... def test(): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + Traceback (most recent call last): + ... + AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing' + +but adding ``create=True`` in the call to :func:`patch` will make the previous example +work as expected:: + + >>> @patch('sys.non_existing_attribute', 42, create=True) + ... def test(mock_stdout): + ... assert sys.non_existing_attribute == 42 + ... + >>> test() + patch.object ~~~~~~~~~~~~

1 0

[2.7] bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (#11482)
by Senthil Kumaran Jan. 10, 2019

Jan. 10, 2019

https://github.com/python/cpython/commit/02e33d9567aa4bd612f9f08053acbfd5e6… commit: 02e33d9567aa4bd612f9f08053acbfd5e68480d0 branch: 2.7 author: Sanyam Khurana <8039608+CuriousLearner(a)users.noreply.github.com> committer: Senthil Kumaran <skumaran(a)gatech.edu> date: 2019-01-09T11:03:03-08:00 summary: [2.7] bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (#11482) * bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff * [2.7] bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (GH-10639). (cherry picked from commit cbb16459934eaf29c7c7d362939cd05550b2f21f) Co-authored-by: Sanyam Khurana <8039608+CuriousLearner(a)users.noreply.github.com> files: A Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst M Lib/doctest.py M Lib/test/test_doctest.py diff --git a/Lib/doctest.py b/Lib/doctest.py index fedf67011d92..1d822b576bb3 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1651,8 +1651,6 @@ def output_difference(self, example, got, optionflags): 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 354c33baa988..88f4b6127938 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -2355,7 +2355,12 @@ def test_unittest_reportflags(): Then the default eporting options are ignored: >>> result = suite.run(unittest.TestResult()) - >>> print result.failures[0][1] # doctest: +ELLIPSIS + """ + """ + *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 Traceback ... Failed example: favorite_color @@ -2368,7 +2373,7 @@ def test_unittest_reportflags(): Differences (ndiff with -expected +actual): a - <BLANKLINE> - + + +\x20 b <BLANKLINE> <BLANKLINE> @@ -2717,6 +2722,47 @@ 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 new file mode 100644 index 000000000000..c592516d1466 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst @@ -0,0 +1,2 @@ +Avoid stripping trailing whitespace in doctest fancy diff. Orignial patch by +R. David Murray & Jairo Trad. Enhanced by Sanyam Khurana.

1 0

bpo-35641: Move IDLE blurb to IDLE directory (GH-11479)
by Miss Islington (bot) Jan. 9, 2019

Jan. 9, 2019

https://github.com/python/cpython/commit/6f76ef81596bbd885957b7fea3f40024ed… commit: 6f76ef81596bbd885957b7fea3f40024ed9d6797 branch: 3.7 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: GitHub <noreply(a)github.com> date: 2019-01-09T07:49:38-08:00 summary: bpo-35641: Move IDLE blurb to IDLE directory (GH-11479) (cherry picked from commit ee6559436797032b816dfb8c6376c9a451014962) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: A Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst D Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst diff --git a/Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst b/Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst similarity index 100% rename from Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst rename to Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst

1 0

bpo-35641: Move IDLE blurb to IDLE directory (#11479)
by Terry Jan Reedy Jan. 9, 2019

Jan. 9, 2019

https://github.com/python/cpython/commit/ee6559436797032b816dfb8c6376c9a451… commit: ee6559436797032b816dfb8c6376c9a451014962 branch: master author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: GitHub <noreply(a)github.com> date: 2019-01-09T10:44:07-05:00 summary: bpo-35641: Move IDLE blurb to IDLE directory (#11479) files: A Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst D Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst diff --git a/Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst b/Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst similarity index 100% rename from Misc/NEWS.d/next/Library/2019-01-02-22-15-01.bpo-35641.QEaANl.rst rename to Misc/NEWS.d/next/IDLE/2019-01-02-22-15-01.bpo-35641.QEaANl.rst

1 0

bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (GH-10639) (#11477)
by Senthil Kumaran Jan. 9, 2019

Jan. 9, 2019

https://github.com/python/cpython/commit/5d9ae8b9df8371dd65514e0d60b561fd37… commit: 5d9ae8b9df8371dd65514e0d60b561fd37056986 branch: 3.6 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: Senthil Kumaran <skumaran(a)gatech.edu> date: 2019-01-09T06:46:28-08:00 summary: bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (GH-10639) (#11477) (cherry picked from commit cbb16459934eaf29c7c7d362939cd05550b2f21f) Co-authored-by: Sanyam Khurana <8039608+CuriousLearner(a)users.noreply.github.com> files: A Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst M Lib/doctest.py M Lib/test/test_doctest.py diff --git a/Lib/doctest.py b/Lib/doctest.py index 0b78544d8d0e..ca5be5927594 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1691,8 +1691,6 @@ def output_difference(self, example, got, optionflags): 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 2258c6b1baed..ad527626d1b0 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -2431,6 +2431,11 @@ 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 Traceback ... Failed example: @@ -2444,7 +2449,7 @@ def test_unittest_reportflags(): Differences (ndiff with -expected +actual): a - <BLANKLINE> - + + +\x20 b <BLANKLINE> <BLANKLINE> @@ -2933,6 +2938,47 @@ def test_CLI(): r""" """ +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 new file mode 100644 index 000000000000..c592516d1466 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst @@ -0,0 +1,2 @@ +Avoid stripping trailing whitespace in doctest fancy diff. Orignial patch by +R. David Murray & Jairo Trad. Enhanced by Sanyam Khurana.

1 0

bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (GH-10639)
by Miss Islington (bot) Jan. 9, 2019

Jan. 9, 2019

https://github.com/python/cpython/commit/53cf5f084b01cb16630361be5377047c06… commit: 53cf5f084b01cb16630361be5377047c068d2b44 branch: 3.7 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: GitHub <noreply(a)github.com> date: 2019-01-09T05:56:40-08:00 summary: bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (GH-10639) (cherry picked from commit cbb16459934eaf29c7c7d362939cd05550b2f21f) Co-authored-by: Sanyam Khurana <8039608+CuriousLearner(a)users.noreply.github.com> files: A Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst M Lib/doctest.py M Lib/test/test_doctest.py diff --git a/Lib/doctest.py b/Lib/doctest.py index c1d8a1db111d..79d91a040c2e 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1690,8 +1690,6 @@ def output_difference(self, example, got, optionflags): 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 83941c129f44..6081009006df 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -2450,6 +2450,11 @@ 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 Traceback ... Failed example: @@ -2463,7 +2468,7 @@ def test_unittest_reportflags(): Differences (ndiff with -expected +actual): a - <BLANKLINE> - + + +\x20 b <BLANKLINE> <BLANKLINE> @@ -2952,6 +2957,47 @@ def test_CLI(): r""" """ +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 new file mode 100644 index 000000000000..c592516d1466 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst @@ -0,0 +1,2 @@ +Avoid stripping trailing whitespace in doctest fancy diff. Orignial patch by +R. David Murray & Jairo Trad. Enhanced by Sanyam Khurana.

1 0

bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (#10639)
by Senthil Kumaran Jan. 9, 2019

Jan. 9, 2019

https://github.com/python/cpython/commit/cbb16459934eaf29c7c7d362939cd05550… commit: cbb16459934eaf29c7c7d362939cd05550b2f21f branch: master author: Sanyam Khurana <8039608+CuriousLearner(a)users.noreply.github.com> committer: Senthil Kumaran <skumaran(a)gatech.edu> date: 2019-01-09T05:38:38-08:00 summary: bpo-24746: Avoid stripping trailing whitespace in doctest fancy diff (#10639) files: A Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst M Lib/doctest.py M Lib/test/test_doctest.py diff --git a/Lib/doctest.py b/Lib/doctest.py index c1d8a1db111d..79d91a040c2e 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1690,8 +1690,6 @@ def output_difference(self, example, got, optionflags): 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 efdce3c90c26..c40c38926873 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -2451,6 +2451,11 @@ 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 Traceback ... Failed example: @@ -2464,7 +2469,7 @@ def test_unittest_reportflags(): Differences (ndiff with -expected +actual): a - <BLANKLINE> - + + +\x20 b <BLANKLINE> <BLANKLINE> @@ -2953,6 +2958,47 @@ def test_CLI(): r""" """ +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 new file mode 100644 index 000000000000..c592516d1466 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-11-22-15-22-56.bpo-24746.eSLKBE.rst @@ -0,0 +1,2 @@ +Avoid stripping trailing whitespace in doctest fancy diff. Orignial patch by +R. David Murray & Jairo Trad. Enhanced by Sanyam Khurana.

1 0

Daily reference leaks (4243df51fe43): sum=6
by solipsis＠pitrou.net Jan. 9, 2019

Jan. 9, 2019

results for 4243df51fe43 on branch "default" -------------------------------------------- test_collections leaked [7, -7, 1] memory blocks, sum=1 test_functools leaked [0, 3, 1] memory blocks, sum=4 test_multiprocessing_forkserver leaked [0, -2, 1] memory blocks, sum=-1 test_multiprocessing_spawn leaked [0, 2, 0] memory blocks, sum=2 Command line was: ['./python', '-m', 'test.regrtest', '-uall', '-R', '3:3:/home/psf-users/antoine/refleaks/reflog6ZtqCS', '--timeout', '7200']

1 0