Commit graph

29454 commits

Author SHA1 Message Date
Miss Islington (bot)
ae696e7847
[3.13] gh-141617: clarify concurrent.futures.ThreadPoolExecutor deadlock example (GH-141620) (#145687)
gh-141617: clarify `concurrent.futures.ThreadPoolExecutor` deadlock example (GH-141620)

---------
(cherry picked from commit 171133aa84)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2026-03-09 16:43:01 +00:00
Miss Islington (bot)
fd7da76ac0
[3.13] gh-145642: Docs: Avoid warning for invalid escape sequence in tutorial (GH-145643) (#145646)
gh-145642: Docs: Avoid warning for invalid escape sequence in tutorial (GH-145643)

---------
(cherry picked from commit 5a15a52dd1)

Co-authored-by: James <snoopjedi@gmail.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2026-03-09 00:04:57 +01:00
Miss Islington (bot)
26d587b395
[3.13] Remove typo in `functools.lru_cache` docs (GH-140278) (#145627)
Co-authored-by: Brandon Hubacher <brandon.hubacher@gmail.com>
2026-03-07 17:15:16 +00:00
Hugo van Kemenade
0021149a3a
[3.13] Docs: import datetime as dt in examples (GH-145315) (#145584) 2026-03-06 13:49:53 +02:00
Miss Islington (bot)
2ae3c92be1
[3.13] doc: Clarify logger creation example in logging HOWTO (GH-145540) (GH-145561)
(cherry picked from commit e0945443a0)

Co-authored-by: Yash Kaushik <yash005kaushik@gmail.com>
2026-03-06 08:51:02 +00:00
Miss Islington (bot)
0b4f366b5c
[3.13] Docs: use a Sphinx extension to eliminate excessive links (GH-145130) (#145574)
Docs: use a Sphinx extension to eliminate excessive links (GH-145130)
(cherry picked from commit 15f6479c41)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2026-03-06 08:50:06 +02:00
Miss Islington (bot)
0a239ddd39
[3.13] gh-145455: Show output of blurb & sphinx-build version commands (GH-145457) (GH-145462)
In gh-145455, an outdated dependency caused an import error that was not
printed out (`2>&1`); the message instead said that the tools are missing.

Don't redirect stderr, to show warnings and failures.

Also, switch `blurb` to output a version on a single line (`--version` rather
than `help`), and, and don't redirect stdout either.
This results in two version info lines being printed out. These get drowned
in typical Sphinx output, and can be helpful when debugging.
(cherry picked from commit f1de65b366)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-03-03 14:25:13 +01:00
Miss Islington (bot)
182a39799d
[3.13] GH-145450: Document missing wave.Wave_write getter methods (GH-145451) (GH-145467)
(cherry picked from commit db41717cd5)

Co-authored-by: Michiel W. Beijen <mb@x14.nl>
2026-03-03 12:51:20 +00:00
Miss Islington (bot)
5c77c7d944
[3.13] gh-106318: Fix incorrectly rendered code block in str.isalnum() docs (GH-144718) (GH-144729)
(cherry picked from commit f912c835b9)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-03-03 13:13:02 +01:00
Miss Islington (bot)
609a6f43e3
[3.13] Hide "object" prefix on dunders in contextlib docs & selectivly link some more (GH-145436) (#145444)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2026-03-02 21:19:05 +00:00
Miss Islington (bot)
0e57600bb7
[3.13] gh-145269: simplify bisect.bisect doc example (GH-145270) (#145368)
gh-145269: simplify bisect.bisect doc example (GH-145270)



---------
(cherry picked from commit fdb4b3527f)

Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
2026-03-01 00:20:20 +01:00
Miss Islington (bot)
67f6368e47
[3.13] gh-144693: Clarify that PyFrame_GetBack does not raise exceptions (GH-144824) (GH-145319)
gh-144693: Clarify that `PyFrame_GetBack` does not raise exceptions (GH-144824)
(cherry picked from commit 8775f90017)

Co-authored-by: Taegyun Kim <k.taegyun@gmail.com>
Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2026-02-27 15:31:49 +00:00
Miss Islington (bot)
cb3aba3a89
[3.13] gh-141004: Document missing type flags (GH-145127) (GH-145317)
gh-141004: Document missing type flags (GH-145127)
(cherry picked from commit dc1b56aa03)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2026-02-27 15:17:22 +00:00
Miss Islington (bot)
083477fbd6
[3.13] gh-106318: Add examples for str.rjust() method (GH-143890) (#145256)
Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-02-26 13:48:01 +00:00
Peter Bierma
56cc9ba645
[3.13] gh-141004: Document PyModuleDef_Type (GH-145043) (GH-145147)
(cherry picked from commit 24cc998c16)
2026-02-23 15:11:21 +00:00
Miss Islington (bot)
11c61b52d3
[3.13] gh-144694: Fix re.Match.group() doc claiming [1..99] range limit (GH-144696) (#145066)
gh-144694: Fix re.Match.group() doc claiming [1..99] range limit (GH-144696)

The documentation incorrectly stated that numeric group arguments
must be in the range [1..99]. This limit was removed in Python 3.5
(bpo-22437). Replace with "a positive integer" since the next
sentence already documents the IndexError for out-of-range values.
(cherry picked from commit 85021bc247)

Co-authored-by: Mohsin Mehmood <55545648+mohsinm-dev@users.noreply.github.com>
2026-02-21 05:42:39 +00:00
Miss Islington (bot)
c2a1fcbc05
[3.13] gh-144748: Document 3.12 and 3.14 changes to PyErr_CheckSignals (GH-144982) (GH-145063)
* gh-144748: Document 3.12 and 3.14 changes to `PyErr_CheckSignals` (GH-144982)
(cherry picked from commit 06292614ff)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-02-20 19:46:53 -05:00
Stan Ulbrych
6294569259
[3.13] Remove unused :platform: in module's docs (GH-144988) (GH-144998)
It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c084)
2026-02-19 12:13:53 +00:00
Miss Islington (bot)
cbecfbe792
[3.13] gh-144386: Update equivalent code for "with", "async with" and "async for" (GH-144472) (GH-144946)
They use special method lookup for special methods.
(cherry picked from commit 9e8fa2d4d1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2026-02-18 11:22:24 +00:00
Stan Ulbrych
ea07223716
[3.13] Fix typos and grammar errors across documentation (GH-144709) (#144804)
(cherry picked from commit 3718f4be60)

Co-authored-by: Ronald Eddy Jr <ronald_eddy@yahoo.com>
2026-02-17 12:56:29 +00:00
Miss Islington (bot)
e1dbe2263a
[3.13] gh-101100: Resolve reference warnings in reference/ (GH-138418) (#138681)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <stan@ulbrych.org>
2026-02-15 03:06:50 +00:00
Miss Islington (bot)
99a4e55f79
[3.13] gh-144706: Warn against using synchronization primitives within signal handlers (GH-144736) (GH-144768)
gh-144706: Warn against using synchronization primitives within signal handlers (GH-144736)
(cherry picked from commit 945bf8ce1b)

Co-authored-by: Robsdedude <dev@rouvenbauer.de>
2026-02-12 23:21:26 +00:00
Miss Islington (bot)
99cc3d1842
[3.13] gh-57095: Add note about input splitting in datetime.*.strptime (GH-131049) (GH-144734)
(cherry picked from commit 2e3e76e5cd)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-02-12 11:44:42 +01:00
Stan Ulbrych
9a57c932ec
[3.13] Itertools recipes: Replace the tabulate() example with running_mean() (gh-144483) (gh-144722) 2026-02-12 00:24:00 -06:00
Lysandros Nikolaou
05c9474ed9
[3.13] gh-142518: Define lock-free and per-object lock (GH-144548) (#144707)
(cherry picked from commit 12dbae4c02)
2026-02-11 18:08:49 +01:00
Miss Islington (bot)
a5b1952d24
[3.13] gh-106318: Improve str.rstrip() method doc (GH-143893) (#144698)
gh-106318: Improve str.rstrip() method doc (GH-143893)
(cherry picked from commit 936d60dbe1)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-11 08:48:28 +00:00
Miss Islington (bot)
c49835a51c
[3.13] Clarify the docs for args in asyncio callbacks (GH-143873) (#144664)
Clarify the docs for `args` in asyncio callbacks (GH-143873)
(cherry picked from commit 40a82abe93)

Co-authored-by: Aarni Koskela <akx@iki.fi>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2026-02-10 13:16:12 +00:00
Miss Islington (bot)
6884288570
[3.13] gh-106318: Add examples for str.partition() method (GH-142823) (#144612)
gh-106318: Add examples for str.partition() method (GH-142823)
(cherry picked from commit 432ddd99e2)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-02-08 22:16:49 +00:00
Miss Islington (bot)
43b9344114
[3.13] gh-106318: Add example for str.isalnum() (GH-137550) (#144610)
gh-106318: Add example for str.isalnum() (GH-137550)
(cherry picked from commit 3dd7a3c65a)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2026-02-08 22:15:45 +00:00
Miss Islington (bot)
57aaee56cb
[3.13] For enum.bin, update versionadded directive from 3.10 to 3.11 (GH-144574) (#144589)
For `enum.bin`, update versionadded directive from 3.10 to 3.11 (GH-144574)
(cherry picked from commit d73634935c)

Co-authored-by: Guo Ci <zguoci@gmail.com>
2026-02-08 07:43:22 +00:00
Miss Islington (bot)
e6e0171357
[3.13] gh-143700: document secrets.DEFAULT_ENTROPY as an opaque value (GH-144568) (#144580)
gh-143700: document `secrets.DEFAULT_ENTROPY` as an opaque value (GH-144568)
(cherry picked from commit 934997218e)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2026-02-07 22:44:03 +00:00
Miss Islington (bot)
51ff5f376b
[3.13] gh-142044: Add note to prefer asyncio.timeout[_at] over asyncio.Timeout (GH-144449) (#144566)
gh-142044: Add note to prefer `asyncio.timeout[_at]` over `asyncio.Timeout` (GH-144449)
(cherry picked from commit 0e7c06a858)

Co-authored-by: kovan <xaum.io@gmail.com>
2026-02-07 13:31:35 +01:00
Miss Islington (bot)
7d04956d4a
[3.13] gh-144484: Warn users not to use wsgiref in production (#144512)
gh-144484: Warn users not to use wsgiref in production
(cherry picked from commit 7e777c587f)

Co-authored-by: Seth Michael Larson <seth@python.org>
2026-02-05 18:22:07 +02:00
Miss Islington (bot)
d5d4d2c36f
[3.13] gh-144148: Update the urllib.parse documentation (GH-144497) (GH-144507) (GH-144509)
(cherry picked from commit 2fb9cde118)

Document urlsplit() as the main parsing function and urlparse() as
an obsolete variant.
(cherry picked from commit 67ddba9aa9)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2026-02-05 15:47:52 +00:00
Miss Islington (bot)
65acd01693
[3.13] gh-106318: Add examples for str.startswith() method (GH-144369) (#144480)
gh-106318: Add examples for `str.startswith()` method (GH-144369)
(cherry picked from commit 1b6d737ee0)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-02-04 17:24:35 +00:00
Miss Islington (bot)
7f3939338a
[3.13] gh-141004: Document remaining pyport.h utility macros (GH-144279) (GH-144478)
gh-141004: Document remaining `pyport.h` utility macros (GH-144279)
(cherry picked from commit 914fbec214)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2026-02-04 16:49:59 +00:00
Miss Islington (bot)
e5d8b783e8
[3.13] gh-141444: Replace dead URL in urllib.robotparser example (GH-144443) (#144465)
Co-authored-by: kovan <217326+kovan@users.noreply.github.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-04 11:36:32 +00:00
Miss Islington (bot)
ad5bd4ad47
[3.13] gh-127313: Use getLogger() without argument to get root logger in logging cookbook (GH-143683) (GH-144432)
gh-127313: Use getLogger() without argument to get root logger in logging cookbook (GH-143683)

Use getLogger() to get root logger in logging cookbook
(cherry picked from commit 53fecbe6e1)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
2026-02-03 14:55:25 +00:00
Miss Islington (bot)
5e888993e4
[3.13] gh-74453: Add stronger security warning to os.path.commonprefix
gh-74453: Add stronger security warning to os.path.commonprefix (GH-144401)
(cherry picked from commit 4e15b8d95d)

Co-authored-by: Seth Michael Larson <seth@python.org>
2026-02-03 14:16:28 +00:00
Miss Islington (bot)
44820648e6
[3.13] gh-106318: Add examples for str.rindex() method (GH-143887) (#144422)
gh-106318: Add examples for str.rindex() method (GH-143887)
(cherry picked from commit 45d00a0791)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2026-02-03 14:36:32 +01:00
Guo Ci
b4a84bc555
[3.13] gh-140806: add docs for enum.bin function (#140807) (#143740)
(cherry picked from commit 7f50a5febd)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2026-02-02 22:57:53 +01:00
Nathan Goldbaum
b5129b89bb
[3.13] gh-144257: document return values of PyModule_SetDocString (GH-144258) (GH-144286)
(cherry picked from commit 3e9a5b022f)

Co-authored-by: sobolevn <mail@sobolevn.me>
2026-01-27 18:30:48 +00:00
Miss Islington (bot)
d6f4fb867a
[3.13] gh-142119: Clarify that one contextvars.Token can only reset once in a lifetime (GH-143693) (GH-144267)
(cherry picked from commit 487bd2dea5)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
2026-01-27 11:39:20 +01:00
Miss Islington (bot)
f9f0a78f1c
[3.13] gh-101888: Add function.__builtins__ to ref documentation (GH-144174) (#144253)
gh-101888: Add function.__builtins__ to ref documentation (GH-144174)
(cherry picked from commit 933540e332)

Co-authored-by: Victor Stinner <vstinner@python.org>
2026-01-26 16:22:31 +00:00
Miss Islington (bot)
01c18767f0
[3.13] gh-143928: Remove outdated comparison between pickle and marshal regarding recursion (GH-144025) (#144247)
gh-143928: Remove outdated comparison between pickle and marshal regarding recursion (GH-144025)
(cherry picked from commit 923d9d2ac2)

Co-authored-by: Yashraj <yashrajpala8@gmail.com>
2026-01-26 13:45:22 +00:00
Miss Islington (bot)
ef5bc9ec9b
[3.13] gh-144233: Fix typo in os.eventfd documentation (GH-144234) (#144237)
gh-144233: Fix typo in os.eventfd documentation (GH-144234)
(cherry picked from commit 9982147433)

Co-authored-by: Solomon Ritzow <11698787+ritzow@users.noreply.github.com>
2026-01-26 08:16:06 +00:00
Miss Islington (bot)
918387e491
[3.13] gh-143919: Reject control characters in http cookies (#144090)
gh-143919: Reject control characters in http cookies
(cherry picked from commit 95746b3a13)

Co-authored-by: Seth Michael Larson <seth@python.org>
Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
2026-01-25 17:09:22 +00:00
Miss Islington (bot)
a47f1b14f6
[3.13] Programming FAQ: fix some punctuaction typos (GH-144058) (#144186)
Programming FAQ: fix some punctuaction typos (GH-144058)

(cherry picked from commit 03e651d601)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2026-01-25 17:09:04 +00:00
Miss Islington (bot)
cbfebb1bc5
[3.13] gh-144027: Fix documentation for ignorechars in base64.a85decode() (GH-144028) (GH-144193)
It does not support an ASCII string.

Also add more tests.
(cherry picked from commit 25a10b60b0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2026-01-23 19:19:22 +00:00
Miss Islington (bot)
62489c8533
[3.13] Doc: fix incorrect reference in isasyncgenfunction docs (GH-144099) (GH-144171)
(cherry picked from commit f3dd0cae6c)

Co-authored-by: Yongtao Huang <yongtaoh2022@gmail.com>
2026-01-23 11:35:27 +01:00