Commit graph

13028 commits

Author SHA1 Message Date
Savannah Ostrowski
b3709562ad
[3.12] GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932) (GH-124356)
(cherry picked from commit 5f5c0b9c23)
2024-09-23 19:04:36 +00:00
Miss Islington (bot)
d5aafe7713
[3.12] gh-124130: Notes on empty string corner case of category \B (GH-124133) (#124329)
gh-124130: Notes on empty string corner case of category `\B` (GH-124133)
(cherry picked from commit d3e79d75d1)

Signed-off-by: y5c4l3 <y5c4l3@proton.me>
Co-authored-by: Y5 <124019959+y5c4l3@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-09-23 07:05:24 +00:00
Miss Islington (bot)
8606a2e91c
[3.12] Fix typo in XMLParser doc (GH-124129) (#124281)
Fix typo in XMLParser doc (GH-124129)
(cherry picked from commit 622368d99c)

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2024-09-20 10:51:12 +00:00
Miss Islington (bot)
6840b611de
[3.12] GH-103484: Fix broken links reported by linkcheck (GH-124169) (#124180)
GH-103484: Fix broken links reported by linkcheck (GH-124169)
(cherry picked from commit ab80c6b402)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-17 15:19:07 +00:00
Miss Islington (bot)
a032a96a92
[3.12] Use pep role instead of url (GH-121611) (#124173)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-17 13:08:38 +00:00
Miss Islington (bot)
92bc714033
[3.12] GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) (GH-124152)
Fix redirects reported by linkcheck, update docs conf.py checks.
(cherry picked from commit 0a32c6959c)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-16 20:53:46 -07:00
Miss Islington (bot)
c5e11bec91
[3.12] Normalize cdecl formatting as found elsewhere on ctypes.rst (GH-121379) (#124057)
Co-authored-by: utkonos <utkonos@users.noreply.github.com>
2024-09-13 15:33:31 +00:00
Miss Islington (bot)
5c15b1a05a
[3.12] gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936) (GH-124004)
(cherry picked from commit 8e99495701)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-09-12 14:14:42 +02:00
Miss Islington (bot)
c6ae90a63c
[3.12] gh-123905: Update TOML description to include version number (GH-123906) (#123907) 2024-09-10 23:28:36 -07:00
Miss Islington (bot)
9e38723a15
[3.12] Mention curl in contextvars docs (GH-123838) (#123869)
Mention `curl` in `contextvars` docs (GH-123838)
(cherry picked from commit b950831c94)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-09 14:05:44 +00:00
Miss Islington (bot)
77bb146221
[3.12] gh-123789: secrets.randbits returns only non-negative int (GH-123801) (#123831)
gh-123789: `secrets.randbits` returns only non-negative int (GH-123801)
(cherry picked from commit beee91cdcc)

Co-authored-by: Wulian <1055917385@qq.com>
2024-09-08 04:24:08 +00:00
Miss Islington (bot)
ca3ac30d6b
[3.12] Remove excessive backticks in logging doc (GH-123813) (#123817)
Remove excessive backticks in logging doc (GH-123813)
(cherry picked from commit 93050e4614)

Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
2024-09-07 18:19:23 +00:00
Alex Waygood
7e51091481
[3.12] gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs (#123544) (#123792)
Co-authored-by: Stanislav Terliakov <50529348+sterliakov@users.noreply.github.com>
2024-09-06 17:06:36 +00:00
Miss Islington (bot)
407505da8e
[3.12] gh-123207: Clarify the documentation for the mro lookup for super() (GH-123417) (#123733)
(cherry picked from commit 327463aef1)

Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com>
2024-09-06 15:44:54 +02:00
Petr Viktorin
bc207e85f7
[3.12] gh-102988: Adjust version numbers in versionadded directives (GH-123771) 2024-09-06 11:08:54 +00:00
Petr Viktorin
15068242bd
[3.12] [CVE-2023-27043] gh-102988: Reject malformed addresses in email.parseaddr() (GH-111116) (#123766)
Detect email address parsing errors and return empty tuple to
indicate the parsing error (old API). Add an optional 'strict'
parameter to getaddresses() and parseaddr() functions. Patch by
Thomas Dwyer.

Co-Authored-By: Thomas Dwyer <github@tomd.tel>
(cherry picked from commit 4a153a1d3b)

Co-authored-by: Victor Stinner <vstinner@python.org>
2024-09-06 12:46:16 +02:00
Miss Islington (bot)
747abc00d0
[3.12] gh-123213: Fixed xml.etree.ElementTree.Element.extend and assignment to no longer hide exceptions (GH-123214) (#123258)
Co-authored-by: Bar Harel <bharel@barharel.com>
2024-09-06 11:51:18 +03:00
Miss Islington (bot)
17249f3a8f
[3.12] gh-103066: Add links and help in site.py constants (GH-103777) (#123763)
Co-authored-by: David Caron <dcaron05@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-09-06 11:08:32 +03:00
Miss Islington (bot)
6caab08d58
[3.12] gh-85453: Improve instance attributes mark up on datetime.rst (GH-123655) (#123741)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-05 18:05:50 +00:00
Miss Islington (bot)
c3a866c915
[3.12] gh-123392: Clarify wording regarding parameters that are functions to be called (GH-123394) (GH-123665)
(cherry picked from commit c08ede2714)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2024-09-05 12:50:00 +02:00
Miss Islington (bot)
a0c9f51561
[3.12] gh-118508: Clarify which characters are matched by \s (GH-119155) (#123671)
gh-118508: Clarify which characters are matched by `\s` (GH-119155)

Clarify re syntax
(cherry picked from commit 22fdb8cf89)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-09-04 15:36:39 -07:00
Wei-Hsiang (Matt) Wang
d47d7e1124
[3.12] gh-123517: Remove unnecessary :meth: parentheses (gh-123518) (GH-123576) 2024-09-02 16:02:39 +02:00
Miss Islington (bot)
ae17f9b0d0
[3.12] gh-123570: Add link to weakref.ref from weakref_slot docs in dataclasses (GH-123571) (#123595)
gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (GH-123571)
(cherry picked from commit c3ed775899)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-02 07:05:18 +00:00
Miss Islington (bot)
12db938d43
[3.12] gh-91126: Docs and tests for slotted dataclasses with __init_subclass__ (GH-123342) (#123569)
gh-91126: Docs and tests for slotted dataclasses with `__init_subclass__` (GH-123342)
(cherry picked from commit 75e72822a3)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-09-01 10:44:15 +00:00
Miss Islington (bot)
e3d8ccc89d
[3.12] gh-123550: Fix code snippet of BUILD_TUPLE in dis docs (GH-123551) (#123556) 2024-09-01 08:38:38 +01:00
Miss Islington (bot)
c41c787686
[3.12] gh-123494: Improve documentation for `webbrowser` return types (GH-123495) (#123549)
gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495)

Document the return value for ``webbrowser.open*()``.
(cherry picked from commit 0b6acfee04)

Co-authored-by: Aarni Koskela <akx@iki.fi>
2024-09-01 05:36:18 +00:00
Wei-Hsiang (Matt) Wang
d5abd02f36
[3.12] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (#123512) 2024-08-30 20:09:55 +03:00
Miss Islington (bot)
ffa282cc35
[3.12] gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (GH-123286) (#123326)
gh-82378: Document the difference between sys.tracebacklimit and the limit arguments (GH-123286)
(cherry picked from commit 70bfef52b5)

Co-authored-by: CF Bolz-Tereick <cfbolz@gmx.de>
2024-08-25 22:57:16 +00:00
Miss Islington (bot)
93d4a191ff
[3.12] gh-122982: Extend the deprecation period for bool inversion by two years (GH-123306) (#123317)
gh-122982: Extend the deprecation period for bool inversion by two years (GH-123306)
(cherry picked from commit 249b083ed8)

Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-08-25 19:40:11 +00:00
Miss Islington (bot)
8edfa0b0b4
[3.12] gh-123110: correct note about _Bool in the struct module docs (GH-123111) (#123127)
gh-123110: correct note about _Bool in the struct module docs (GH-123111)
(cherry picked from commit b0f462d4c8)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-08-19 13:01:12 +05:30
Miss Islington (bot)
b9667e8243
[3.12] fix typo in dis.rst (GH-121612) (#123096)
fix typo in dis.rst (GH-121612)
(cherry picked from commit e9287ea426)

Co-authored-by: mathysEthical <110499907+mathysEthical@users.noreply.github.com>
2024-08-17 14:33:04 +05:30
Miss Islington (bot)
28f37700bc
[3.12] gh-122519: Adding socket module shutdown() constants description (GH-122543) (#123094)
gh-122519: Adding socket module shutdown() constants description (GH-122543)
(cherry picked from commit 8a59deca59)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
2024-08-17 08:35:50 +00:00
Miss Islington (bot)
9f153a2acf
[3.12] gh-123005: Add version added in enum.Flag.__len__ (GH-123007) (#123025)
gh-123005: Add version added in enum.Flag.__len__ (GH-123007)
(cherry picked from commit 8e2dc7f380)

Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
2024-08-14 22:30:44 +01:00
Miss Islington (bot)
18d48052c2
[3.12] Docs: Standardise versionchanged text in weakref.rst (GH-122898) (#122912)
Docs: Standardise versionchanged text in weakref.rst (GH-122898)
(cherry picked from commit db8b83c2b0)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-08-11 20:46:05 +00:00
Miss Islington (bot)
f5009b69e0
[3.12] GH-120794: Use example paths with multiple parts in pathlib docs (GH-122887) (#122896)
GH-120794: Use example paths with multiple parts in pathlib docs (GH-122887)

In the documentation of `PosixPath` and `WindowsPath`, and their `Pure*`
equivalents, use example paths with multiple non-anchor parts.

(cherry picked from commit 363374cf69)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-10 22:31:59 +01:00
Miss Islington (bot)
2e8235302b
[3.12] Docs: Change remove to removes for consistency (GH-121072) (#122791)
Docs: Change `remove` to `removes` for consistency (GH-121072)
(cherry picked from commit 967a4f1d18)

Co-authored-by: smij720 <122238526+smij720@users.noreply.github.com>
2024-08-07 16:06:54 +00:00
Gregory P. Smith
b31764104e
[3.12] gh-119577: Adjust DeprecationWarning when testing element truth values in Element tree (GH-119762) (#120190)
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.

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2024-08-06 17:20:06 +00:00
Christopher Chianelli
e970431f13
[3.12] gh-117270: Add missed change to COMPARE_OP from 3.12 to dis documentation (GH-117272) (#117274) 2024-08-06 19:19:44 +02:00
Petr Viktorin
4766d1200f
[3.12] gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233) (#122599)
* gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233)

- Encode header parts that contain newlines

Per RFC 2047:

> [...] these encoding schemes allow the
> encoding of arbitrary octet values, mail readers that implement this
> decoding should also ensure that display of the decoded data on the
> recipient's terminal will not cause unwanted side-effects

It seems that the "quoted-word" scheme is a valid way to include
a newline character in a header value, just like we already allow
undecodable bytes or control characters.
They do need to be properly quoted when serialized to text, though.

- Verify that email headers are well-formed

This should fail for custom fold() implementations that aren't careful
about newlines.

Co-authored-by: Bas Bloemsaat <bas@bloemsaat.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit 0976339818)

* Document changes as made in 3.12.5
2024-08-06 19:07:19 +02:00
Miss Islington (bot)
8f19be47b6
[3.12] gh-121367: [doc] BUILD_TUPLE arg can be 0 (GH-122663) (#122684)
gh-121367: [doc] BUILD_TUPLE arg can be 0 (GH-122663)
(cherry picked from commit 1422500d02)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2024-08-05 09:24:22 +00:00
Miss Islington (bot)
e2103fc216
[3.12] Doc: Grammar fix in `library/ssl.rst`, 'Verifying certificates' (GH-122646) (#122650)
Doc: Grammar fix in ``library/ssl.rst``, 'Verifying certificates' (GH-122646)
(cherry picked from commit 06eb9701a1)

Co-authored-by: scottwoodall <scott.woodall@gmail.com>
2024-08-03 13:31:12 +00:00
Miss Islington (bot)
6dd6ea033a
[3.12] Doc: Improve wording of `os.path.commonpath()` (GH-122627) (#122642)
Doc: Improve wording of ``os.path.commonpath()`` (GH-122627)
(cherry picked from commit 7a5c4103b0)

Co-authored-by: Matth-M <93771840+Matth-M@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-03 12:29:51 +01:00
Alex Waygood
372df19508
[3.12] Fix typos in docs (#122502) (#122605)
Co-authored-by: jianghuyiyuan <shuangcui@live.com>
Fix typos in docs, error messages and comments (#122502)
2024-08-02 11:59:34 +00:00
Miss Islington (bot)
c47943aa5e
[3.12] gh-121723: Relax constraints on queue objects for logging.handlers.QueueHandler. (GH-122154) (GH-122604)
(cherry picked from commit fb864c76cd)
2024-08-02 12:46:04 +01:00
Pablo Galindo Salgado
ca3486cb1e
[3.12] gh-122300: Preserve AST nodes for format specifiers with single elements (GH-122308) (#122363)
(cherry picked from commit db2d8b6db1)
2024-07-27 19:20:28 +00:00
Barney Gale
8205c16c7c
[3.12] GH-121462: pathlib docs: improve table of corresponding os/os.path functions (GH-121465) (#122360)
Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.

(cherry picked from commit cbac8a3888)
2024-07-27 17:13:20 +00:00
Miss Islington (bot)
d4ca183a38
[3.12] Document `mimetypes.MimeTypes.add_type()` (GH-122301) (#122329)
Document ``mimetypes.MimeTypes.add_type()`` (GH-122301)
(cherry picked from commit d52726ccd4)

Co-authored-by: Subrahmanya Gaonkar <148525245+negativenagesh@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-26 22:10:01 +00:00
Miss Islington (bot)
cde9a26eb5
[3.12] Docs: Use cross-reference to os.uname in sysconfig.get_platform (GH-122083) (#122172)
Docs: Use cross-reference to `os.uname` in `sysconfig.get_platform` (GH-122083)
(cherry picked from commit 498cb6dff1)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2024-07-23 13:14:50 +00:00
Łukasz Langa
c1e834dd78
[3.12] gh-121957: Emit audit events for python -i and python -m asyncio (GH-122117) 2024-07-22 13:41:23 +02:00
Russell Keith-Magee
71970d602f
[3.12] Docs: spelling and grammar fixes (GH-122084) (#122107)
(cherry picked from commit bc264eac3a)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-07-21 18:39:48 -07:00