Commit graph

13746 commits

Author SHA1 Message Date
Miss Islington (bot)
298ce3364c
[3.13] Docs: Use the correct example module in warnings.rst (GH-137402) (#137493)
Co-authored-by: Mendel Feygelson <mfeygelson@gmail.com>
2025-08-06 21:58:11 +00:00
Miss Islington (bot)
db4df35384
[3.13] gh-123441: Correct the supported languages of the iso-8859-4 codec (GH-137034) (GH-137418)
(cherry picked from commit 525784aa65)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-08-05 15:02:57 +00:00
Sergey B Kirpichev
dc980b0ed6
[3.13] gh-122450: Expand documentation for `Rational and Fraction` (#136800) (#137367)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-08-05 14:54:31 +01:00
Serhiy Storchaka
1c96723cb1
[3.13] gh-137341: Remove more word duplications (GH-137342) (GH-137347)
(cherry picked from commit 1612dcbafe)
2025-08-03 17:24:26 +00:00
Miss Islington (bot)
7adea430c1
Doc: remove unused images (GH-137323)
(cherry picked from commit f195c28030)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2025-08-03 14:28:52 +09:00
Petr Viktorin
3b28cb0f3f
[3.13] gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) (GH-136371)
* 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-08-02 16:19:20 +02:00
Miss Islington (bot)
d3b5f838ec
[3.13] GH-116738: document thread-safety of bisect (GH-136555) (#137222)
* GH-116738: document thread-safety of bisect (GH-136555)
(cherry picked from commit 5236b0281b)

Co-authored-by: Neil Schemenauer <nas-github@arctrix.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2025-07-30 11:50:39 +00:00
Miss Islington (bot)
d61f8b841d
[3.13] gh-137183: Document that array.array typecode w is new in 3.13 (GH-137184) (GH-137209)
(cherry picked from commit 0b4e13c265)

Co-authored-by: Akuli <akuviljanen17@gmail.com>
2025-07-29 18:45:08 +02:00
Miss Islington (bot)
505e2a4a2d
[3.13] gh-119711: describe create_datagram_endpoint's behavior in asyncio when local_addr is None (GH-136913) (#137163)
gh-119711: describe `create_datagram_endpoint`'s behavior in asyncio when `local_addr` is `None` (GH-136913)
(cherry picked from commit 1481384141)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
2025-07-28 11:03:08 +00:00
Brian Schubert
c2b8a89d94
[3.13] gh-84559: improve What's New entry for multiprocessing startmethod changes (GH-128173) (#137156)
[3.13] gh-84559: improve What's New entry for `multiprocessing` start method changes (GH-128173)
(cherry picked from commit b8c313a41c)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-07-27 18:12:16 -07:00
Miss Islington (bot)
97f5fdf567
[3.13] gh-136992: Add "None" as valid SameSite value as per RFC 6265bis (GH-137040) (#137141)
gh-136992: Add "None" as valid `SameSite` value as per RFC 6265bis (GH-137040)

The "SameSite" attribute defined in RFC 6265bis [1] allows the "Strict", "Lax" and "None"
enforcement modes. We already documented "Strict" and "Lax" as being valid values
but "None" was missing from the list. While the RFC has not been formally approved,
modern browsers support the "None" value [2, 3] thereby making sense to document it.

[1]: https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-rfc6265bis
[2]: https://developers.google.com/search/blog/2020/01/get-ready-for-new-samesitenone-secure
[3]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#none

---------
(cherry picked from commit ae8b7d7100)

Co-authored-by: Iqra Khan <iqraakhan2519@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-07-27 22:08:46 +02:00
Miss Islington (bot)
f867711df0
[3.13] gh-132898: Add a note in multiprocessing.Process docs about creating a process in a REPL (GH-137118) (#137155)
gh-132898: Add a note in `multiprocessing.Process` docs about creating a process in a REPL (GH-137118)

* Reword, expand, and clarify the limitation, highlighting the REPL case.
* Mention in the high level Process description.
* added a pointer to the GH issue from the doc note

---------
(cherry picked from commit 4e40f2bea7)

Co-authored-by: Duprat <yduprat@gmail.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2025-07-27 20:05:39 +00:00
Miss Islington (bot)
81079d7b1a
[3.13] gh-136278: Document codecs.escape_encode() and codecs.escape_decode() (GH-136314) (#137150)
gh-136278: Document codecs.escape_encode() and codecs.escape_decode() (GH-136314)

Closes GH-136278
(cherry picked from commit 6784ef7da7)

Co-authored-by: Toshaksha <147024929+Toshaksha@users.noreply.github.com>
2025-07-27 16:44:25 +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)
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)
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)
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)
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)
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)
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)
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)
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