Commit Graph

13641 Commits

Author SHA1 Message Date
Hugo van Kemenade 61af847d41
[3.13] gh-101100: Fix Sphinx warnings in `library/decimal.rst` (GH-134303) (#134339)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-05-20 17:55:23 +03:00
Miss Islington (bot) 0c0fedf289
[3.13] gh-53189: Document peculiarities of InteractiveConsole in relation to pickle (GH-123069) (GH-134329)
gh-53189: Document peculiarities of InteractiveConsole in relation to pickle (GH-123069)

(cherry picked from commit a31bbc951a)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-05-20 12:17:10 +00:00
Miss Islington (bot) edbde92a12
[3.13] gh-134201: Expand explanation of Base85 encodings in base64 docs (GH-134288) (#134297)
gh-134201: Expand explanation of Base85 encodings in base64 docs (GH-134288)

Explain history of de-facto standard and how to pick between the two Base-85 encoding functions in the base-64 module.

---------
(cherry picked from commit 66aaad6103)

Co-authored-by: Alek Binion <aleksander.binion@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2025-05-20 00:05:26 +00:00
Miss Islington (bot) 55a7cb1206
[3.13] gh-122055: Clarify documentation for empty matches in RE (GH-133169) (GH-134218)
(cherry picked from commit 44b73d3cd4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-05-19 16:49:29 +03:00
Thomas Grainger fd6a602d04
[3.13] gh-133745: Fix asyncio task factory name/context kwarg breaks (#133948)
In 3.13.3 we accidentally broke the interface for custom task factory. Factory authors added workarounds.
This PR (for 3.13.4) unbreaks task factories that haven't made a workaround yet while also supporting those that have.

NOTE: The custom task factory API will change to what we accidentally released in 3.13.3.

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
2025-05-18 06:50:07 -07:00
Miss Islington (bot) ebe54d7ab7
[3.13] gh-134150: Clarify distinction between JSON and Python objects (GH-134154) (#134167)
gh-134150: Clarify distinction between JSON and Python objects (GH-134154)

* gh-134150: Clarify distinction between JSON objects and Python objects in json module docs

* Revert change to JSON introduction

* Clarify occurrences of "object literal" as JSON
(cherry picked from commit fa4e088668)

Co-authored-by: Micha Albert <micha@2231puppy.tech>
2025-05-18 01:53:37 +00:00
Miss Islington (bot) ec42d72f47
[3.13] Docs: fix spelling of "test case" in `unittest` documentation (GH-134137) (#134139)
Docs: fix spelling of "test case" in `unittest` documentation (GH-134137)
(cherry picked from commit b41d79c776)

Co-authored-by: Clifford Gama <53076065+cliff688@users.noreply.github.com>
2025-05-17 14:03:58 +02:00
Miss Islington (bot) 4291bbe88b
[3.13] gh-117026: Remove outdated sentence in SimpleHTTPRequestHandler docs (GH-117027) (GH-134108)
The code was changed in 0f7cddc308 (bpo-839496/gh-39531).
(cherry picked from commit ea2d707bd5)

Co-authored-by: Saleh Dehqanpour <salehdeh76@gmail.com>
2025-05-16 22:24:05 +03:00
Miss Islington (bot) 8077e2268c
[3.13] gh-133286: add explanation about `seq` for pathlib Pattern Language (GH-133340) (#134106)
gh-133286: add explanation about `seq` for pathlib Pattern Language (GH-133340)
(cherry picked from commit ac8df4b589)

Co-authored-by: alexey semenyuk <alexsemenyuk88@gmail.com>
2025-05-16 20:20:53 +01:00
Miss Islington (bot) 2a029a7d79
[3.13] gh-133515: fix docs for unawaited coroutines in debug mode (GH-134081) (#134094)
gh-133515: fix docs for unawaited coroutines in debug mode (GH-134081)
(cherry picked from commit d94b1e9cac)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-05-16 15:38:22 +00:00
Miss Islington (bot) 0007c9b505
[3.13] gh-124210: Add introduction to `threading` docs (GH-127046) (#134091)
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-05-16 12:25:22 +00:00
Miss Islington (bot) bd3add06f6
[3.13] gh-133986: Document string split algorithm when sep is None and maxsplit is 0 (GH-133987) (#133992)
gh-133986: Document string split algorithm when sep is None and maxsplit is 0 (GH-133987)
---------
(cherry picked from commit 3e23047363)

Co-authored-by: Joey Smith <joeysmith@gmail.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
2025-05-14 21:33:38 -04:00
Miss Islington (bot) 05ddd06624
[3.13] gh-133413: Fix references to removed Request.has_data (GH-133414) (GH-133946)
The has_data() method of http.request.Request
was removed in version 3.4.
(cherry picked from commit 86c1d439e0)

Co-authored-by: ppaez <pp@pp.com.mx>
2025-05-12 18:25:25 +00:00
mkaraev 532acbd0fa
[3.13] gh-133904: Fix `math.factorial` documentation (GH-133907) (#133922)
* [3.13] gh-133904: Fix `math.factorial` documentation (GH-133907)
(cherry picked from commit 27ed64575d)

Co-authored-by: mkaraev <maruf.karaev97@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
2025-05-12 12:17:17 +00:00
Miss Islington (bot) 18501a11e0
[3.13] gh-132642: document how to render human-readable `timedelta` objects (GH-133825) (#133836)
gh-132642: document how to render human-readable `timedelta` objects (GH-133825)
(cherry picked from commit efcc42ba70)

Co-authored-by: Kentaro Jay Takahashi <64148935+KentaroJay@users.noreply.github.com>
2025-05-10 15:57:29 +00:00
Miss Islington (bot) 3de6546381
[3.13] gh-132971: Update shutil.which() docs (GH-133067) (#133804)
gh-132971: Update shutil.which() docs (GH-133067)
(cherry picked from commit d13d5fdf61)

Co-authored-by: Kokona <125976684+985025074@users.noreply.github.com>
2025-05-10 10:51:38 +02:00
Miss Islington (bot) 0a39a182cf
[3.13] Docs: use boolean constants for returning boolean value (GH-133325) (GH-133761)
(cherry picked from commit 076004ae54)

Co-authored-by: Yongzi Li <1538321957@qq.com>
2025-05-09 14:19:23 +00:00
Miss Islington (bot) 6beec6c813
[3.13] gh-133361: move the explanation of dict equal before its use (GH-133424) (#133621)
gh-133361: move the explanation of dict equal before its use (GH-133424)

Also move up the explanation of insertion order preservation.  Both paragraphs seemed out of place down where they were.
---------
(cherry picked from commit 61ac88c06e)

Co-authored-by: Yongzi Li <1538321957@qq.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2025-05-07 22:11:03 +00:00
Miss Islington (bot) ce9d708e8c
[3.13] gh-131535: Fix stale example in html.parser docs, make examples doctests (GH-131551) (GH-133587)
(cherry picked from commit ee76e36d76)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
2025-05-07 20:33:23 +03:00
Miss Islington (bot) fe18437089
[3.13] gh-130117: Document why nested `Union`, `Literal`, and `Annotated` types referenced through a type alias are not flattened (GH-130119) (#133488)
gh-130117: Document why nested `Union`, `Literal`, and `Annotated` types referenced through a type alias are not flattened (GH-130119)

(cherry picked from commit b936ccdb6f)

Co-authored-by: Valentin Berlier <berlier.v@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2025-05-06 02:13:22 +00:00
Miss Islington (bot) f371b23bab
[3.13] gh-107006: Move `threading.local` docstring to docs (GH-131840) (#133432)
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-05-05 16:18:00 +03:00
Miss Islington (bot) 3d1b8e2a96
[3.13] gh-133089: Use original timeout value for `TimeoutExpired` when the func `subprocess.run` is called with a timeout (GH-133103) (#133418)
gh-133089: Use original timeout value for `TimeoutExpired` when the func `subprocess.run` is called with a timeout (GH-133103)
(cherry picked from commit 2bbcaedb75)

Signed-off-by: Manjusaka <me@manjusaka.me>
Co-authored-by: Nadeshiko Manju <me@manjusaka.me>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-05-05 01:38:30 +00:00
Hugo van Kemenade 130491f6cc
[3.13] gh-130160: use `.. program::` directive for documenting `platform` CLI (GH-133335) (#133341)
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
2025-05-03 15:37:09 +03:00
Miss Islington (bot) bb0a8575a7
gh-91156: Document how TextIOWrapper interacts with UTF-8 mode (GH-132885)
Document how TextIOWrapper interacts with UTF-8 mode
(cherry picked from commit 245cd6c532)

Co-authored-by: Malcolm Smith <smith@chaquo.com>
2025-05-03 11:38:35 +09:00
Miss Islington (bot) b225ce7744
[3.13] Docs: delete title links in `turtle.rst` and `typing.rst` (GH-133283) (#133293)
Co-authored-by: Yongzi Li <1538321957@qq.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-05-02 13:24:12 +01:00
Miss Islington (bot) 4f006ffdb9
[3.13] Apply 'mod' role to typing module (GH-133201) (#133217)
Apply 'mod' role to typing module (GH-133201)
(cherry picked from commit 2b67db7ce3)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-30 16:58:19 +00:00
Miss Islington (bot) 85882ca0e7
[3.13] gh-132726: Change the heading of `sysconfig` CLI section (GH-133035) (#133088)
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
2025-04-28 15:19:46 +00:00
Miss Islington (bot) 6ade0c3b2b
[3.13] gh-133033: Add docs for `TypeIgnore` (GH-133034) (#133078)
gh-133033: Add docs for `TypeIgnore` (GH-133034)
(cherry picked from commit 4e04511cb9)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-04-28 10:55:19 +00:00
Miss Islington (bot) 293f2895d5
[3.13] gh-98347: Add links to python-isal in the documentation (GH-98637) (#132894)
gh-98347: Add links to python-isal in the documentation (GH-98637)

Clearly note that this is primarily intended for users for who zlib/gzip is a bottleneck.
(cherry picked from commit b1fc8b69ec)

Co-authored-by: Ruben Vorderman <r.h.p.vorderman@lumc.nl>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-25 03:09:58 +01:00
Miss Islington (bot) 9953971924
[3.13] Differentiate bitwise OR from the word "or" (GH-132890) (#132891)
Differentiate bitwise OR from the word "or" (GH-132890)
(cherry picked from commit 15ff60aff0)

Co-authored-by: Brett Cannon <brett@python.org>
2025-04-24 22:11:18 +00:00
Miss Islington (bot) 9ec6f77f8a
[3.13] gh-128185: Align Decimal docs with spec (case irrelevant for nan/inf) (GH-128323) (#132875)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-04-24 14:09:03 +00:00
Miss Islington (bot) bd4a39f125
[3.13] gh-122399: change webbrowser.rst to better describe the contents of controller object (GH-122407) (#132874)
Co-authored-by: Jordi Burguet-Castell <jordi.burguet.castell@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-24 14:03:02 +00:00
Miss Islington (bot) abbc44c557
[3.13] gh-132742: Update documentation for the fcntl module (GH-132765) (GH-132832)
(cherry picked from commit 5f50541ebd)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-04-23 21:08:46 +03:00
Gregory P. Smith cdabbc126f
[3.13] gh-122179: Fix hashlib.file_digest and non-blocking I/O (GH-132787)
gh-122179: Fix hashlib.file_digest and non-blocking I/O (GH-122183)

* Fix hashlib.file_digest and non-blocking I/O
* Add documentation around this behavior
* Add versionchanged

(cherry picked from commit 2b47f46d7d)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2025-04-21 21:55:57 +00:00
Miss Islington (bot) d8b9011702
[3.13] gh-85583: Add an overview of formatted string literals (f-strings) to ``str`` (GH-132689) (#132767)
gh-85583: Add an overview of formatted string literals (f-strings) to ``str`` (GH-132689)
(cherry picked from commit fee808936f)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-21 08:55:13 +01:00
Miss Islington (bot) 5ab628fc65
[3.13] gh-129327: revise hashlib documentation to account for FIPS removing sha1 (GH-132729) (#132740)
gh-129327: revise hashlib documentation to account for FIPS removing sha1 (GH-132729)

* gh-129327: revise hashlib documentation to account for FIPS removing sha1

More generally, the current documentation is a bit scattered, talking
about what terms are "equal" despite those terms not being very
interesting and given the term "secure hash", probably wrong (because
md5 and sha1 are not secure anymore).

Let's talk about cryptographically secure instead, and note that two of
them aren't. And then we can also link to the source for NIST going
through the removal process for SHA1.

* Add Gregors Suggestion

* Clean up

---------
(cherry picked from commit a16586c9e7)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Eli Schwartz <eschwartz@gentoo.org>
2025-04-20 01:12:26 +00:00
Miss Islington (bot) 38f305b9db
[3.13] Docs: Fix REPL example in `Doc/library/shutil.rst` (GH-132700) (#132728)
Docs: Fix REPL example in `Doc/library/shutil.rst` (GH-132700)
(cherry picked from commit e154e4db36)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-04-19 14:20:46 +00:00
Miss Islington (bot) 83cb89b941
[3.13] gh-129719: Restore missing `socket.CAN_RAW_ERR_FILTER` on Linux (GH-129721) (#132702)
gh-129719: Restore missing `socket.CAN_RAW_ERR_FILTER` on Linux (GH-129721)
(cherry picked from commit ce31ae5209)

Co-authored-by: Jeroen Bogers <11465689+jbogers@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-04-18 20:49:23 +00:00
Miss Islington (bot) 151828d520
[3.13] Minor doc edit: Make multinomial() the first math example (gh-132697) (gh-132698) 2025-04-18 17:47:25 +00:00
Miss Islington (bot) bfba11ad11
[3.13] gh-132668: Remove outdated description of `POP_JUMP_*` instructions (GH-132669) (#132680)
gh-132668: Remove outdated description of `POP_JUMP_*` instructions (GH-132669)
(cherry picked from commit 7e2672cfcf)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-04-18 14:14:40 +02:00
Miss Islington (bot) db7ad1c89f
[3.13] gh-132608: Fix a sample code coloring for ast.While (GH-132609) (#132612) 2025-04-16 21:02:39 +01:00
Miss Islington (bot) f9578dc31f
[3.13] typing docs: Clarify Protocol / runtime_checkable docs (GH-132606) (#132607)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-04-16 17:50:31 +00:00
Miss Islington (bot) 11617d5a7f
[3.13] Fix argument order in multinomial() example (gh-132557) (gh-132560) 2025-04-15 16:56:57 +00:00
Miss Islington (bot) bdff88b9aa
[3.13] gh-131803: Clarify that you must register signal handlers for set_wakeup_fd (GH-131859) (#132522)
gh-131803: Clarify that you must register signal handlers for set_wakeup_fd (GH-131859)
(cherry picked from commit 939476bbbb)

Co-authored-by: Jeremy Fleischman <jeremyfleischman@gmail.com>
2025-04-14 16:52:36 +00:00
Serhiy Storchaka d321b6ec82
[3.13] gh-132099: Harmonize Bluetooth address handling (GH-132486) (GH-132497)
Now all protocols always accept the Bluetooth address as string and
getsockname() always returns the Bluetooth address as string.

* BTPROTO_SCO now accepts not only bytes, but str.
* BTPROTO_SCO now checks address for embedded null.
* On *BSD, BTPROTO_HCI now accepts str instead of bytes.
* On FreeBSD, getsockname() for BTPROTO_HCI now returns str instead of bytes.
* On NetBSD and DragonFly BSD, BTPROTO_HCI now checks address for embedded null.
(cherry picked from commit 1fc1df8dcc)
2025-04-14 19:36:04 +03:00
Miss Islington (bot) fd0bba67c4
[3.13] gh-86513: improve docs of loop.call_exception_handler (GH-132466) (#132487)
gh-86513: improve docs of loop.call_exception_handler (GH-132466)
(cherry picked from commit ce753517a8)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-04-14 11:42:45 +00:00
Miss Islington (bot) f206b98c18
[3.13] gh-101100: Fix sphinx warnings in `library/plistlib.rst` (GH-132422) (#132485)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-04-13 18:41:56 +00:00
Miss Islington (bot) d021b719ed
[3.13] gh-132111: Document dataclasses.InitVar (GH-132446) (#132483)
gh-132111: Document dataclasses.InitVar (GH-132446)
(cherry picked from commit 281fc338fd)

Co-authored-by: Tapeline <mail@tapeline.dev>
2025-04-13 16:53:40 +00:00
Serhiy Storchaka 54e1b63333
[3.13] gh-132099: Fix documentation for the BTPROTO_HCI protocol (GH-132118) (GH-132482)
(cherry picked from commit 1d97488c95)
2025-04-13 16:27:41 +00:00
Vinay Sajip 1dcdac6e08
[3.13] gh-132106: Ensure that running `logging.handlers.QueueListener… (GH-132471)
Cherry-picked using 5863cd70b8
2025-04-13 13:00:50 +01:00