Mailman 3 December 2022 - Python-checkins

[3.10] gh-100583: Improve the `pydoc` documentation (GH-100590) (#100607)
by kumaraditya303 Dec. 29, 2022

Dec. 29, 2022

https://github.com/python/cpython/commit/2b1cc33db0b413c42393ea3a9b9cdf2c58… commit: 2b1cc33db0b413c42393ea3a9b9cdf2c585d804a branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: kumaraditya303 <59607654+kumaraditya303(a)users.noreply.github.com> date: 2022-12-29T21:45:13+05:30 summary: [3.10] gh-100583: Improve the `pydoc` documentation (GH-100590) (#100607) gh-100583: Improve the `pydoc` documentation (GH-100590) (cherry picked from commit 7223d50b9785bc7b0cd76dcc68d97dabcbade4b6) Co-authored-by: ram vikram singh <ramvikrams243(a)gmail.com> files: M Doc/library/pydoc.rst diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 94daf4a58f9c..03e0915bf6d1 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -33,7 +33,7 @@ as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running :program:`pydoc` as a script at the operating system's command prompt. For example, running :: - pydoc sys + python -m pydoc sys at a shell prompt will display documentation on the :mod:`sys` module, in a style similar to the manual pages shown by the Unix :program:`man` command. The @@ -65,18 +65,18 @@ manner similar to the Unix :program:`man` command. The synopsis line of a module is the first line of its documentation string. You can also use :program:`pydoc` to start an HTTP server on the local machine -that will serve documentation to visiting web browsers. :program:`pydoc -p 1234` +that will serve documentation to visiting web browsers. :program:`python -m pydoc -p 1234` will start a HTTP server on port 1234, allowing you to browse the documentation at ``http://localhost:1234/`` in your preferred web browser. Specifying ``0`` as the port number will select an arbitrary unused port. -:program:`pydoc -n <hostname>` will start the server listening at the given +:program:`python -m pydoc -n <hostname>` will start the server listening at the given hostname. By default the hostname is 'localhost' but if you want the server to be reached from other machines, you may want to change the host name that the server responds to. During development this is especially useful if you want to run pydoc from within a container. -:program:`pydoc -b` will start the server and additionally open a web +:program:`python -m pydoc -b` will start the server and additionally open a web browser to a module index page. Each served page has a navigation bar at the top where you can *Get* help on an individual item, *Search* all modules with a keyword in their synopsis line, and go to the *Module index*, *Topics* and

1 0

gh-100600: Fix "coroutine was never awaited" warning in `test_coroutines` (GH-100601)
by miss-islington Dec. 29, 2022

Dec. 29, 2022

https://github.com/python/cpython/commit/dd520e7bae18549971b900b6dadc69bfc3… commit: dd520e7bae18549971b900b6dadc69bfc35d4b3f branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-12-29T07:41:34-08:00 summary: gh-100600: Fix "coroutine was never awaited" warning in `test_coroutines` (GH-100601) (cherry picked from commit 76856366d3ece34c3e738f7167329e97bbf52b34) Co-authored-by: Nikita Sobolev <mail(a)sobolevn.me> files: M Lib/test/test_coroutines.py diff --git a/Lib/test/test_coroutines.py b/Lib/test/test_coroutines.py index 10f1a9efbcbd..93ddbf6e8976 100644 --- a/Lib/test/test_coroutines.py +++ b/Lib/test/test_coroutines.py @@ -2207,6 +2207,7 @@ async def f(): gen = f() with self.assertWarns(RuntimeWarning): gen.cr_frame.clear() + gen.close() def test_stack_in_coroutine_throw(self): # Regression test for https://github.com/python/cpython/issues/93592

1 0

gh-100583: Improve the `pydoc` documentation (GH-100590)
by miss-islington Dec. 29, 2022

Dec. 29, 2022

https://github.com/python/cpython/commit/e180dff4c7fff1d0b2d66e6be3e9c06835… commit: e180dff4c7fff1d0b2d66e6be3e9c06835a130ef branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-12-29T07:24:11-08:00 summary: gh-100583: Improve the `pydoc` documentation (GH-100590) (cherry picked from commit 7223d50b9785bc7b0cd76dcc68d97dabcbade4b6) Co-authored-by: ram vikram singh <ramvikrams243(a)gmail.com> files: M Doc/library/pydoc.rst diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 94daf4a58f9c..03e0915bf6d1 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -33,7 +33,7 @@ as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running :program:`pydoc` as a script at the operating system's command prompt. For example, running :: - pydoc sys + python -m pydoc sys at a shell prompt will display documentation on the :mod:`sys` module, in a style similar to the manual pages shown by the Unix :program:`man` command. The @@ -65,18 +65,18 @@ manner similar to the Unix :program:`man` command. The synopsis line of a module is the first line of its documentation string. You can also use :program:`pydoc` to start an HTTP server on the local machine -that will serve documentation to visiting web browsers. :program:`pydoc -p 1234` +that will serve documentation to visiting web browsers. :program:`python -m pydoc -p 1234` will start a HTTP server on port 1234, allowing you to browse the documentation at ``http://localhost:1234/`` in your preferred web browser. Specifying ``0`` as the port number will select an arbitrary unused port. -:program:`pydoc -n <hostname>` will start the server listening at the given +:program:`python -m pydoc -n <hostname>` will start the server listening at the given hostname. By default the hostname is 'localhost' but if you want the server to be reached from other machines, you may want to change the host name that the server responds to. During development this is especially useful if you want to run pydoc from within a container. -:program:`pydoc -b` will start the server and additionally open a web +:program:`python -m pydoc -b` will start the server and additionally open a web browser to a module index page. Each served page has a navigation bar at the top where you can *Get* help on an individual item, *Search* all modules with a keyword in their synopsis line, and go to the *Module index*, *Topics* and

1 0

gh-100583: Improve the `pydoc` documentation (#100590)
by kumaraditya303 Dec. 29, 2022

Dec. 29, 2022

https://github.com/python/cpython/commit/7223d50b9785bc7b0cd76dcc68d97dabcb… commit: 7223d50b9785bc7b0cd76dcc68d97dabcbade4b6 branch: main author: ram vikram singh <ramvikrams243(a)gmail.com> committer: kumaraditya303 <59607654+kumaraditya303(a)users.noreply.github.com> date: 2022-12-29T20:47:20+05:30 summary: gh-100583: Improve the `pydoc` documentation (#100590) files: M Doc/library/pydoc.rst diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 94daf4a58f9c..03e0915bf6d1 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -33,7 +33,7 @@ as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running :program:`pydoc` as a script at the operating system's command prompt. For example, running :: - pydoc sys + python -m pydoc sys at a shell prompt will display documentation on the :mod:`sys` module, in a style similar to the manual pages shown by the Unix :program:`man` command. The @@ -65,18 +65,18 @@ manner similar to the Unix :program:`man` command. The synopsis line of a module is the first line of its documentation string. You can also use :program:`pydoc` to start an HTTP server on the local machine -that will serve documentation to visiting web browsers. :program:`pydoc -p 1234` +that will serve documentation to visiting web browsers. :program:`python -m pydoc -p 1234` will start a HTTP server on port 1234, allowing you to browse the documentation at ``http://localhost:1234/`` in your preferred web browser. Specifying ``0`` as the port number will select an arbitrary unused port. -:program:`pydoc -n <hostname>` will start the server listening at the given +:program:`python -m pydoc -n <hostname>` will start the server listening at the given hostname. By default the hostname is 'localhost' but if you want the server to be reached from other machines, you may want to change the host name that the server responds to. During development this is especially useful if you want to run pydoc from within a container. -:program:`pydoc -b` will start the server and additionally open a web +:program:`python -m pydoc -b` will start the server and additionally open a web browser to a module index page. Each served page has a navigation bar at the top where you can *Get* help on an individual item, *Search* all modules with a keyword in their synopsis line, and go to the *Module index*, *Topics* and

1 0

gh-100600: Fix "coroutine was never awaited" warning in `test_coroutines` (#100601)
by kumaraditya303 Dec. 29, 2022

Dec. 29, 2022

https://github.com/python/cpython/commit/76856366d3ece34c3e738f7167329e97bb… commit: 76856366d3ece34c3e738f7167329e97bbf52b34 branch: main author: Nikita Sobolev <mail(a)sobolevn.me> committer: kumaraditya303 <59607654+kumaraditya303(a)users.noreply.github.com> date: 2022-12-29T20:43:38+05:30 summary: gh-100600: Fix "coroutine was never awaited" warning in `test_coroutines` (#100601) files: M Lib/test/test_coroutines.py diff --git a/Lib/test/test_coroutines.py b/Lib/test/test_coroutines.py index 43a3ff0536fe..6ab19efcc588 100644 --- a/Lib/test/test_coroutines.py +++ b/Lib/test/test_coroutines.py @@ -2214,6 +2214,7 @@ async def f(): gen = f() with self.assertWarns(RuntimeWarning): gen.cr_frame.clear() + gen.close() def test_stack_in_coroutine_throw(self): # Regression test for https://github.com/python/cpython/issues/93592

1 0

GH-100101: Clarify documentation of zip's strict option (GH-100103)
by miss-islington Dec. 28, 2022

Dec. 28, 2022

https://github.com/python/cpython/commit/4217fafeac87d31ad7eb40ca0ec2bb9309… commit: 4217fafeac87d31ad7eb40ca0ec2bb9309333211 branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-12-28T13:32:44-08:00 summary: GH-100101: Clarify documentation of zip's strict option (GH-100103) (cherry picked from commit cf1c09818032df3080c2cd9e7edb5f657213dc83) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist(a)users.noreply.github.com> files: M Doc/library/functions.rst diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 46e77fdb4155..5400feb35567 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -1894,14 +1894,24 @@ are always available. They are listed here in alphabetical order. >>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True)) [('a', 1), ('b', 2), ('c', 3)] - Unlike the default behavior, it checks that the lengths of iterables are - identical, raising a :exc:`ValueError` if they aren't: - - >>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True)) + Unlike the default behavior, it raises a :exc:`ValueError` if one iterable + is exhausted before the others: + + >>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True): # doctest: +SKIP + ... print(item) + ... + (0, 'fee') + (1, 'fi') + (2, 'fo') Traceback (most recent call last): ... ValueError: zip() argument 2 is longer than argument 1 + .. + This doctest is disabled because doctest does not support capturing + output and exceptions in the same code unit. + https://github.com/python/cpython/issues/65382 + Without the ``strict=True`` argument, any bug that results in iterables of different lengths will be silenced, possibly manifesting as a hard-to-find bug in another part of the program.

1 0

GH-100101: Clarify documentation of zip's strict option (GH-100103)
by miss-islington Dec. 28, 2022

Dec. 28, 2022

https://github.com/python/cpython/commit/ac31120de7824581656de7734cbaa7333d… commit: ac31120de7824581656de7734cbaa7333d555067 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-12-28T13:32:19-08:00 summary: GH-100101: Clarify documentation of zip's strict option (GH-100103) (cherry picked from commit cf1c09818032df3080c2cd9e7edb5f657213dc83) Co-authored-by: JustAnotherArchivist <JustAnotherArchivist(a)users.noreply.github.com> files: M Doc/library/functions.rst diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 304716194d22..c71ebd235cf3 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -1918,14 +1918,24 @@ are always available. They are listed here in alphabetical order. >>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True)) [('a', 1), ('b', 2), ('c', 3)] - Unlike the default behavior, it checks that the lengths of iterables are - identical, raising a :exc:`ValueError` if they aren't: - - >>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True)) + Unlike the default behavior, it raises a :exc:`ValueError` if one iterable + is exhausted before the others: + + >>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True): # doctest: +SKIP + ... print(item) + ... + (0, 'fee') + (1, 'fi') + (2, 'fo') Traceback (most recent call last): ... ValueError: zip() argument 2 is longer than argument 1 + .. + This doctest is disabled because doctest does not support capturing + output and exceptions in the same code unit. + https://github.com/python/cpython/issues/65382 + Without the ``strict=True`` argument, any bug that results in iterables of different lengths will be silenced, possibly manifesting as a hard-to-find bug in another part of the program.

1 0

gh-100585: Fixed a bug where importlib.resources.as_file was leaving file pointers open (GH-100586)
by jaraco Dec. 28, 2022

Dec. 28, 2022

https://github.com/python/cpython/commit/f10f503b24a35a43910a632ee50c7568be… commit: f10f503b24a35a43910a632ee50c7568bedd6664 branch: main author: Samet YASLAN <sametyaslan(a)gmail.com> committer: jaraco <jaraco(a)jaraco.com> date: 2022-12-28T16:31:43-05:00 summary: gh-100585: Fixed a bug where importlib.resources.as_file was leaving file pointers open (GH-100586) * gh-100585: Fixed open fp bug in the imporlib module * Added news for gh-100585 files: A Misc/NEWS.d/next/Library/2022-12-28-17-38-39.gh-issue-100585.BiiTlG.rst M Lib/importlib/resources/_common.py diff --git a/Lib/importlib/resources/_common.py b/Lib/importlib/resources/_common.py index 8c0be7ee547e..92a37e2c12b8 100644 --- a/Lib/importlib/resources/_common.py +++ b/Lib/importlib/resources/_common.py @@ -155,5 +155,5 @@ def _write_contents(target, source): for item in source.iterdir(): _write_contents(child, item) else: - child.open('wb').write(source.read_bytes()) + child.write_bytes(source.read_bytes()) return child diff --git a/Misc/NEWS.d/next/Library/2022-12-28-17-38-39.gh-issue-100585.BiiTlG.rst b/Misc/NEWS.d/next/Library/2022-12-28-17-38-39.gh-issue-100585.BiiTlG.rst new file mode 100644 index 000000000000..0bf33b8bdd02 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2022-12-28-17-38-39.gh-issue-100585.BiiTlG.rst @@ -0,0 +1 @@ +Fixed a bug where importlib.resources.as_file was leaving file pointers open

1 0

GH-100101: Clarify documentation of zip's strict option (GH-100103)
by brandtbucher Dec. 28, 2022

Dec. 28, 2022

https://github.com/python/cpython/commit/cf1c09818032df3080c2cd9e7edb5f6572… commit: cf1c09818032df3080c2cd9e7edb5f657213dc83 branch: main author: JustAnotherArchivist <JustAnotherArchivist(a)users.noreply.github.com> committer: brandtbucher <brandtbucher(a)gmail.com> date: 2022-12-28T13:24:50-08:00 summary: GH-100101: Clarify documentation of zip's strict option (GH-100103) files: M Doc/library/functions.rst diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 2e988257d5d3..f00a072e6f41 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -1923,14 +1923,24 @@ are always available. They are listed here in alphabetical order. >>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True)) [('a', 1), ('b', 2), ('c', 3)] - Unlike the default behavior, it checks that the lengths of iterables are - identical, raising a :exc:`ValueError` if they aren't: - - >>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True)) + Unlike the default behavior, it raises a :exc:`ValueError` if one iterable + is exhausted before the others: + + >>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True): # doctest: +SKIP + ... print(item) + ... + (0, 'fee') + (1, 'fi') + (2, 'fo') Traceback (most recent call last): ... ValueError: zip() argument 2 is longer than argument 1 + .. + This doctest is disabled because doctest does not support capturing + output and exceptions in the same code unit. + https://github.com/python/cpython/issues/65382 + Without the ``strict=True`` argument, any bug that results in iterables of different lengths will be silenced, possibly manifesting as a hard-to-find bug in another part of the program.

1 0

Restore early-out to factor(). Strengthen tests. (GH-100591)
by miss-islington Dec. 28, 2022

Dec. 28, 2022

https://github.com/python/cpython/commit/9120450b253a718ae295d7e86b5087705c… commit: 9120450b253a718ae295d7e86b5087705c177eae branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2022-12-28T12:37:58-08:00 summary: Restore early-out to factor(). Strengthen tests. (GH-100591) (cherry picked from commit c4c5790120beabed83ce5855f18d209ab8324434) Co-authored-by: Raymond Hettinger <rhettinger(a)users.noreply.github.com> files: M Doc/library/itertools.rst diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst index 221863cbbcc5..93bc1f792f54 100644 --- a/Doc/library/itertools.rst +++ b/Doc/library/itertools.rst @@ -862,12 +862,14 @@ which incur interpreter overhead. "Prime factors of n." # factor(99) --> 3 3 11 for prime in sieve(math.isqrt(n) + 1): - while n >= prime: + while True: quotient, remainder = divmod(n, prime) if remainder: break yield prime n = quotient + if n == 1: + return if n >= 2: yield n @@ -1256,13 +1258,21 @@ which incur interpreter overhead. [3, 3] >>> list(factor(10)) [2, 5] - >>> list(factor(999953*999983)) + >>> list(factor(128_884_753_939)) # large prime + [128884753939] + >>> list(factor(999953 * 999983)) # large semiprime [999953, 999983] - >>> all(math.prod(factor(n)) == n for n in range(1, 1000)) + >>> list(factor(6 ** 20)) == [2] * 20 + [3] * 20 # large power + True + >>> list(factor(909_909_090_909)) # large multiterm composite + [3, 3, 7, 13, 13, 751, 113797] + >>> math.prod([3, 3, 7, 13, 13, 751, 113797]) + 909909090909 + >>> all(math.prod(factor(n)) == n for n in range(1, 2_000)) True - >>> all(set(factor(n)) <= set(sieve(n+1)) for n in range(1, 1000)) + >>> all(set(factor(n)) <= set(sieve(n+1)) for n in range(2_000)) True - >>> all(list(factor(n)) == sorted(factor(n)) for n in range(1, 1000)) + >>> all(list(factor(n)) == sorted(factor(n)) for n in range(2_000)) True >>> list(flatten([('a', 'b'), (), ('c', 'd', 'e'), ('f',), ('g', 'h', 'i')]))

1 0