Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarification in the __slots__ documentation #100315

Open
kwsp opened this issue Dec 17, 2022 · 5 comments
Open

Clarification in the __slots__ documentation #100315

kwsp opened this issue Dec 17, 2022 · 5 comments
Labels
docs Documentation in the Doc dir

Comments

@kwsp
Copy link
Contributor

kwsp commented Dec 17, 2022

Documentation

https://docs.python.org/3/reference/datamodel.html#notes-on-using-slots

One of the bulletpoints:

  • Nonempty slots does not work for classes derived from “variable-length” built-in types such as int, bytes and tuple.

Points to clarify:

  • What does "does not work" mean?
  • Whats the set of "variable-length" built-in types? Is str one of them?
@kwsp kwsp added the docs Documentation in the Doc dir label Dec 17, 2022
@AlexWaygood
Copy link
Member

AlexWaygood commented Dec 17, 2022

The interactive REPL is always useful for discovering some of the answers to questions like this:

>>> class Foo(int):
...   __slots__ = 'bar',
...   
Traceback (most recent call last):
  File "<string>", line 1, in <module>
TypeError: nonempty __slots__ not supported for subtype of 'int'
>>> class Foo(str):
...   __slots__ = 'bar',
...
>>>

For your first question, we could possibly change the wording to

  • TypeError will be raised if nonempty slots are defined for a class derived from a “variable-length” built-in type such as int, bytes or tuple.

For your second question: I don't know what's being referred to by "variable-length builtin types", so I agree that the wording there is a little opaque.

@kumaraditya303
Copy link
Contributor

kumaraditya303 commented Dec 17, 2022

You can check if any type is variable length or not from python with <type>.__itemsize__ != 0. As for what it means, variable length is a memory layout when data follows the object pointer in single block like tuple in contrast to list which stores items in a separate memory block.

@AlexWaygood
Copy link
Member

AlexWaygood commented Dec 17, 2022

As for what it means, variable length is a memory layout when data follows the object pointer in single block like tuple in contrast to list which stores items in a separate memory block.

Is this definition given anywhere in the documentation? If so, we could maybe link to it from the __slots__ docs here.

@AlexWaygood
Copy link
Member

AlexWaygood commented Dec 17, 2022

Looks like the best place to link to might be https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_itemsize. Hardly beginner-friendly, but probably better than no link at all (and I think it's good to keep the section on __slots__ in the datamodel terse).

@kumaraditya303
Copy link
Contributor

kumaraditya303 commented Dec 17, 2022

Yeah, that's the best place I can find too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants