summaryrefslogtreecommitdiffstats
path: root/Doc/reference
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-03-14 09:30:28 (GMT)
committerGitHub <noreply@github.com>2023-03-14 09:30:28 (GMT)
commit2c015a674d9f983cec0bac627e09ca3e12631bca (patch)
tree854169a239bfbc6d3833014fdd1dca3167d1cf5c /Doc/reference
parent125f75cc133611e6e8ae6c6aeb4ded47a8cd5b1e (diff)
downloadcpython-2c015a674d9f983cec0bac627e09ca3e12631bca.zip
cpython-2c015a674d9f983cec0bac627e09ca3e12631bca.tar.gz
cpython-2c015a674d9f983cec0bac627e09ca3e12631bca.tar.bz2
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@tuta.io>
Diffstat (limited to 'Doc/reference')
-rw-r--r--Doc/reference/datamodel.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index e5a1e4d..a5b8009 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__*.