Commit graph

27912 commits

Author SHA1 Message Date
Miss Islington (bot)
13c263c444
[3.12] gh-122511: Improve documentation for object identity of mutable/immutable types (GH-122512) (#122779)
gh-122511: Improve documentation for object identity of mutable/immutable types (GH-122512)
(cherry picked from commit 76bdeebef6)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-07 14:56:40 +01: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
Sergey B Kirpichev
2ff41583fd
[3.12] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-122280) (#122644)
[3.12] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-GH-122280)
(cherry picked from commit d91ac525ef)
2024-08-05 20:11:42 +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)
f7ae2c1f2a
[3.12] gh-122661: Remove GNU make-specific directive from Doc/Makefile (GH-122662) (#122669)
Co-authored-by: Libor Martínek <libas@acco.cz>
2024-08-04 17:24:57 +03:00
Miss Islington (bot)
62f224a9ad
[3.12] gh-122623: Improve c-api/bytearray.rst with error handling info (GH-122624) (#122659)
gh-122623: Improve `c-api/bytearray.rst` with error handling info (GH-122624)
(cherry picked from commit 151934a324)

Co-authored-by: sobolevn <mail@sobolevn.me>
2024-08-03 22:02:24 +00:00
Miss Islington (bot)
8f1b385ad6
[3.12] GH-121970: Fix `gettext` for audit events (GH-122651) (#122654)
GH-121970: Fix ``gettext`` for audit events (GH-122651)
(cherry picked from commit 95f5c89b54)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-03 16:47:43 +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
Miss Islington (bot)
fed70e0395
[3.12] gh-122384: Mark strings from Download page for translation (GH-122385) (#122554)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-08-01 09:37:18 +00:00
Hugo van Kemenade
ef21e48cac
[3.12] Docs: bump Sphinx to 8.0 and update constraints (GH-122496) (#122500)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-31 10:49:31 +03:00
Miss Islington (bot)
1cd57b9937
[3.12] Remove outdated note about instance methods from datamodel.rst (GH-122471) (#122480)
Remove outdated note about instance methods from datamodel.rst (GH-122471)
(cherry picked from commit c68cb8e0c9)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2024-07-30 19:48:29 +00:00
Miss Islington (bot)
6b4abdee91
[3.12] GH-121970: Extract `audit_events` into a new extension (GH-122325) (#122435) 2024-07-30 03:55:15 +00:00
Adam Turner
dd86217b60
[3.12] GH-122085: Use include files for C API deprecations (GH-109843) (#122423)
(cherry picked from commit 76bdfa4cd0)
2024-07-30 03:40:18 +00:00
Miss Islington (bot)
ccb4e3ba7e
[3.12] gh-122085: Create dedicated page for deprecations (GH-122352) (#122375)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-28 08:09:20 +00: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
Hugo van Kemenade
fb2826a6b7
[3.12] gh-122085: Use include files for whatsnew/3.14.rst deprecations (GH-122242) (#122351) 2024-07-27 14:42:51 +03: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
Hugo van Kemenade
1a104e5112
[3.12] gh-122085: Use include files for whatsnew/3.12.rst deprecations (GH-122093) (#122224)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-07-24 10:41:57 -06: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
Miss Islington (bot)
647765395d
[3.12] GH-121970: Remove `escape4chm` (GH-122065) (#122168)
GH-121970: Remove ``escape4chm`` (GH-122065)
(cherry picked from commit 53e9e7de63)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-23 12:38:43 +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
Miss Islington (bot)
9343c6d323
[3.12] Delete stale note about mp.Lock.acquire/SIGINT (GH-120929) (GH-122079)
Delete stale note about mp.Lock.acquire/SIGINT (GH-120929)
(cherry picked from commit 0dcbc83853)

Co-authored-by: Andrey Mishchenko <mishchea@gmail.com>
2024-07-21 06:24:56 +00:00
Miss Islington (bot)
5f46a726ea
[3.12] gh-121977: Add tips for handling unhashable data (GH-122075) (#122077)
gh-121977: Add tips for handling unhashable data (GH-122075)
(cherry picked from commit ebc18abbf3)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2024-07-21 06:00:20 +00:00
Miss Islington (bot)
0298da432d
[3.12] Docs: Fix duplicate object description warnings (GH-122068) (#122070)
Docs: Fix duplicate object description warnings (GH-122068)
(cherry picked from commit 8db5f48007)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-20 19:54:57 +00:00
Pablo Galindo Salgado
a9daa4fd04
[3.12] gh-121130: Fix f-string format specifiers with debug expressions (GH-121150) (#122063) 2024-07-20 19:05:01 +02:00
Miss Islington (bot)
ca531e4326
[3.12] GH-121970: Modernise the patchlevel extension (GH-121995) (#122061)
GH-121970: Modernise the patchlevel extension (GH-121995)
(cherry picked from commit b7ad711fcb)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-20 13:51:32 +00:00
Miss Islington (bot)
3f72821f80
[3.12] gh-59022: Added tests for pkgutil.extend_path (GH-121673) (GH-121950)
This adds tests for the documented behaviour of `pkgutil.extend_path`
regarding different argument types as well as for `*.pkg` files.
(cherry picked from commit 8f2532168b)

Co-authored-by: Andreas Stocker <andreas@stocker.co.it>
2024-07-19 16:36:26 +02:00
Petr Viktorin
e80497c9cd
[3.12] gh-121160: Note that readline libraries using different history formats. (GH-121327) (GH-122031)
This is not something we can do too much about, without help from the
underlying libraries.
(cherry picked from commit 709db44255)
2024-07-19 14:13:34 +00:00
Adam Turner
ff98d9021a
[3.12] GH-121970: Rewrite the C-API annotations extension (GH-121985) (#122025)
(cherry picked from commit 22c9d9c1fc)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-07-19 12:48:50 +00:00
Adam Turner
7c8b6f85c9
[3.12] GH-121970: Use Ruff to check and format the docs tools (GH-122018) (#122024)
(cherry picked from commit 40855f3ab8)

Co-authored-by: Alex Waygood <Alex.Waygood@gmail.com>
2024-07-19 12:26:32 +00:00
Miss Islington (bot)
2cd816e4e0
[3.12] GH-121970: Combine custom Pygments lexers into a package (GH-121976) (#122022)
GH-121970: Combine custom Pygments lexers into a package (GH-121976)
(cherry picked from commit 7431c3799e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-07-19 12:02:42 +00:00
Miss Islington (bot)
88618d2910
[3.12] GH-121970: Make `DeprecatedRemoved a subclass of VersionChange` (GH-121971) (#122020)
GH-121970: Make ``DeprecatedRemoved`` a subclass of ``VersionChange`` (GH-121971)
(cherry picked from commit 898e90c3be)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-19 10:46:37 +00:00
Miss Islington (bot)
2d4eccf70e
[3.12] GH-121970: Improve the glossary preview in HTML search (GH-121991) (#122016)
GH-121970: Improve the glossary preview in HTML search (GH-121991)
(cherry picked from commit adf0b94d1c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-19 09:23:47 +00:00
Serhiy Storchaka
39dea212f4
[3.12] gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) (GH-122013)
(cherry picked from commit 1a0c7b9ba4)
2024-07-19 09:08:33 +00:00
Miss Islington (bot)
e7130dc014
[3.12] Docs: Upgrade Sphinx to 7.4 (GH-121987) (#122011)
Docs: Upgrade Sphinx to 7.4 (GH-121987)
(cherry picked from commit 420d943128)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-19 08:05:47 +00:00
Miss Islington (bot)
b1c31a1547
[3.12] gh-65453: Docs - clarify AttributeError behaviour on PropertyMock (GH-121666) (GH-121969)
Fixed at EuroPython 24 sprints.
(cherry picked from commit 94e6644584)

Co-authored-by: Vlastimil Zíma <ziima@users.noreply.github.com>
2024-07-19 10:03:54 +02:00
Miss Islington (bot)
eda9b7f6fd
[3.12] GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986) (#121993)
GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986)
(cherry picked from commit 7dd52b63ce)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-19 07:44:03 +00:00
Miss Islington (bot)
18557848ec
[3.12] GH-121970: Use `SphinxDirective instead of Directive` (GH-121972) (#122009)
GH-121970: Use ``SphinxDirective`` instead of ``Directive`` (GH-121972)
(cherry picked from commit ac39151a09)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-07-19 07:41:57 +00:00
Miss Islington (bot)
eedb44e490
[3.12] Docs: Fix typo in description of `INTRINSIC_ASYNC_GEN_WRAP` (GH-122004) (#122007)
Docs: Fix typo in description of ``INTRINSIC_ASYNC_GEN_WRAP`` (GH-122004)
(cherry picked from commit 98e5bdef0e)

Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-07-19 07:36:09 +00:00
Miss Islington (bot)
f88ec9a203
[3.12] gh-64308: Remove TestProgram from the unittest docs (GH-121675) (GH-121743)
gh-64308: Remove TestProgram from the unittest docs (GH-121675)
(cherry picked from commit f6f4022a35)

Co-authored-by: Jan Musílek <jan.musilek@nic.cz>
2024-07-18 15:27:01 +02:00
Miss Islington (bot)
1d915aaf5c
[3.12] gh-121874: Define audit-event open parameters consistently (GH-121883) (GH-121955)
Use same names for parameters to avoid triggering a race-condition in Sphinx
that causes non-deterministic output.
(cherry picked from commit 24cf867bed)

Co-authored-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
2024-07-18 10:12:40 +00:00
sobolevn
6a19d22a19
[3.12] gh-121834: Improve complex C-API docs (GH-121835) (#121897)
* [3.12] gh-121834: Improve `complex` C-API docs (GH-121835)
(cherry picked from commit 72dccd6073)

Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-07-17 07:30:18 +00:00
Miss Islington (bot)
a15ed5661f
[3.12] gh-121453: Update the Doc/templates/download.html download files size estimates and support download .texi format. (GH-121454) (#121891)
Co-authored-by: Wulian233 <1055917385@qq.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-07-17 06:27:55 +00:00