Commit graph

14085 commits

Author SHA1 Message Date
Miss Islington (bot)
ba6ea7c53d
[3.14] gh-74598: document that fnmatch.filterfalse is affected by cache limitation (GH-136781) (#136782)
gh-74598: document that `fnmatch.filterfalse` is affected by cache limitation (GH-136781)
(cherry picked from commit 263e451c41)

Co-authored-by: Gergely Elias <gergely.elias@gmail.com>
2025-07-19 09:56:55 +00:00
Miss Islington (bot)
aeeacdb8b5
[3.14] Docs: Improve example for `itertools.batched()` (GH-136775) (#136778)
Docs: Improve example for ``itertools.batched()`` (GH-136775)

The current example `batched('ABCDEFG', n=3) → ABC DEF G` can confuse readers because both, the size of the tuples and the number of tuples are 3.
By using a batch size of n=2, it is clearer that the `n` argument refers to the size of the resulting tuples.
I.e. the new example is: `batched('ABCDEFG', n=2) → AB CD EF G`
(cherry picked from commit 3eecc72ac7)

Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
2025-07-19 09:36:35 +00:00
Miss Islington (bot)
2ea3b75200
[3.14] gh-136697: Use the standard audit event format for sys.monitoring docs (GH-136747) (#136749)
gh-136697: Use the standard audit event format for sys.monitoring docs (GH-136747)
(cherry picked from commit 28937d3a21)

Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
2025-07-17 12:00:09 -07:00
Miss Islington (bot)
2ce207108c
[3.14] Improved venv docs to indicate that isolation is the default. (GH-136698) (GH-136705)
(cherry picked from commit 8e2f4b4483)
Co-authored-by: Facundo Batista <facundo@taniquetil.com.ar>
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2025-07-17 11:24:54 +01:00
Miss Islington (bot)
6943d8ef27
[3.14] gh-126548: Add a thread-unsafety warning for importlib.reload() (GH-136704) (GH-136723)
gh-126548: Add a thread-unsafety warning for `importlib.reload()` (GH-136704)
(cherry picked from commit 69d8fe50dd)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
2025-07-16 16:40:11 +00:00
Miss Islington (bot)
323974295d
[3.14] Fix index entry and anchor for module.__test__ (GH-136674) (GH-136688)
It was "doctest.module attribute". Now it is "module attribute".
(cherry picked from commit 7689407fa4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-07-15 15:58:52 +00:00
Miss Islington (bot)
c939963b53
[3.14] gh-136682: Remove incorrect statement that os.path.samestat accepts file-like objects (GH-136683) (#136684)
gh-136682: Remove incorrect statement that `os.path.samestat` accepts file-like objects (GH-136683)
(cherry picked from commit 7e10a103df)

Co-authored-by: Ran Benita <ran@unusedvar.com>
2025-07-15 12:59:38 +00:00
Miss Islington (bot)
45b72c447c
[3.14] gh-72570: mention the incompatibility of XOFs with HMAC (GH-136676) (#136678)
gh-72570: mention the incompatibility of XOFs with HMAC (GH-136676)
(cherry picked from commit a02cf19dee)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-07-15 12:09:54 +00:00
Miss Islington (bot)
55eaaab8a4
[3.14] gh-116738: Make grp module thread-safe (GH-135434) (#136658)
gh-116738: Make grp module thread-safe (GH-135434)

Make grp module methods getgrgid() and getgrnam() thread-safe when the GIL is disabled and getgrgid_r()/getgrnam_r() C APIs are not available.
---------
(cherry picked from commit 9363703bd3)

Co-authored-by: Alper <alperyoney@fb.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-07-15 11:03:33 +05:30
Miss Islington (bot)
bbbbb2e2d1
[3.14] Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475)" (GH-136629) (#136646)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-14 13:19:23 +03:00
Miss Islington (bot)
ed1e0cdc58
[3.14] gh-42237: Link to complete list of codec aliases (GH-136625) (#136626)
gh-42237: Link to complete list of codec aliases (GH-136625)

Closes GH-42237
(cherry picked from commit a93d9aaf62)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-13 13:19:23 +00:00
Miss Islington (bot)
e1dc08bd9a
[3.14] gh-134833: improve docs for del s[i:j] in Mutable Sequence Types (GH-134834) (#136608)
gh-134833: improve docs for `del s[i:j]` in `Mutable Sequence Types` (GH-134834)
(cherry picked from commit 609d5adc7c)

Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
2025-07-13 12:28:45 +05:30
Miss Islington (bot)
f50cd5bec7
[3.14] gh-134939: Correct concurrent.interpreters source code link (GH-136564) (#136605)
gh-134939: Correct `concurrent.interpreters` source code link (GH-136564)
(cherry picked from commit 42b251bceb)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-13 05:42:51 +00:00
Miss Islington (bot)
d351f29ef0
[3.14] gh-101100: Fix sphinx warnings in Doc/library/platform.rst (GH-136562) (GH-136597)
(cherry picked from commit 47b01da4cc)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-12 18:22:51 +00:00
Miss Islington (bot)
ac807cb3a0
[3.14] gh-101100: Fix sphinx warnings in Doc/library/functools.rst (GH-136424) (GH-136552)
Add index entries and anchors for cache_info, cache_clear and register.
(cherry picked from commit 252e2f710e)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-11 17:09:22 +00:00
Miss Islington (bot)
e4e86a1b87
[3.14] gh-130160: use .. program:: directive for documenting venv CLI (GH-130699) (#136550)
gh-130160: use `.. program::` directive for documenting `venv` CLI (GH-130699)
(cherry picked from commit fb9f933b8e)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
Co-authored-by: Semyon Moroz <donbarbos@proton.me>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-07-11 17:03:11 +00:00
Miss Islington (bot)
fdad31924c
[3.14] gh-76637: Note that undefined Codec is for testing (GH-136531) (#136536)
gh-76637: Note that `undefined` Codec is for testing (GH-136531)

Closes GH-76637
(cherry picked from commit 975b57d945)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-11 10:56:34 +00:00
Miss Islington (bot)
ec15251af5
[3.14] gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475) (#136532)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-11 09:43:52 +00:00
Miss Islington (bot)
326fe0df66
[3.14] gh-82663: Clarify codecs.iterdecode/encode docs (GH-136497) (#136513)
gh-82663: Clarify `codecs.iterdecode/encode` docs (GH-136497)

Closes GH-82663
(cherry picked from commit 4b41b2043b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-10 17:41:31 +02:00
Miss Islington (bot)
b733bf7437
[3.14] gh-102740: Clarify time.monotonic() "system-wide" in the doc (GH-136431) (#136488)
gh-102740: Clarify time.monotonic() "system-wide" in the doc (GH-136431)
(cherry picked from commit 9c4d287775)

Co-authored-by: Victor Stinner <vstinner@python.org>
2025-07-09 23:13:29 +00:00
Miss Islington (bot)
78359403c5
[3.14] gh-81520: Document unexpected os.path.ismount behaviour with btrfs subvolumes (GH-136058) (GH-136471)
gh-81520: Document unexpected `os.path.ismount` behaviour with btrfs subvolumes (GH-136058)
(cherry picked from commit 591abcc01f)

Co-authored-by: Oskar Roesler <o.roesler@oscloud.info>
2025-07-09 16:00:54 +00:00
Miss Islington (bot)
75640d4b1f
[3.14] gh-131825: Fix sqlite3 timezone-naive adapter recipe (GH-136270) (GH-136467)
gh-131825: Fix `sqlite3` timezone-naive adapter recipe (GH-136270)
(cherry picked from commit 6a6cd3c07c)

Co-authored-by: NekrodNIK <60639354+NekrodNIK@users.noreply.github.com>
2025-07-09 14:12:47 +00:00
Miss Islington (bot)
90717c2cec
[3.14] Docs: unittest.enterModuleContext is not a classmethod (GH-136464) (#136465)
Co-authored-by: Geoffrey Thomas <geofft@ldpreload.com>
2025-07-09 13:59:40 +00:00
Miss Islington (bot)
a9d2f08b57
[3.14] gh-136162: Document encodings package functions (GH-136164) (#136454)
gh-136162: Document `encodings` package functions (GH-136164)

Closes GH-136162.
(cherry picked from commit ffd7f2f231)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-09 10:07:34 +02:00
Miss Islington (bot)
85df16b7fa
[3.14] gh-53243: Document codecs.readbuffer_encode() (GH-136284) (#136452)
gh-53243: Document `codecs.readbuffer_encode()` (GH-136284)

Closes GH-53243
(cherry picked from commit f1dcf3c7bf)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-09 10:07:18 +02:00
Miss Islington (bot)
f0e603412b
[3.14] gh-101100: Fix sphinx warnings in Doc/library/exceptions.rst (GH-136309) (#136414)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-08 12:11:28 +00:00
Miss Islington (bot)
e1e9d95352
[3.14] gh-136032: Fix argparse.BooleanOptionalAction doc (GH-136133) (#136329)
gh-136032: Fix `argparse.BooleanOptionalAction` doc (GH-136133)
(cherry picked from commit 1953713d0d)

Co-authored-by: W. H. Wang <mattwang44@gmail.com>
2025-07-07 19:34:18 -07:00
Miss Islington (bot)
5a7d266fcb
[3.14] gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst (GH-136323) (#136389)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-07 19:50:56 +03:00
Miss Islington (bot)
a7dd48acba
[3.14] gh-86682: Add versionadded for sys._getframemodulename (GH-136325) (#136375)
gh-86682: Add versionadded for sys._getframemodulename (GH-136325)

add versionadded for sys._getframemodulename
(cherry picked from commit 11f074b243)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
2025-07-07 11:27:54 +00:00
Miss Islington (bot)
5df4f353ad
[3.14] gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) (GH-136370)
* Turn the __future__ table to list-table.
  This'll make it easier to add entries that need longer markup
* Semantic markup for __future__ feature descriptions.
* Document CO_* C macros.

(cherry picked from commit 2468aafe98)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-07-07 12:55:20 +02:00
Miss Islington (bot)
f02be2dfe8
[3.14] gh-101100: Fix sphinx warnings in whatsnew/3.9 (GH-136163) (#136372)
Co-authored-by: sobolevn <mail@sobolevn.me>
2025-07-07 10:48:04 +00:00
Miss Islington (bot)
aa1800b755
[3.14] gh-127502: Remove XML vulnerability table (GH-135294) (#136359)
gh-127502: Remove XML vulnerability table (GH-135294)

* Remove the table
* Replace warnings with notes

Latest releases of Python 3.9-3.15 include expat 2.7.1 which is not vulnerable.

expat 2.6.0 was released in February 2024.
(cherry picked from commit cb99d99277)

Co-authored-by: Victor Stinner <vstinner@python.org>
2025-07-07 09:08:41 +00:00
Miss Islington (bot)
bd97cb8229
[3.14] gh-109070: Document that get_context in multiprocessing have side effect (GH-136341) (GH-136343)
gh-109070: Document that get_context in multiprocessing have side effect (GH-136341)

Document that get_context in multiprocessing have side effect
(cherry picked from commit 77a8bd29da)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
2025-07-06 18:32:03 +00:00
Miss Islington (bot)
53584d307a
[3.14] gh-101100: Fix references in http.cookiejar docs (GH-136238) (GH-136318)
gh-101100: Fix references in `http.cookiejar` docs (GH-136238)
(cherry picked from commit f0c7344a8f)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-05 13:35:24 +00:00
Miss Islington (bot)
1a2898a383
[3.14] Docs: Move "or" outside monospace syntax in tarfile.rst (GH-136263) (GH-136290)
Docs: Move "or" outside monospace syntax in `tarfile.rst` (GH-136263)
(cherry picked from commit ade1988094)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2025-07-04 14:46:57 +00:00
Miss Islington (bot)
2449f77734
[3.14] Clarify some details regarding sys.monitoring (GH-133981) (GH-136259)
Clarify some details regarding `sys.monitoring` (GH-133981)
(cherry picked from commit b4991056f4)

Co-authored-by: Brett Cannon <brett@python.org>
2025-07-03 21:10:27 +00:00
Miss Islington (bot)
e39f33259e
[3.14] gh-135252: Document Zstandard integration across zipfile, shutil, and tarfile (GH-135311) (#136254)
gh-135252: Document Zstandard integration across zipfile, shutil, and tarfile (GH-135311)

Document Zstandard integration across zipfile, shutil, and tarfile
(cherry picked from commit 938a5d7e62)

Co-authored-by: Emma Smith <emma@emmatyping.dev>
2025-07-03 20:34:38 +00:00
Miss Islington (bot)
df4e87b153
[3.14] gh-136169: Update parameter name in fractions.from_float method (GH-136172) (#136174)
gh-136169: Update parameter name in fractions.from_float method (GH-136172)

Update parameter name in fractions.from_float method
(cherry picked from commit 9c0cb5beb8)

Co-authored-by: Vladyslav Lazoryk <80263725+lazorikv@users.noreply.github.com>
2025-07-01 13:31:16 +00:00
Miss Islington (bot)
ebab7c80ca
[3.14] gh-134939: Fill Out the concurrent.interpreters Docs (gh-136141)
(cherry picked from commit fc82cb91b, AKA gh-135902)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
2025-06-30 17:00:33 +00:00
Miss Islington (bot)
401032a53a
[3.14] gh-63207: Update time.time documentation after GH-116822 (GH-136068) (#136138)
gh-63207: Update `time.time` documentation after GH-116822 (GH-136068)
(cherry picked from commit 486587da42)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-06-30 16:16:08 +00:00
Miss Islington (bot)
71bd3d0647
[3.14] gh-136122: Fix video link for math.tau documentation (GH-136129) (#136131)
Co-authored-by: sedram <54665381+sedram@users.noreply.github.com>
2025-06-30 14:49:09 +00:00
Miss Islington (bot)
729b6747e9
[3.14] gh-48181: Document codecs.charmap_build (GH-135997) (#136123)
gh-48181: Document `codecs.charmap_build` (GH-135997)
(cherry picked from commit 2bdd50309f)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-06-30 15:52:46 +02:00
Miss Islington (bot)
ed7719a08d
[3.14] gh-131885: Update documented signatures for csv.{writer,reader} (GH-136085) (GH-136120)
gh-131885: Update documented signatures for `csv.{writer,reader}` (GH-136085)
(cherry picked from commit 75f40595e5)

Co-authored-by: Adam Dangoor <adamdangoor@gmail.com>
2025-06-30 13:38:57 +00:00
Miss Islington (bot)
130d40aa7b
[3.14] gh-132813: Fix the csv documentation for quoting and escaping (GH-133209) (#136113)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-06-30 07:47:29 +00:00
Miss Islington (bot)
231d801222
[3.14] gh-127604: Docs: Include a C stack in the faulthandler example (GH-136081) (GH-136102)
* gh-127604: Docs: Include a C stack in the `faulthandler` example (GH-136081)
(cherry picked from commit 3947847914)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-06-29 15:05:40 +00:00
Miss Islington (bot)
b99a417a6a
[3.14] Docs: Fix duplicate word typos (GH-135958) (GH-136007)
(cherry picked from commit 34ce1920ca)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
2025-06-27 00:05:53 +00:00
Miss Islington (bot)
8752b0815b
[3.14] gh-91555: add warning to docs about possibility of deadlock/infinite recursion (GH-135954) (GH-135988)
(cherry picked from commit a4625d597f)
2025-06-26 15:25:36 +01:00
Miss Islington (bot)
39bbf59a19
[3.14] Docs: Fix indentation in slice class of functions.rst (GH-134393) (#135948)
Docs: Fix indentation in `slice` class of `functions.rst` (GH-134393)

Paragraph should not be under `slice.step`. It applies to the whole class.

(cherry picked from commit 6227662ff3)

Co-authored-by: Rob Reynolds <13379223+reynoldsnlp@users.noreply.github.com>
2025-06-25 17:52:59 +00:00
Miss Islington (bot)
148f31f2d8
[3.14] gh-135648: Document that shutil.copyfileobj doesn't flush (GH-135737) (#135873)
Adds a note about flush/close on copyfileobj, and updates
the Emscripten build script to follow documented advice.
(cherry picked from commit 34393cbdd4)

Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
2025-06-24 01:22:07 +00:00
Miss Islington (bot)
c9cbe060a2
[3.14] Docs: Use arguments to replace args in argparse.rst (GH-135510) (GH-135866)
Docs: Use `arguments` to replace `args` in `argparse.rst` (GH-135510)
(cherry picked from commit caad163b69)

Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
2025-06-23 22:59:24 +00:00