Commit graph

28869 commits

Author SHA1 Message Date
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)
a98d46a9aa
[3.13] gh-133644: update Py_InteractiveFlag deprecation notice (GH-133749) (#133752)
gh-133644: update `Py_InteractiveFlag` deprecation notice (GH-133749)
(cherry picked from commit 3ed8d6fdd1)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-05-09 13:48:58 +00:00
Miss Islington (bot)
eefe7e22b8
[3.13] Doc: Allow translating a code block in the tutorial (GH-131353) (#133649)
Doc: Allow translating a code block in the tutorial (GH-131353)
(cherry picked from commit 3224b99872)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-05-08 09:29:34 +00:00
Miss Islington (bot)
a063d6c794
[3.13] gh-127833: lexical analysis: Add backticks to BOM example (GH-132407) (#133633)
gh-127833: lexical analysis: Add backticks to BOM example (GH-132407)
(cherry picked from commit 0552ce0fb2)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-05-08 01:42:05 +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
Brandt Bucher
3f93295bbe
[3.13] GH-133231: Backport PYTHON_JIT documentation to 3.13 (GH-133539) 2025-05-06 21:31:54 +00: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)
679e632c5e
[3.13] gh-132246: Add PEP 688 to C Buffer Protocol docs (GH-132249) (#132282)
gh-132246: Add PEP 688 to C Buffer Protocol docs (GH-132249)
(cherry picked from commit 8421b648e9)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
2025-05-01 12:09:33 +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
Stan Ulbrych
ff4134603a
[3.13] gh-46236: Document PyUnicodeIter_Type (GH-132925) (GH-133149)
gh-46236: Document `PyUnicodeIter_Type` (GH-132925)

(cherry picked from commit bba14c3e01)

# Conflicts:
#	Doc/c-api/unicode.rst
2025-04-29 18:11:31 +02:00
Miss Islington (bot)
dcbda412a1
[3.13] gh-57281: Fix duplicate deprecation note: array 'u' format (GH-133113) (#133147)
gh-57281: Fix duplicate deprecation note: array 'u' format (GH-133113)
(cherry picked from commit 59ff42155a)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-04-29 11:30:03 +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
Hugo van Kemenade
2c9842f7ac
[3.13] doc: update co_flags reference (GH-132300) (#132936)
Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2025-04-26 21:47:51 +03:00
Bénédikt Tran
7ebfc6ec5e
[3.13] gh-132909: handle overflow for 'K' format in do_mkvalue (GH-132911) (#132932)
(cherry picked from commit 3fa024dec3)
2025-04-25 12:44:53 +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)
52e0f564d0
[3.13] Fix a grammar error in the Py_ALWAYS_INLINE doc (GH-129304) (#132877)
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
2025-04-24 14:27:41 +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)
ca2e1a1e1c
[3.13] gh-130861: Add clarification to the perf docs on optimization levels (GH-131098) (#132687) 2025-04-18 13:48:23 +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)
7d4c00e7c5
[3.13] Docs: Migrate entirely to PSF hosted plausible for analytics (GH-132648) (#132660)
Docs: Migrate entirely to PSF hosted plausible for analytics (GH-132648)
(cherry picked from commit 1d529cbc89)

Co-authored-by: Ee Durbin <ewdurbin@gmail.com>
2025-04-18 05:02:18 +01: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)
2a1a337d28
[3.13] Docs: Synchronise `indexsidebar.html` with docsbuild-scripts (GH-132567) (#132573)
Docs: Synchronise ``indexsidebar.html`` with docsbuild-scripts (GH-132567)
(cherry picked from commit 4f10b93d1b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-15 23:42:27 +01: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
Victor Stinner
866b6359e5
[3.13] gh-46236: Add missing PyUnicode_FromOrdinal() doc (#132040) (#132521)
gh-46236: Add missing PyUnicode_FromOrdinal() doc (#132040)

(cherry picked from commit 8768df2fe9)

Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
2025-04-14 16:48:40 +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