summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] Docs: add dunder and walrus to the glossary (GH-137430) (#137435)Miss Islington (bot)2025-08-051-0/+10
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.13] gh-136823: Update documentation on excluded headers in Python.h ↵Miss Islington (bot)2025-08-051-6/+31
| | | | | | | (GH-136824) (#137438) Co-authored-by: Sina Zel taat <111974143+SZeltaat@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* [3.13] GH-136155: Use ``sphinxext-opengraph`` v0.12.0 (GH-137393) (#137432)Miss Islington (bot)2025-08-052-12/+9
| | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-123441: Correct the supported languages of the iso-8859-4 codec ↵Miss Islington (bot)2025-08-051-1/+1
| | | | | | | (GH-137034) (GH-137418) (cherry picked from commit 525784aa65d35a5609aba53c873a9a3a578f992b) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-122450: Expand documentation for ``Rational`` and ``Fraction`` ↵Sergey B Kirpichev2025-08-052-6/+7
| | | | | | | (#136800) (#137367) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] GH-136155: Use ``sphinxext-opengraph`` v0.11.0 (GH-137348) (#137350)Miss Islington (bot)2025-08-031-1/+1
| | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-137341: Remove more word duplications (GH-137342) (GH-137347)Serhiy Storchaka2025-08-031-1/+1
| | | (cherry picked from commit 1612dcbafe763014deefd679fe75ac5831a14a43)
* Doc: remove unused images (GH-137323)Miss Islington (bot)2025-08-032-0/+0
| | | | | (cherry picked from commit f195c2803002d4a4827c61171d8c327e230842b6) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* [3.13] gh-135755: Document __future__.* and CO_* as proper Sphinx objects ↵Petr Viktorin2025-08-023-34/+110
| | | | | | | | | | | | (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 2468aafe984fdf923811ef0c6969e3d6c1b92a82) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] GH-133136: Revise QSBR to reduce excess memory held (gh-135473) ↵Neil Schemenauer2025-07-301-8080/+8145
| | | | | | | | | | | | | | | | | | | | | | | | | | (gh-136480) The free threading build uses QSBR to delay the freeing of dictionary keys and list arrays when the objects are accessed by multiple threads in order to allow concurrent reads to proceed with holding the object lock. The requests are processed in batches to reduce execution overhead, but for large memory blocks this can lead to excess memory usage. Take into account the size of the memory block when deciding when to process QSBR requests. Also track the amount of memory being held by QSBR for mimalloc pages. Advance the write sequence if this memory exceeds a limit. Advancing the sequence will allow it to be freed more quickly. Process the held QSBR items from the "eval breaker", rather than from `_PyMem_FreeDelayed()`. This gives a higher chance that the global read sequence has advanced enough so that items can be freed. (cherry picked from commit 113de8545ffe74a4a1dddb9351fa1cbd3562b621) Co-authored-by: Neil Schemenauer <nas-github@arctrix.com> Co-authored-by: Sam Gross <colesbury@gmail.com>
* [3.13] GH-116738: document thread-safety of bisect (GH-136555) (#137222)Miss Islington (bot)2025-07-301-0/+10
| | | | | | | * GH-116738: document thread-safety of bisect (GH-136555) (cherry picked from commit 5236b0281b91a874b14cf15f3fdef9b7beffb22f) Co-authored-by: Neil Schemenauer <nas-github@arctrix.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org>
* [3.13] gh-137183: Document that `array.array` typecode `w` is new in 3.13 ↵Miss Islington (bot)2025-07-291-1/+4
| | | | | | | (GH-137184) (GH-137209) (cherry picked from commit 0b4e13c2658c5a267fc50ee045ffb7b6408b2e3b) Co-authored-by: Akuli <akuviljanen17@gmail.com>
* [3.13] gh-119711: describe `create_datagram_endpoint`'s behavior in asyncio ↵Miss Islington (bot)2025-07-281-0/+6
| | | | | | | | 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 1481384141342479b3ba4b89f653b4e5bef0d272) Co-authored-by: AN Long <aisk@users.noreply.github.com>
* [3.13] gh-84559: improve What's New entry for `multiprocessing` startmethod ↵Brian Schubert2025-07-281-0/+9
| | | | | | | | | | changes (GH-128173) (#137156) [3.13] gh-84559: improve What's New entry for `multiprocessing` start method changes (GH-128173) (cherry picked from commit b8c313a41c411331c603bbda28048b2a3f4a2ab4) 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>
* [3.13] gh-136992: Add "None" as valid `SameSite` value as per RFC 6265bis ↵Miss Islington (bot)2025-07-271-3/+6
| | | | | | | | | | | | | | | | | | | | (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 ae8b7d710020dfd336edd399fa35525dfe8fc049) Co-authored-by: Iqra Khan <iqraakhan2519@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-132898: Add a note in `multiprocessing.Process` docs about ↵Miss Islington (bot)2025-07-272-8/+53
| | | | | | | | | | | | | | | 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 4e40f2bea7edfa5ba7e2e0e6159d9da9dfe4aa97) Co-authored-by: Duprat <yduprat@gmail.com> Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.13] gh-136278: Document codecs.escape_encode() and codecs.escape_decode() ↵Miss Islington (bot)2025-07-271-0/+30
| | | | | | | | | | (GH-136314) (#137150) gh-136278: Document codecs.escape_encode() and codecs.escape_decode() (GH-136314) Closes GH-136278 (cherry picked from commit 6784ef7da7cbf1a944fd0685630ced54e4a0066c) Co-authored-by: Toshaksha <147024929+Toshaksha@users.noreply.github.com>
* [3.13] Link to plaintext for "show source" links (GH-137131) (#137133)Miss Islington (bot)2025-07-271-1/+1
| | | | Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
* [3.13] Fix Queue.shutdown docs for condition to unblock a join (gh-137088) ↵Miss Islington (bot)2025-07-252-6/+8
| | | | (gh-137102)
* [3.13] Fix docs for Queue.shutdown (gh-137028) (gh-137081)Miss Islington (bot)2025-07-242-25/+54
|
* [3.13] gh-136516: Mention installation artifacts as de-facto resources ↵Miss Islington (bot)2025-07-241-5/+6
| | | | | | | | | | (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 fac4964fdb2ae12969b485de496dd6d064fdbe99) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-137043: mention `PyList_GET_ITEM` as unsafe borrowed API in ↵Miss Islington (bot)2025-07-231-0/+2
| | | | | | | | 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 38b936cc9912fc6847265917f94af53f0bf228e9) Co-authored-by: Guido Imperiale <crusaderky@gmail.com>
* [3.13] gh-136437: Convert more ``os.path`` functions to positional-only in ↵Miss Islington (bot)2025-07-221-9/+9
| | | | | | the docs (GH-136970) (#137001) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.13] gh-136859: Improve `StrEnum` docs (GH-136864) (#136937)Miss Islington (bot)2025-07-221-4/+19
| | | | | | 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>
* [3.13] gh-135468: Improve ``BaseHandler.http_error_default()`` parameter ↵Miss Islington (bot)2025-07-221-4/+7
| | | | | | | 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>
* [3.13] gh-136437: Document `os.path.dirname` as accepting only pos-only ↵Miss Islington (bot)2025-07-211-1/+1
| | | | | | | | (GH-136946) (#136948) gh-136437: Document `os.path.dirname` as accepting only pos-only (GH-136946) (cherry picked from commit 322442945084ea9055f86a17fa5096b11ba5b344) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.13] gh-136437: Document some `os.path` functions as requiring pos-only ↵Miss Islington (bot)2025-07-211-8/+8
| | | | | | | | (GH-136812) (#136945) gh-136437: Document some `os.path` functions as requiring pos-only (GH-136812) (cherry picked from commit b5428bb0e786f5b67c6077472c0068cadd0b5ea9) Co-authored-by: sobolevn <mail@sobolevn.me>
* [3.13] Pedantic rewording of why relative importing doesn't work in main ↵Miss Islington (bot)2025-07-211-2/+2
| | | | | | | | | | 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 4b68289ca6954b8d135e2ee2344e67fae38239fd) Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
* [3.13] gh-136882: Update stale link in the basic logging tutorial. ↵Miss Islington (bot)2025-07-211-4/+4
| | | | | | | (GH-136885) (#136906) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-86608: Improve and restructure tarfile examples (GH-121771) (#136867)Miss Islington (bot)2025-07-201-12/+28
| | | | | | | | | 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 cc81b4e501138b5793d419c81c3a2859a17207a7) Co-authored-by: Dominic H <dom@dominic.sk> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-136854: Exit on error in `make venv` (GH-136856) (#136861)Miss Islington (bot)2025-07-201-0/+1
| | | | | Co-authored-by: Nacho Caballero <nachocab@gmail.com> Co-authored-by: Nacho Caballero <nacho.caballero@astrazeneca.com>
* [3.13] Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan ↵Miss Islington (bot)2025-07-202-0/+7
| | | | | | | | | | | 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 d19bb4471331ca2cb87b86e4c904bc9a2bafb044) Co-authored-by: Disconnect3d <dominik.b.czarnota@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` ↵Miss Islington (bot)2025-07-191-1/+11
| | | | | | | | | | (GH-136794) (#136828) gh-136752: Clarify documentation for ``IPv{N}Address.is_reserved`` (GH-136794) (cherry picked from commit 6293d8a1a648a498b7ac899631b74fa25c71c1ac) 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>
* [3.13] gh-54732: Make argparse error caused by empty rows in option files ↵Miss Islington (bot)2025-07-191-1/+7
| | | | | | | | | explicit (GH-136795) (#136819) gh-54732: Make argparse error caused by empty rows in option files explicit (GH-136795) (cherry picked from commit 8ffc3ef01e83ffe629c6107082677de4d23974d5) Co-authored-by: jdunter <2ve@mailbox.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-135730: Clarify multiprocessing.Queue close() documentation ↵Miss Islington (bot)2025-07-191-2/+7
| | | | | | | | | | | | | (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 f575588ccf27d8d54a1e99cfda944f2614b3255c) Co-authored-by: aggshruti99 <aggshruti99@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-136769: Include fixed-width integers in the fundamental data types ↵Miss Islington (bot)2025-07-191-2/+18
| | | | | | | | | | | | 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 acefb978dcb5dd554e3c49a3015ee5c2ad6bfda1) Co-authored-by: Sina Zel taat <111974143+SZeltaat@users.noreply.github.com>
* [3.13] Docs: Improve example for ``itertools.batched()`` (GH-136775) (#136779)Miss Islington (bot)2025-07-191-2/+2
| | | | | | | | | | 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 3eecc72ac70943f7e33297eea17803af15322c88) Co-authored-by: RafaelWO <38643099+RafaelWO@users.noreply.github.com>
* [3.13] gh-136697: Use the standard audit event format for sys.monitor… ↵Tian Gao2025-07-171-2/+1
| | | | | | | | (#136750) * [3.13] gh-136697: Use the standard audit event format for sys.monitoring docs (GH-136747) (cherry picked from commit 28937d3a21cf8168c853ae43374a8287c21f71c9) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
* [3.13] Improved venv docs to indicate that isolation is the default. ↵Facundo Batista2025-07-171-3/+3
| | | | | | (GH-136698) (GH-136725) (cherry picked from commit 8e2f4b448380b4c835442534d566618f06e32573)
* [3.13] gh-126548: Add a thread-unsafety warning for `importlib.reload()` ↵Miss Islington (bot)2025-07-161-0/+4
| | | | | | | | (GH-136704) (GH-136724) gh-126548: Add a thread-unsafety warning for `importlib.reload()` (GH-136704) (cherry picked from commit 69d8fe50ddc4dbe757c9929a532e2e882f0261ba) Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
* [3.13] Fix index entry and anchor for module.__test__ (GH-136674) (GH-136689)Miss Islington (bot)2025-07-151-0/+4
| | | | | | It was "doctest.module attribute". Now it is "module attribute". (cherry picked from commit 7689407fa4406ab79d7e9e02363f50be4ec35b5e) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-136682: Remove incorrect statement that `os.path.samestat` accepts ↵Miss Islington (bot)2025-07-151-3/+0
| | | | | | | | 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 7e10a103dfe52feb0ef3d541e08abc2640838101) Co-authored-by: Ran Benita <ran@unusedvar.com>
* [3.13] gh-72570: mention the incompatibility of XOFs with HMAC (GH-136676) ↵Miss Islington (bot)2025-07-151-0/+3
| | | | | | | | (#136679) gh-72570: mention the incompatibility of XOFs with HMAC (GH-136676) (cherry picked from commit a02cf19deed353d1e0e7564468f10aced61c12e8) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-136663: fix signatures of PyFloat_Pack/Unpack in docs (GH-136664) ↵Miss Islington (bot)2025-07-151-6/+6
| | | | | | | | (#136667) gh-136663: fix signatures of PyFloat_Pack/Unpack in docs (GH-136664) (cherry picked from commit e4654e0b3e7d802c8fe984cf39a36a42b67de1ad) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.13] Partially revert "gh-101100: Fix sphinx warnings in ↵Miss Islington (bot)2025-07-142-3/+4
| | | | | | `library/email.parser.rst` (GH-136475)" (GH-136629) (#136647) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-42237: Link to complete list of codec aliases (GH-136625) (#136627)Miss Islington (bot)2025-07-131-2/+9
| | | | | | | | gh-42237: Link to complete list of codec aliases (GH-136625) Closes GH-42237 (cherry picked from commit a93d9aaf62bb2565e9eec00a2a8d06a91305127b) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-132346: Docs: Clarify that reference counts aren't stable between ↵Miss Islington (bot)2025-07-131-0/+5
| | | | | | | | versions (GH-132352) (GH-136614) gh-132346: Docs: Clarify that reference counts aren't stable between versions (GH-132352) (cherry picked from commit 3dbe02ccd3eefc48ac9fa14427bb4cdb82d1ebae) Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
* [3.13] gh-134833: improve docs for `del s[i:j]` in `Mutable Sequence Types` ↵Miss Islington (bot)2025-07-131-1/+3
| | | | | | | | (GH-134834) (#136609) gh-134833: improve docs for `del s[i:j]` in `Mutable Sequence Types` (GH-134834) (cherry picked from commit 609d5adc7cc241da8fe314a64ddd2c8a883ee8b7) Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
* [3.13] gh-101100: Fix sphinx warnings in Doc/library/platform.rst ↵Miss Islington (bot)2025-07-122-3/+2
| | | | | | | (GH-136562) (GH-136598) (cherry picked from commit 47b01da4ccedd9c00fad4325b3e87d7732abeb6d) Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
* [3.13] gh-101100: Fix sphinx warnings in Doc/library/functools.rst ↵Serhiy Storchaka2025-07-112-13/+21
| | | | | | | | (GH-136424) (GH-136554) Add index entries and anchors for cache_info, cache_clear and register. (cherry picked from commit 252e2f710ea376a38c4545dd758e03d331c1eaad) Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>