Commit graph

125130 commits

Author SHA1 Message Date
Miss Islington (bot)
07a6bdd765
[3.13] gh-141004: Document PyType_Unwatch (GH-141414) (GH-141419)
gh-141004: Document `PyType_Unwatch` (GH-141414)
(cherry picked from commit 759a048d4b)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-11 17:28:52 +00:00
Sergey B Kirpichev
05e7b0dadf
[3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141400)
(cherry picked from commit d69447445c)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-11 14:52:05 +01:00
Miss Islington (bot)
6d37d948d4
[3.13] gh-140379: add hyperlinks to list and set (GH-140399) (#141387)
gh-140379: add hyperlinks to list and set (GH-140399)

add hyperlinks to list and set
(cherry picked from commit 92741c59f8)

Co-authored-by: Krishna Chaitanya <141550576+XChaitanyaX@users.noreply.github.com>
2025-11-11 06:09:28 +00:00
Miss Islington (bot)
8f47ec58f6
[3.13] gh-140485: Catch ChildProcessError in multiprocessing resource tracker (GH-141132) (#141385)
gh-140485: Catch ChildProcessError in multiprocessing resource tracker (GH-141132)
(cherry picked from commit 9cb8c52d5e)

Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-11 05:21:20 +00:00
Miss Islington (bot)
a9c00827dd
[3.13] gh-140578: Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist (GH-140689) (#141383)
gh-140578: Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist (GH-140689)

* Doc: Remove sencence implying that concurrent.futures.ThreadPoolExecutor does not exist

Closes GH-140578

* Add NEWS.d entry for gh-140578

---------
(cherry picked from commit 46b58e1bb9)

Co-authored-by: Louis <paternal@users.noreply.github.com>
Co-authored-by: Louis Paternault <spalax@gresille.org>
2025-11-11 04:58:30 +00:00
Miss Islington (bot)
a8c9aff84f
[3.13] gh-141004: Document missing frame APIs (GH-141189) (GH-141380)
gh-141004: Document missing frame APIs (GH-141189)
(cherry picked from commit 86513f6c2e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 21:42:04 +00:00
Miss Islington (bot)
d15841342d
[3.13] gh-141004: Document PyType_FastSubclass (GH-141313) (GH-141369)
gh-141004: Document `PyType_FastSubclass` (GH-141313)
(cherry picked from commit ed0a5fd8ca)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 17:52:22 +00:00
Miss Islington (bot)
1f9f8e5f68
[3.13] gh-139707: Specify winreg, msvcrt and winsound module availability in docs (GH-140429) (GH-141350)
(cherry picked from commit 13fa313beb)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 17:40:53 +01:00
Miss Islington (bot)
0facabc2d8
[3.13] gh-141343: Fix swapped words in sorted doc (GH-141356)
(cherry picked from commit 59b793b0dd)

Co-authored-by: Yongzi Li <204532581+Yzi-Li@users.noreply.github.com>
2025-11-10 15:02:45 +00:00
Petr Viktorin
6384c7917d
[3.13] Clarify argument/result ownership/validity for PyModule_* functions (GH-141159) (GH-141191)
(cherry picked from commit ffd64737d0)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-10 15:06:58 +01:00
Miss Islington (bot)
cab85ced49
[3.13] gh-140500: Update download.html instructions (GH-141320) (#141346)
Co-authored-by: Karina Souza <97332018+KarinaS0uza@users.noreply.github.com>
Co-authored-by: Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
2025-11-10 12:46:06 +00:00
Miss Islington (bot)
9cbbb2eb21
[3.13] gh-141004: Document pyctype.h macros (GH-141272) (GH-141339)
gh-141004: Document `pyctype.h` macros (GH-141272)
(cherry picked from commit df19261621)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 10:11:39 +00:00
Miss Islington (bot)
70bcf946f1
[3.13] gh-141004: Document Py_DTSF_* macros (GH-141310) (GH-141330)
gh-141004: Document `Py_DTSF_*` macros (GH-141310)
(cherry picked from commit 9b0179fa87)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-10 00:49:30 +00:00
Miss Islington (bot)
379d8146d0
[3.13] gh-62480: De-personalize "Partial mocking" section in unittest.mock examples (GH-141321) (#141327)
gh-62480: De-personalize "Partial mocking" section in `unittest.mock` examples (GH-141321)

* Refine some wording in unittest partial mock doc

Some of the descriptions were addressed in first person,
but have now been changed to address the user reading the documentation instead.
(cherry picked from commit b618731781)

Co-authored-by: KarnbirKhera <166065758+KarnbirKhera@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2025-11-09 18:08:09 -06:00
Miss Islington (bot)
b9d4cefe76
[3.13] gh-62480: De-personalize "Mocking Unbound Methods" section in unittest.mock examples (GH-141322) (#141325)
gh-62480: De-personalize "Mocking Unbound Methods" section in `unittest.mock` examples (GH-141322)

* Rewrite Mocking Unbound Methods paragraph to second person
(cherry picked from commit ec85d3cbfe)

Co-authored-by: Elena O <31424287+oklena@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-09 18:07:25 -06:00
Miss Islington (bot)
5ad2842915
[3.13] gh-141004: Document PySuper_Type (GH-141315) (GH-141319)
gh-141004: Document `PySuper_Type` (GH-141315)
(cherry picked from commit 14c62227f9)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 20:01:33 +00:00
Miss Islington (bot)
811fd8f4a4
[3.13] gh-141004: Document PyClassMethod* and PyStaticMethod* APIs (GH-141296) (GH-141309)
gh-141004: Document `PyClassMethod*` and `PyStaticMethod*` APIs (GH-141296)
(cherry picked from commit 807db68ddd)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 18:09:43 +00:00
Miss Islington (bot)
aa2c8ea1e7
[3.13] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) (GH-141305)
gh-141004: Document `PyFunction_SetKwDefaults` (GH-141294)
(cherry picked from commit 18529b580b)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 17:55:02 +00:00
Miss Islington (bot)
a9619899fc
[3.13] gh-141004: Document PyExceptionInstance* APIs (GH-141301) (GH-141303)
gh-141004: Document `PyExceptionInstance*` APIs (GH-141301)
(cherry picked from commit b5a0c72492)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 12:20:18 -05:00
Miss Islington (bot)
92ae15802d
[3.13] gh-141004: Document Py_func_type_input (GH-141273) (GH-141299)
gh-141004: Document `Py_func_type_input` (GH-141273)
(cherry picked from commit 8dd8498286)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-09 16:28:26 +00:00
Miss Islington (bot)
2dd8812850
[3.13] gh-141004: document curses C API (GH-141254) (#141293)
gh-141004: document `curses` C API (GH-141254)
(cherry picked from commit dbe40904a7)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-09 15:50:46 +00:00
Miss Islington (bot)
a6d980472d
[3.13] gh-141004: Document PyWeakref_CheckRefExact (GH-141279) (GH-141291)
gh-141004: Document `PyWeakref_CheckRefExact` (GH-141279)
(cherry picked from commit 60155329a0)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 15:39:53 +00:00
Peter Bierma
7b3f7ffb47
[3.13] gh-141004: Document deprecated aliases for memory allocation (GH-141146) (GH-141289)
* gh-141004: Document deprecated aliases for memory allocation (GH-141146)

(cherry picked from commit 1d738dea63)
2025-11-09 15:37:13 +00:00
Bénédikt Tran
718886f6c6
[3.13] gh-140530: fix a reference leak in an error path for raise exc from cause (GH-140908) (#141283)
gh-140530: fix a reference leak in an error path for `raise exc from cause` (#140908)

Fix a reference leak in `raise E from T` when `T` is an exception
subtype for which `T.__new__` does not return an exception instance.

(cherry picked from commit 0c77e7c23b)
2025-11-09 15:57:26 +01:00
Bénédikt Tran
873f0d023c
[3.13] gh-100218: correctly set errno when socket.if_{nametoindex,indextoname} raise OSError (GH-140905) (#141285)
Previously, socket.if_nametoindex() and socket.if_indextoname() could raise
an `OSError` with a `None` errno. Now, the errno from libc is propagated.

(cherry picked from commit 3ce2d57b2f)
2025-11-09 13:31:49 +00:00
Miss Islington (bot)
052a53982a
[3.13] gh-141127: Clarify os.symlink() documentation for argument order (GH-141144) (#141277)
gh-141127: Clarify os.symlink() documentation for argument order (GH-141144)
(cherry picked from commit 7ae440f262)

Co-authored-by: Chilla Kalyan <127284726+chillakalyan@users.noreply.github.com>
2025-11-09 11:19:35 +01:00
Miss Islington (bot)
1cd0b74350
[3.13] gh-141004: Document Py_BUILD_ASSERT* macros (GH-141266) (GH-141270)
gh-141004: Document `Py_BUILD_ASSERT*` macros (GH-141266)
(cherry picked from commit 0ac890bea7)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 19:28:32 +00:00
Miss Islington (bot)
2a300e3642
[3.13] gh-141004: Document the PyDoc_VAR macro (GH-141263) (GH-141265)
gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
(cherry picked from commit 545299773b)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 18:20:56 +00:00
Miss Islington (bot)
10d44f72e5
[3.13] gh-141004: Document PyBUF_WRITEABLE (GH-141255) (GH-141260)
gh-141004: Document `PyBUF_WRITEABLE` (GH-141255)
(cherry picked from commit 5e5fc0404e)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-08 17:37:04 +00:00
Miss Islington (bot)
e46b808978
[3.13] gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250) (GH-141257)
gh-141004: Document `PyErr_ProgramTextObject` and `PyErr_ProgramText` (GH-141250)
(cherry picked from commit be1c72a45d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 15:53:28 +00:00
Miss Islington (bot)
82a274e700
[3.13] gh-141246: Link to correct Windows docs in time.sleep() doc (GH-141248) (#141252)
gh-141246: Link to correct Windows docs in `time.sleep()` doc (GH-141248)
(cherry picked from commit 6545a4e8f8)

Co-authored-by: 莯凛 <1348292515@qq.com>
2025-11-08 15:03:07 +00:00
Miss Islington (bot)
f8147a0316
[3.13] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) (#141235)
gh-141004: correctly document `Py_HASH_*` and `PyHASH_*` as `hash_info` attributes (GH-141233)
(cherry picked from commit 87942d911b)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-08 12:29:55 +00:00
Serhiy Storchaka
731832a024
[3.13] gh-140615: Update docstrings in the fcntl module (GH-140619) (GH-141231) (GH-141232)
* Refer to bytes objects or bytes-like objects instead of strings.
* Remove backticks -- they do not have effect on formatting.
* Re-wrap lines to ensure the pydoc output fits in 80 columns.
(cherry picked from commit 610377056b)
(cherry picked from commit 1a080199af)
2025-11-08 11:50:17 +00:00
Miss Islington (bot)
be33104f88
[3.13] gh-140793: Improve documentatation and tests for the ensure_ascii option in the json module (GH-140906) (GH-141228)
* Document that ensure_ascii=True forces escaping not only non-ASCII, but also
  non-printable characters (the only affected ASCII character is U+007F).
* Ensure that the help output for the json module does not exceed 80
  columns (except one long line in an example and generated lines).
* Add more tests.
(cherry picked from commit 7e90bac3cc)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-11-08 10:30:15 +00:00
Miss Islington (bot)
46d96dce63
[3.13] gh-139741: Make dist-pdf docs archive build work for macOS (GH-140837) (#141230)
Co-authored-by: Naitree Zhu <Naitreey@gmail.com>
2025-11-08 10:26:51 +00:00
Miss Islington (bot)
a728f7f89f
[3.13] gh-141004: Document Py_HASH_* macros (GH-141205) (#141224)
* gh-141004: Document `Py_HASH_*` macros (GH-141205)

(cherry picked from commit 3989e12d39)
(cherry picked from commit 8cec3d3a9d)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-08 09:22:02 +00:00
Miss Islington (bot)
dfbc5eb80e
[3.13] gh-140826: Update winreg's docstring (GH-141050) (GH-141200) (GH-141209)
(cherry picked from commit bea0d3d12b)
(cherry picked from commit b3377c3b41)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: AN Long <aisk@users.noreply.github.com>
2025-11-07 19:01:27 +00:00
Miss Islington (bot)
0efb799852
[3.13] gh-141004: Document PyTraceBack* APIs (GH-141192) (GH-141211)
gh-141004: Document `PyTraceBack*` APIs (GH-141192)
(cherry picked from commit d13ee0ae18)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-07 18:53:05 +00:00
Miss Islington (bot)
26c2a49857
[3.13] gh-141004: Document PyErr_WarnExplicitFormat (GH-141187) (GH-141203)
gh-141004: Document `PyErr_WarnExplicitFormat` (GH-141187)
(cherry picked from commit 9420795b47)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 16:25:58 +00:00
Miss Islington (bot)
09cc93dc67
[3.13] gh-141004: Document PyCapsule_Type (GH-141079) (GH-141198)
gh-141004: Document `PyCapsule_Type` (GH-141079)
(cherry picked from commit 7af9b5354d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-07 14:16:14 +00:00
Stan Ulbrych
0923704b49
[3.13] gh-139246: zero-width word paste can be wrong in default repl (GH-139254) (GH-141166)
(cherry picked from commit 4e6dba0ef7)

Signed-off-by: yihong0618 <zouzou0208@gmail.com>
Co-authored-by: yihong <zouzou0208@gmail.com>
Co-authored-by: grayjk <grayjk@gmail.com>
2025-11-07 13:51:03 +01:00
Miss Islington (bot)
353bfc813b
[3.13] gh-141141: Make base64.b85decode() thread safe (GH-141149) (GH-141185)
(cherry picked from commit a7bf27f7f5)

Co-authored-by: Benel Tayar <86257734+beneltayar@users.noreply.github.com>
2025-11-07 11:10:21 +00:00
Miss Islington (bot)
dcd2dbaf36
[3.13] gh-140734: fix off-by-one error when comparing to _SUN_PATH_MAX (GH-140903) (#141182)
gh-140734: fix off-by-one error when comparing to `_SUN_PATH_MAX` (GH-140903)

The limit includes a NULL terminator.
(cherry picked from commit 9a19900673)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2025-11-07 10:18:06 +00:00
Rodrigo Girão Serrão
e753887bd2
[3.13] Minor documentation improvements (GH-140626) (#141161) 2025-11-06 17:37:31 +00:00
Miss Islington (bot)
00032a4245
[3.13] gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151) (GH-141157)
* gh-141004: Document `Py_GetRecursionLimit` and `Py_SetRecursionLimit` (GH-141151)
(cherry picked from commit 0b260305d3)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

---------

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-06 17:00:03 +00:00
Stan Ulbrych
f1a93727c4
[3.13] gh-140939: Fix memory leak in _PyBytes_FormatEx error path (GH-140957) (#141155)
(cherry picked from commit d6c89a2df2)
2025-11-06 16:16:43 +00:00
Peter Bierma
908695b5c7
[3.13] gh-141004: Document PyLong_FromPid and PyLong_AsPid (GH-141028) (GH-141143)
* gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028)

Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit bcc524f82d)
2025-11-06 14:10:24 +00:00
Miss Islington (bot)
ccbee02436
[3.13] gh-141004: Document Py_hexdigits (GH-141059) (GH-141139)
gh-141004: Document `Py_hexdigits` (GH-141059)
(cherry picked from commit 54110e20e0)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-11-06 13:56:14 +00:00
Miss Islington (bot)
a8cd8f0441
[3.13] gh-141004: Document built-in iterator types in the C API (GH-141006) (GH-141135)
gh-141004: Document built-in iterator types in the C API (GH-141006)

Adds documentation for each of the following:

- PyEnum_Type
- PyFilter_Type
- PyMap_Type
- PyReversed_Type
- PyZip_Type

In addition, PyRange_Type and PyRange_Check are also documented.
(cherry picked from commit 1697cb5710)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
2025-11-06 12:35:31 +00:00
Miss Islington (bot)
1be80bec79
[3.13] gh-125346: Add more base64 tests (GH-141061) (GH-141130) (GH-141133)
(cherry picked from commit fd17ee026f)

Add more tests for the altchars argument of b64decode() and for the map01
argument of b32decode().
(cherry picked from commit 13360efd38)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2025-11-06 14:32:42 +02:00