summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] gh-121027: Add a future warning in functools.partial.__get__ ↵Miss Islington (bot)2024-06-271-0/+6
| | | | | | | | (GH-121086) (#121092) gh-121027: Add a future warning in functools.partial.__get__ (GH-121086) (cherry picked from commit db96edd6d1a58045196a71aff565743f493b5fbb) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-120937: Reference weakref from the `__del__` documentation ↵Miss Islington (bot)2024-06-261-0/+2
| | | | | | | | | (GH-120940) (#121061) gh-120937: Reference weakref from the `__del__` documentation (GH-120940) (cherry picked from commit 1c13b29d54ad6d7c9e030227d575ad7d21b4054f) Co-authored-by: chaen <christophe.haen@cern.ch> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] Doc/README: Document 'make htmllive' (GH-120692) (#120990)Miss Islington (bot)2024-06-251-8/+10
| | | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.13] gh-120661: improve example for basic type hints (GH-120934) (#120987)Miss Islington (bot)2024-06-251-5/+6
| | | | | | gh-120661: improve example for basic type hints (GH-120934) (cherry picked from commit bb057ea1075e000ff3f0d6b27a2b7ca4117b4969) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] GH-119054: Add "Permissions and ownership" section to pathlib docs. ↵Barney Gale2024-06-241-48/+51
| | | | | | | | (GH-120505) (#120967) Add dedicated subsection for `pathlib.owner()`, `group()`, `chmod()` and `lchmod()`. (cherry picked from commit e4a97a7fb1c03d3b6ec6efbeff553a0230e003c7)
* [3.13] gh-120858: PyDict_Next should not lock the dict (GH-120859) (#120964)Miss Islington (bot)2024-06-242-1/+30
| | | | | | | | | | | | PyDict_Next no longer locks the dictionary in the free-threaded build. Locking around individual PyDict_Next calls is not sufficient because the function returns borrowed references and because it allows concurrent modifications during the iteraiton loop. The internal locking also interferes with correct external synchronization because it may suspend outer critical sections created by the caller. (cherry picked from commit 375b723d5873f948696c7e85a97f4778d9e00ff0) Co-authored-by: Sam Gross <colesbury@gmail.com>
* [3.13] gh-119521: Rename IncompleteInputError to _IncompleteInputError and ↵Miss Islington (bot)2024-06-241-1/+0
| | | | | | | | | | | | | remove from public API/ABI (GH-119680, GH-120955) (GH-120944) - gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from public API/ABI (GH-119680) (cherry picked from commit ce1064e4c9bcfd673323ad690e60f86e1ab907bb) - gh-119521: Use `PyAPI_DATA`, not `extern`, for `_PyExc_IncompleteInputError` (GH-120955) (cherry picked from commit ac61d58db0753a3b37de21dbc6e86b38f2a93f1b) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] docs: puremagic.what() as replacement for imghdr.what() (GH-120871) ↵Miss Islington (bot)2024-06-241-0/+3
| | | | | | | | (#120951) docs: puremagic.what() as replacement for imghdr.what() (GH-120871) (cherry picked from commit 22b8a35d6e6660cf7457ed6636cb8c12fff7e8e7) Co-authored-by: Christian Clauss <cclauss@me.com>
* [3.13] gh-112169: Documented getaddrinfo/getnameinfo default loop executor ↵Miss Islington (bot)2024-06-241-0/+8
| | | | | | | | | | | usage and implications. (GH-112191) (#120935) gh-112169: Documented getaddrinfo/getnameinfo default loop executor usage and implications. (GH-112191) (cherry picked from commit fc297b4ba4c61febeb2d8f5d718f2955c6bbea0a) Co-authored-by: Alek Kowalczyk <alek.kowalczyk@gmail.com> Co-authored-by: Guido van Rossum <gvanrossum@gmail.com> Co-authored-by: Kumar Aditya <kumaraditya@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.13] Docs makefile/RTD: Use uv if installed (GH-120711) (#120922)Miss Islington (bot)2024-06-231-6/+19
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] Typing docs: normalize some indents in code examples (GH-120912) ↵Miss Islington (bot)2024-06-231-4/+5
| | | | | | (#120915) Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
* [3.13] gh-120896: Fix typo in version changed note of ↵Miss Islington (bot)2024-06-231-1/+1
| | | | | | | | `urllib.parse.urlparse()` (GH-120898) (#120902) gh-120896: Fix typo in version changed note of `urllib.parse.urlparse()` (GH-120898) (cherry picked from commit b6fa8fe86a6f4d02c263682716a91285a94024fc) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
* [3.13] gh-119003: Clarify slice assignments (GH-119935) (#120847)Miss Islington (bot)2024-06-231-1/+1
| | | | | | gh-119003: Clarify slice assignments (GH-119935) (cherry picked from commit 462832041e342f8aaf8c88ec44f7b14c70042575) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
* [3.13] gh-119344: Make critical section API public (GH-119353) (#120856)Sam Gross2024-06-211-0/+104
| | | | | | | | | | | This makes the following macros public as part of the non-limited C-API for locking a single object or two objects at once. * `Py_BEGIN_CRITICAL_SECTION(op)` / `Py_END_CRITICAL_SECTION()` * `Py_BEGIN_CRITICAL_SECTION2(a, b)` / `Py_END_CRITICAL_SECTION2()` The supporting functions and structs used by the macros are also exposed for cases where C macros are not available. (cherry picked from commit 8f17d69b7bc906e8407095317842cc0fd52cd84a)
* [3.13] gh-120838: Add a Note in the Docs About Expectations for ↵Miss Islington (bot)2024-06-211-3/+10
| | | | | | | Py_Finalize() (gh-120852) (cherry picked from commit 03fa2df92707b543c304a426732214002f81d671, AKA gh-120839) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* [3.13] gh-120773: document introspective attributes of an async generator ↵Miss Islington (bot)2024-06-211-214/+227
| | | | | | | | object in the inspect module (GH-120778) (#120827) gh-120773: document introspective attributes of an async generator object in the inspect module (GH-120778) (cherry picked from commit 83d3d7aace32b8536f552f78dd29610344f13160) Co-authored-by: blhsing <blhsing@gmail.com>
* [3.13] gh-111259: Document idiomatic RE pattern (?s:.) that matches any ↵Miss Islington (bot)2024-06-201-1/+1
| | | | | | | character (GH-120745) (GH-120813) (cherry picked from commit a2f6f7dd26128b834c6e66fe1ceac3ac751143f5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-117511: Make PyMutex public in the non-limited API (GH-117731) ↵Sam Gross2024-06-202-0/+48
| | | | | (#120800) (cherry picked from commit 3af7263037de1d0ef63b070fc7bfc2cf042eaebe)
* [3.13] GH-119462: Enforce invariants of type versioning. Backport of ↵Mark Shannon2024-06-201-2/+2
| | | | | GH-120731. (#120748) * Remove uses of Py_TPFLAGS_VALID_VERSION_TAG
* [3.13] Update the documentation howto index page and group docs into 3 ↵Miss Islington (bot)2024-06-204-5/+39
| | | | | | | | | | | | | | | logical sections (GH-119366, GH-120703) (GH-120646) Update the documentation howto index page and group docs into 3 logical sections (GH-119366) (cherry picked from commit a26d27e7ee512cd822b7a7ba075171152779ffdd) Includes a follow-up fix to properly merge GH-119877: * Add a link to free-threading HOWTO to the index (GH-120703) (cherry picked from commit 45d5cab533a607716b2b41134839a59facf309cd) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.13] gh-119698: fix `symtable.Class.get_methods` and document its ↵Jelle Zijlstra2024-06-201-2/+33
| | | | | | | | behaviour correctly (GH-120151) (#120777) (cherry picked from commit b8a8e04fec76ad7f7c3e5149114dd2ee8a5caecc) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-118820: Zero-valued flag enum has no name (GH-118848) (GH-120759)Miss Islington (bot)2024-06-191-0/+8
| | | | | | | gh-118820: Zero-valued flag enum has no name (GH-118848) (cherry picked from commit ed5ae6c4d76feaff06c2104c8ff864553b000253) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] Regen ``Doc/requirements-oldest-sphinx.txt`` (GH-120753) (#120757)Miss Islington (bot)2024-06-191-4/+4
| | | | Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.13] gh-120521: clarify except* documentation to allow tuples (GH-120523) ↵Miss Islington (bot)2024-06-191-9/+10
| | | | | | | | | (#120750) (cherry picked from commit 58b3f111767148e9011ccd52660e208f0c834b2a) Co-authored-by: Danny Yang <yangdanny97@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.13] gh-119960: Add information about regex flags in re module functions ↵Miss Islington (bot)2024-06-191-0/+32
| | | | | | | | (GH-119978) (#120730) gh-119960: Add information about regex flags in re module functions (GH-119978) (cherry picked from commit a86e6255c371e14cab8680dee979a7393b339ce5) Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
* [3.13] gh-120381: Fix inspect.ismethoddescriptor() (GH-120684)Miss Islington (bot)2024-06-191-3/+8
| | | | | | | | | | | The `inspect.ismethoddescriptor()` function did not check for the lack of `__delete__()` and, consequently, erroneously returned True when applied to *data* descriptors with only `__get__()` and `__delete__()` defined. (cherry picked from commit dacc5ac71a8e546f9ef76805827cb50d4d40cabf) Co-authored-by: Jan Kaliszewski <zuo@kaliszewski.net> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] gh-120496: Add a note about iterator thread-safe (gh-120685) (#120706)Miss Islington (bot)2024-06-191-0/+3
| | | | | | gh-120496: Add a note about iterator thread-safe (gh-120685) (cherry picked from commit 7e189aed6450c0aebcdd6ff6aefe29e2f45b173a) Co-authored-by: Donghee Na <donghee.na@python.org>
* [3.13] gh-118789: Add `PyUnstable_Object_ClearWeakRefsNoCallbacks` ↵Miss Islington (bot)2024-06-181-0/+16
| | | | | | | | | | | | | | | | | (GH-118807) (#120695) This exposes `PyUnstable_Object_ClearWeakRefsNoCallbacks` as an unstable C-API function to provide a thread-safe mechanism for clearing weakrefs without executing callbacks. Some C-API extensions need to clear weakrefs without calling callbacks, such as after running finalizers like we do in subtype_dealloc. Previously they could use `_PyWeakref_ClearRef` on each weakref, but that's not thread-safe in the free-threaded build. (cherry picked from commit e8752d7b80775ec2a348cd4bf38cbe26a4a07615) Co-authored-by: Sam Gross <colesbury@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-119241: Add HOWTO for free-threaded C API extensions (GH-119877) ↵Miss Islington (bot)2024-06-182-0/+255
| | | | | | | | | | | (#120693) Some sections adapted from https://github.com/Quansight-Labs/free-threaded-compatibility/ written by Nathan Goldbaum. (cherry picked from commit 02b272b7026b68e70b4a4d9a0ca080904aed374c) Co-authored-by: Sam Gross <colesbury@gmail.com> Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
* [3.13] gh-120662: Improve `smtplib` example (GH-120668) (#120681)Miss Islington (bot)2024-06-181-12/+11
| | | | | | | gh-120662: Improve `smtplib` example (GH-120668) (cherry picked from commit 4bc27abdbee88efcf9ada83de6e9e9a0e439edaf) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.13] gh-119933: Improve ``SyntaxError`` message for invalid type ↵Jelle Zijlstra2024-06-171-4/+57
| | | | | | | parameters expressions (GH-119976) (#120641) (cherry picked from commit 4bf17c381fb7b465f0f26aecb94a6c54cf9be2d3) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-112346: Document the OS byte in `gzip.compress` output change in ↵Miss Islington (bot)2024-06-172-1/+18
| | | | | | | | | | | 3.11 (GH-120480) (#120612) gh-112346: Document the OS byte in `gzip.compress` output change in 3.11 (GH-120480) (cherry picked from commit bac4edad69bb20dd9460766e062637cae999e1e0) gh-112346: Describe the "os" byte in gzip output change. Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.13] gh-118596: Add thread-safety clarifications to the SSLContext ↵Miss Islington (bot)2024-06-161-0/+13
| | | | | | | | | | | | | documentation (GH-118597) (#120595) gh-118596: Add thread-safety clarifications to the SSLContext documentation (GH-118597) Add thread-safety clarifications to the SSLContext documentation. Per the issue: This issue has also come up [here](https://github.com/psf/requests/pull/6667) where the matter was clarified by @tiran in [this comment](https://github.com/psf/requests/pull/6667): > `SSLContext` is designed to be shared and used for multiple connections. It is thread safe as long as you don't reconfigure it once it is used by a connection. Adding new certs to the internal trust store is fine, but changing ciphers, verification settings, or mTLS certs can lead to surprising behavior. The problem is unrelated to threads and can even occur in a single-threaded program. (cherry picked from commit 4f59f8638267aa64ad2daa0111d8b7fdc2499834) Co-authored-by: mm-matthias <43849132+mm-matthias@users.noreply.github.com>
* [3.13] Docs: remove temporary hardcoded links (GH-120348) (#120587)Miss Islington (bot)2024-06-161-34/+1
| | | | | | Docs: remove temporary hardcoded links (GH-120348) (cherry picked from commit b8484c6ad7fd14ca464e584b79821b4b906dd77a) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-120572: add missing parentheses in TypeIs documentation ↵Miss Islington (bot)2024-06-161-2/+2
| | | | | | | | (GH-120573) (#120575) gh-120572: add missing parentheses in TypeIs documentation (GH-120573) (cherry picked from commit 1fa595963ed512b055d2a4faddef5a9e544288ac) Co-authored-by: Nyuan Zhang <blueglassblock@outlook.com>
* [3.13] gh-112346: Always set OS byte to 255, simpler gzip.compress function. ↵Miss Islington (bot)2024-06-151-3/+5
| | | | | | | | | | (GH-120486) (#120563) gh-112346: Always set OS byte to 255, simpler gzip.compress function. (GH-120486) This matches the output behavior in 3.10 and earlier; the optimization in 3.11 allowed the zlib library's "os" value to be filled in instead in the circumstance when mtime was 0. this keeps things consistent. (cherry picked from commit 08d09cf5ba041c9c5c3860200b56bab66fd44a23) Co-authored-by: Ruben Vorderman <r.h.p.vorderman@lumc.nl>
* [3.13] annotations: expand documentation on "simple" assignment targets ↵Miss Islington (bot)2024-06-152-5/+12
| | | | | | | | | | | | (GH-120535) (#120555) This behavior is rather surprising and it was not clearly specified. (cherry picked from commit 9e0b11eb21930b7b8e4a396200a921e9985cfca4) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.13] gh-120361: Add `nonmember` test with enum flags inside to `test_enum` ↵Miss Islington (bot)2024-06-141-1/+1
| | | | | | | | | | (GH-120364) (#120511) gh-120361: Add `nonmember` test with enum flags inside to `test_enum` (GH-120364) * gh-120361: Add `nonmember` test with enum flags inside to `test_enum` (cherry picked from commit 7fadfd82ebf6ea90b38cb3f2a046a51f8601a205) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.13] GH-119054: Add "Renaming and deleting" section to pathlib docs. ↵Miss Islington (bot)2024-06-131-60/+64
| | | | | | | | | | | (GH-120465) (#120472) GH-119054: Add "Renaming and deleting" section to pathlib docs. (GH-120465) Add dedicated subsection for `pathlib.Path.rename()`, `replace()`, `unlink()` and `rmdir()`. (cherry picked from commit d88a1f2e156cd1072119afa91d4f4dc4037c1b21) Co-authored-by: Barney Gale <barney.gale@gmail.com>
* [3.13] GH-119054: Add "Creating files and directories" section to pathlib ↵Miss Islington (bot)2024-06-131-79/+86
| | | | | | | | | | | | | | docs. (GH-120186) (#120462) GH-119054: Add "Creating files and directories" section to pathlib docs. (GH-120186) Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files. (cherry picked from commit c2d810b6d4deeea530648a8d0983e3a2adf6c942) Co-authored-by: Barney Gale <barney.gale@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-101575: document Decimal.__round__() (GH-101737) (GH-120394)Miss Islington (bot)2024-06-131-0/+42
| | | | | | gh-101575: document Decimal.__round__() (GH-101737) (cherry picked from commit 7dd8c37a067f9fcb6a2a658d6a93b294cc2e6fb4) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
* [3.13] gh-120345: Fix incorrect use of the :class: role with the "()" suffix ↵Miss Islington (bot)2024-06-127-9/+9
| | | | | | | | | | (GH-120347) (GH-120411) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method. (cherry picked from commit 92c9c6ae147e1e658bbc8d454f8c7b2c4dea31d1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-120128: fix description of argument to ↵Miss Islington (bot)2024-06-121-1/+1
| | | | | | | | | | | ipaddress.collapse_addresses() (GH-120131) (#120135) gh-120128: fix description of argument to ipaddress.collapse_addresses() (GH-120131) The argument to collapse_addresses() is now described as an *iterable* (rather than *iterator*). (cherry picked from commit f878d46e5614f08a9302fcb6fc611ef49e9acf2f) Co-authored-by: Jan Kaliszewski <zuo@kaliszewski.net>
* [3.13] Fix typo in ElementTree docs (GH-120342) (#120357)Miss Islington (bot)2024-06-111-1/+1
| | | | | | Fix typo in ElementTree docs (GH-120342) (cherry picked from commit 0335662fe1f663fe96e3e4acf0f34c5959d06b00) Co-authored-by: naglis <827324+naglis@users.noreply.github.com>
* [3.13] gh-120276: Fix incorrect email.header.Header maxlinelen default ↵Miss Islington (bot)2024-06-081-1/+1
| | | | | | | (GH-120277) (GH-120279) (cherry picked from commit 7c016deae62308dd1b4e2767fc6abf04857c7843) Co-authored-by: Clinton <pygeek@users.noreply.github.com>
* [3.13] gh-110383: Improve 'old string formatting' text in tutorial ↵Miss Islington (bot)2024-06-071-3/+5
| | | | | | | (GH-120219) (#120229) (cherry picked from commit 225aab7f70d804174cc3a75bc04a5bb1545e5adb) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.13] gh-110383: Clarify "non-integral" wording in pow() docs (GH-119688) ↵Miss Islington (bot)2024-06-071-1/+3
| | | | | | | (#120206) (cherry picked from commit 6646a9da26d12fc54263b22dd2916a2f710f1db7) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
* [3.13] Add Plausible for docs metrics (GH-119977) (#120193)Miss Islington (bot)2024-06-072-1/+5
| | | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Julien Palard <julien@palard.fr>
* [3.13] gh-119577: Adjust DeprecationWarning when testing element truth ↵Miss Islington (bot)2024-06-073-10/+14
| | | | | | | | | | values in ElementTree (GH-119762) (GH-120189) gh-119577: Adjust DeprecationWarning when testing element truth values in ElementTree (GH-119762) Adjust DeprecationWarning when testing element truth values in ElementTree, we're planning to go with the more natural True return rather than a disruptive harder to code around exception raise, and are deferring the behavior change for a few more releases. (cherry picked from commit 6b606522ca97488aad6fe2f193d4511e7a8f8334) Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [3.13] GH-119054: Add "Reading directories" section to pathlib docs ↵Barney Gale2024-06-071-96/+103
| | | | | | | | | | (GH-119956) (#120183) Add a dedicated subsection for `Path.iterdir()`-related methods, specifically `iterdir()`, `glob()`, `rglob()` and `walk()`. (cherry picked from commit 14e1506a6d7056c38fbbc0797268dcf783f91243) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>