Skip to content

gh-90562: Mention slots pitfall in dataclass docs #107391

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.

Sign up for GitHub

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

Merged
hugovk merged 10 commits into from
May 21, 2024
Merged

gh-90562: Mention slots pitfall in dataclass docs #107391

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e40f5f9
Mention slots pitfall in dataclass docs
thejcannon Jul 28, 2023
e9930d7
Update dataclasses.rst
thejcannon Jul 28, 2023
91bbbd2
Update dataclasses.rst
thejcannon Jul 28, 2023
08903c5
Double trouble
thejcannon Jul 28, 2023
fdff6b5
Update Doc/library/dataclasses.rst
thejcannon Aug 7, 2023
dde52b3
Merge branch 'main' into patch-1
erlend-aasland Jan 5, 2024
173d4b1
Update Doc/library/dataclasses.rst
thejcannon Mar 12, 2024
e6b3669
Merge branch 'main' into patch-1
thejcannon May 19, 2024
42606c3
Update Doc/library/dataclasses.rst
hugovk May 21, 2024
c4cb9ac
Merge branch 'main' into patch-1
hugovk May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Doc/library/dataclasses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,10 @@ Module contents
- ``slots``: If true (the default is ``False``), :attr:`~object.__slots__` attribute
will be generated and new class will be returned instead of the original one.
If :attr:`~object.__slots__` is already defined in the class, then :exc:`TypeError`
is raised.
is raised. Calling no-arg ``super()`` in dataclasses using ``slots=True`` will result in
the following Exception being raised:
Comment thread
hugovk marked this conversation as resolved.
Resolved
``TypeError: super(type, obj): obj must be an instance or subtype of type``.
The two-arg ``super()`` is a valid workaround. See :issue:`46404` for full details.

@AA-Turner AA-Turner Jul 28, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should try to capture everything relevant in the documentation -- what is relevant to the reader from the linked issue that isn't captured in your summary?

A

@thejcannon thejcannon Jul 28, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these two points are it. What to look for and how to workaround.

Comment thread
thejcannon marked this conversation as resolved.
Resolved

.. versionadded:: 3.10

Expand Down