Commit graph

29034 commits

Author SHA1 Message Date
Miss Islington (bot)
2b84dfdf97
[3.13] Link to plaintext for "show source" links (GH-137131) (#137133)
Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2025-07-27 01:55:51 +00:00
Miss Islington (bot)
eda613438f
[3.13] Fix Queue.shutdown docs for condition to unblock a join (gh-137088) (gh-137102) 2025-07-25 08:48:28 -06:00
Miss Islington (bot)
d9feec4542
[3.13] Fix docs for Queue.shutdown (gh-137028) (gh-137081) 2025-07-24 11:54:42 -06:00
Miss Islington (bot)
2880798d0e
[3.13] gh-136516: Mention installation artifacts as de-facto resources (GH-136419) (GH-137039)
Files like NUL on windows are, from `importlib.resources` point of
view, an artifact caused by installing to a filesystem directory.
Mention these.
(cherry picked from commit fac4964fdb)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-07-24 09:01:12 +02:00
Miss Islington (bot)
6ffeef10b2
[3.13] gh-137043: mention PyList_GET_ITEM as unsafe borrowed API in free-threading docs (GH-137042) (#137046)
gh-137043: mention `PyList_GET_ITEM` as unsafe borrowed API in free-threading docs (GH-137042)
(cherry picked from commit 38b936cc99)

Co-authored-by: Guido Imperiale <crusaderky@gmail.com>
2025-07-23 14:42:53 +00:00
Miss Islington (bot)
9ab885e0a1
[3.13] gh-136437: Convert more `os.path` functions to positional-only in the docs (GH-136970) (#137001)
Co-authored-by: sobolevn <mail@sobolevn.me>
2025-07-22 13:44:36 +00:00
Miss Islington (bot)
82397064d2
[3.13] gh-136859: Improve StrEnum docs (GH-136864) (#136937)
Co-authored-by: Nacho Caballero <nachocab@gmail.com>
Co-authored-by: Nacho Caballero <nacho.caballero@astrazeneca.com>
Co-authored-by: Antonio Spadaro <ilovelinux@users.noreply.github.com>
2025-07-22 11:32:30 +03:00
Miss Islington (bot)
f4b991aef1
[3.13] gh-135468: Improve `BaseHandler.http_error_default()` parameter descriptions (GH-136797) (#136826)
Co-authored-by: Valerio Gianella <49408327+valeriogianella@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-07-22 11:29:59 +03:00
Miss Islington (bot)
2d0fac49d5
[3.13] gh-136437: Document os.path.dirname as accepting only pos-only (GH-136946) (#136948)
gh-136437: Document `os.path.dirname` as accepting only pos-only (GH-136946)
(cherry picked from commit 3224429450)

Co-authored-by: sobolevn <mail@sobolevn.me>
2025-07-21 18:28:55 +00:00
Miss Islington (bot)
133c233d23
[3.13] gh-136437: Document some os.path functions as requiring pos-only (GH-136812) (#136945)
gh-136437: Document some `os.path` functions as requiring pos-only (GH-136812)
(cherry picked from commit b5428bb0e7)

Co-authored-by: sobolevn <mail@sobolevn.me>
2025-07-21 18:07:56 +00:00
Miss Islington (bot)
de1c5e4f56
[3.13] Pedantic rewording of why relative importing doesn't work in main modules (GH-136846) (#136941)
Pedantic rewording of why relative importing doesn't work in main modules (GH-136846)

Pedantically reword the section about relative imports and main modules.
(cherry picked from commit 4b68289ca6)

Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
2025-07-21 09:58:32 -07:00
Miss Islington (bot)
3ee46ccb6a
[3.13] gh-136882: Update stale link in the basic logging tutorial. (GH-136885) (#136906)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-21 12:04:28 +03:00
Miss Islington (bot)
74607b139d
[3.13] gh-86608: Improve and restructure tarfile examples (GH-121771) (#136867)
gh-86608: Improve and restructure tarfile examples (GH-121771)

Add an example on how to write a tarfile to stdout; general improvements.
(cherry picked from commit cc81b4e501)

Co-authored-by: Dominic H <dom@dominic.sk>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-07-20 14:16:26 +01:00
Miss Islington (bot)
1172f4ccfe
[3.13] gh-136854: Exit on error in make venv (GH-136856) (#136861)
Co-authored-by: Nacho Caballero <nachocab@gmail.com>
Co-authored-by: Nacho Caballero <nacho.caballero@astrazeneca.com>
2025-07-20 12:14:42 +00:00
Miss Islington (bot)
c99fad72a1
[3.13] Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan information (GH-136790) (#136799)
Extends the documentation for disabling pymalloc with the `--without-pymalloc` flag regarding why it is worth to use it when enabling AddressSanitizer for Python build (which is done, e.g., in CPython's CI builds).


(cherry picked from commit d19bb44713)

Co-authored-by: Disconnect3d <dominik.b.czarnota@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-07-20 10:55:40 +02:00
Miss Islington (bot)
53aeb821d4
[3.13] gh-136752: Clarify documentation for `IPv{N}Address.is_reserved` (GH-136794) (#136828)
gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` (GH-136794)
(cherry picked from commit 6293d8a1a6)

Co-authored-by: Matthieu Lienart <50069805+mlnrt@users.noreply.github.com>
Co-authored-by: Matthieu Lienart <matthieu.lienart@axians.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-07-19 14:50:37 +00:00
Miss Islington (bot)
2d0f169b75
[3.13] gh-54732: Make argparse error caused by empty rows in option files explicit (GH-136795) (#136819)
gh-54732: Make argparse error caused by empty rows in option files explicit (GH-136795)
(cherry picked from commit 8ffc3ef01e)

Co-authored-by: jdunter <2ve@mailbox.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-07-19 14:28:57 +00:00
Miss Islington (bot)
ff8de16c10
[3.13] gh-135730: Clarify multiprocessing.Queue close() documentation (GH-136803) (GH-136807)
gh-135730: Clarify multiprocessing.Queue close() documentation (GH-136803)

Add a copy of the text from SimpleQueue.close()

---------
(cherry picked from commit f575588ccf)

Co-authored-by: aggshruti99 <aggshruti99@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-07-19 14:58:08 +02:00
Miss Islington (bot)
f32e095608
[3.13] gh-136769: Include fixed-width integers in the fundamental data types table (GH-136784) (#136786)
gh-136769: Include fixed-width integers in the fundamental data types table (GH-136784)

Fixed-sized types, like ``c_int32``, are currently missing from the fundamental data types table
in the ``ctypes`` documentation. This commit adds them, and  notes that ``c_[u]int8`` is an alias
of ``c_[u]byte``.
(cherry picked from commit acefb978dc)

Co-authored-by: Sina Zel taat <111974143+SZeltaat@users.noreply.github.com>
2025-07-19 10:25:37 +00:00
Miss Islington (bot)
96fac51a21
[3.13] Docs: Improve example for `itertools.batched()` (GH-136775) (#136779)
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:35:48 +00:00
Tian Gao
a45d3fd8be
[3.13] gh-136697: Use the standard audit event format for sys.monitor… (#136750)
* [3.13] 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 11:43:20 -07:00
Facundo Batista
46fe8e38c4
[3.13] Improved venv docs to indicate that isolation is the default. (GH-136698) (GH-136725)
(cherry picked from commit 8e2f4b4483)
2025-07-17 11:25:31 +01:00
Miss Islington (bot)
883223919f
[3.13] gh-126548: Add a thread-unsafety warning for importlib.reload() (GH-136704) (GH-136724)
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:22 +00:00
Miss Islington (bot)
894d30c650
[3.13] Fix index entry and anchor for module.__test__ (GH-136674) (GH-136689)
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:59:45 +00:00
Miss Islington (bot)
9c11745ede
[3.13] gh-136682: Remove incorrect statement that os.path.samestat accepts file-like objects (GH-136683) (#136685)
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:56:33 +00:00
Miss Islington (bot)
8517a890cf
[3.13] gh-72570: mention the incompatibility of XOFs with HMAC (GH-136676) (#136679)
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:10:10 +00:00
Miss Islington (bot)
592a31369e
[3.13] gh-136663: fix signatures of PyFloat_Pack/Unpack in docs (GH-136664) (#136667)
gh-136663: fix signatures of PyFloat_Pack/Unpack in docs (GH-136664)
(cherry picked from commit e4654e0b3e)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-07-15 05:37:55 +00:00
Miss Islington (bot)
2115e71ea5
[3.13] Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475)" (GH-136629) (#136647)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-14 13:19:40 +03:00
Miss Islington (bot)
ce21b1a250
[3.13] gh-42237: Link to complete list of codec aliases (GH-136625) (#136627)
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:28 +00:00
Miss Islington (bot)
fac28e4791
[3.13] gh-132346: Docs: Clarify that reference counts aren't stable between versions (GH-132352) (GH-136614)
gh-132346: Docs: Clarify that reference counts aren't stable between versions (GH-132352)
(cherry picked from commit 3dbe02ccd3)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-07-13 09:18:27 +00:00
Miss Islington (bot)
bec9bdf619
[3.13] gh-134833: improve docs for del s[i:j] in Mutable Sequence Types (GH-134834) (#136609)
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 06:03:33 +00:00
Miss Islington (bot)
39f36a1adf
[3.13] gh-101100: Fix sphinx warnings in Doc/library/platform.rst (GH-136562) (GH-136598)
(cherry picked from commit 47b01da4cc)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-12 18:23:04 +00:00
Serhiy Storchaka
01710af49d
[3.13] gh-101100: Fix sphinx warnings in Doc/library/functools.rst (GH-136424) (GH-136554)
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:13:07 +00:00
Miss Islington (bot)
f7f1448ffe
[3.13] gh-130160: use .. program:: directive for documenting venv CLI (GH-130699) (#136551)
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:04:03 +00:00
Miss Islington (bot)
175ada2806
[3.13] gh-76637: Note that undefined Codec is for testing (GH-136531) (#136537)
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:57:39 +00:00
Miss Islington (bot)
aa4bb1c685
[3.13] gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475) (#136533)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-11 12:43:52 +03:00
Miss Islington (bot)
81d1986297
[3.13] gh-82663: Clarify codecs.iterdecode/encode docs (GH-136497) (#136512)
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:27 +02:00
Miss Islington (bot)
15e9c3bc51
[3.13] gh-136209: Add .. c:var:: declarations for C exception types (GH-136210) (GH-136503)
(cherry picked from commit 85bc89f35f)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-07-10 15:10:51 +02:00
Miss Islington (bot)
d223739883
[3.13] gh-102740: Clarify time.monotonic() "system-wide" in the doc (GH-136431) (#136489)
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:59 +00:00
Miss Islington (bot)
2c2dd75941
[3.13] gh-136145: Define 'standard library' and 'stdlib' in the glossary (GH-136486)
(cherry picked from commit 92f392ad9e)

Co-authored-by: Zachary Ware <zach@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Éric <merwok@netwok.org>
2025-07-09 21:40:58 +00:00
Miss Islington (bot)
6c81051aa8
[3.13] gh-81520: Document unexpected os.path.ismount behaviour with btrfs subvolumes (GH-136058) (GH-136473)
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:02:49 +00:00
Miss Islington (bot)
217638588f
[3.13] gh-131825: Fix sqlite3 timezone-naive adapter recipe (GH-136270) (GH-136468)
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:13:02 +00:00
Miss Islington (bot)
7a548e26ac
[3.13] Docs: unittest.enterModuleContext is not a classmethod (GH-136464) (#136466)
Co-authored-by: Geoffrey Thomas <geofft@ldpreload.com>
2025-07-09 14:01:23 +00:00
Stan Ulbrych
a66af8b827
[3.13] gh-136162: Clean up encodings package documentation (#136456)
Remove docs of functions not yet implemented in 3.13
2025-07-09 10:41:22 +02:00
Miss Islington (bot)
21bcecfa2b
[3.13] gh-136162: Document encodings package functions (GH-136164) (#136453)
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:25 +02:00
Miss Islington (bot)
faee3625c3
[3.13] gh-53243: Document codecs.readbuffer_encode() (GH-136284) (#136451)
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:10 +02:00
Miss Islington (bot)
301c89ced8
[3.13] gh-94503: Update logging cookbook example with info on addressing log injection. (GH-136446) (GH-136450)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-09 09:00:07 +01:00
Miss Islington (bot)
c44070b2d5
[3.13] gh-101100: Fix sphinx warnings in Doc/library/exceptions.rst (GH-136309) (#136415)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-08 12:12:22 +00:00
Miss Islington (bot)
f17be28cd8
[3.13] gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds (GH-136187) (#136383)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2025-07-08 10:04:09 +03:00
Miss Islington (bot)
dcfc3d3cc2
[3.13] gh-101100: Fix sphinx warnings in whatsnew/3.11.rst (GH-136402) (#136404)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-08 06:46:32 +00:00