[Python-checkins] gh-100315: clarification to `__slots__` docs. (GH-102621)

miss-islington webhook-mailer at python.org
Tue Mar 14 05:30:41 EDT 2023


https://github.com/python/cpython/commit/2c015a674d9f983cec0bac627e09ca3e12631bca
commit: 2c015a674d9f983cec0bac627e09ca3e12631bca
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2023-03-14T02:30:28-07:00
summary:

gh-100315: clarification to `__slots__` docs. (GH-102621)


refer to tp_itemsize in discussion on "variable-length" built-in types
(cherry picked from commit 88c262c086077377b40dfae5e46f597e28ffe3c9)

Co-authored-by: T <tnie at tuta.io>

files:
M Doc/reference/datamodel.rst

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index e5a1e4d89f74..a5b8009ba9c0 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1876,8 +1876,10 @@ Notes on using *__slots__*
   descriptor directly from the base class). This renders the meaning of the
   program undefined.  In the future, a check may be added to prevent this.
 
-* Nonempty *__slots__* does not work for classes derived from "variable-length"
-  built-in types such as :class:`int`, :class:`bytes` and :class:`tuple`.
+* :exc:`TypeError` will be raised if nonempty *__slots__* are defined for a
+  class derived from a
+  :c:member:`"variable-length" built-in type <PyTypeObject.tp_itemsize>` such as
+  :class:`int`, :class:`bytes`, and :class:`tuple`.
 
 * Any non-string :term:`iterable` may be assigned to *__slots__*.
 



More information about the Python-checkins mailing list