]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 28 Nov 2022 11:25:04 +0000 (03:25 -0800)
committerGitHub <noreply@github.com>
Mon, 28 Nov 2022 11:25:04 +0000 (03:25 -0800)
commit5dce4ab736e76bedd6ec0615c0920a059bf5d13c
tree93b8e433c1a9aa628ec0197b8873a29330266567
parent6f658dd60dc759b5cb146f321bff06a8417abaf4
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)

These slots are marked "should be treated as read-only" in the
table at the start of the document.  That doesn't say anything about
setting them in the static struct.

`tp_bases` docs did say that it should be ``NULL`` (TIL!). If you
ignore that, seemingly nothing bad happens. However, some slots
may not be inherited, depending on which sub-slot structs are present.
(FWIW, NumPy sets tp_bases and is affected by the quirk -- though to
be fair, its DUAL_INHERIT code probably predates tp_bases docs, and
also the result happens to be benign.)

This patch makes things explicit.
It also makes the summary table legend easier to scan.

(cherry picked from commit 219696abb240607d3f807853c4c180825e60716e)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Doc/c-api/typeobj.rst