Skip to content

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

Merged
hugovk merged 10 commits into
python:mainfrom
thejcannon:patch-1
May 21, 2024
Merged

gh-90562: Mention slots pitfall in dataclass docs#107391
hugovk merged 10 commits into
python:mainfrom
thejcannon:patch-1

Conversation

@thejcannon

@thejcannonthejcannon commented Jul 28, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

Doesn't fix the issue, but does call it out so developers know that the issue doesn't lie with them (per-se) and gives them more info on where to go.

Will need to be backported to 3.10 and 3.11.

📚 Documentation preview 📚: https://cpython-previews--107391.org.readthedocs.build/

@bedevere-botbedevere-bot mentioned this pull request Jul 28, 2023
Closed
@bedevere-botbedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 28, 2023
@ericvsmith

ericvsmith commented Jul 28, 2023

Copy link
Copy Markdown
Member

I can't say I've seen something like this documented before. I'd like to get some more opinions on it.

@thejcannon

thejcannon commented Jul 28, 2023

Copy link
Copy Markdown
ContributorAuthor

Yeah. If the exception was more clear, maybe it wouldn't be warranted. But it took me longer than I want to admit to put two-and-two together. And then, because I'm super nosy I was able to find the linked issue.

So I feel for the little guy who has to piece it all together. (Speaking of, I should edit to suggest the workaround, the "old-style" super call)

@AA-TurnerAA-Turner added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 28, 2023
AA-Turner
AA-Turner reviewed Jul 28, 2023
View reviewed changes
Comment threadDoc/library/dataclasses.rst Outdated
is raised. Calling no-arg ``super()`` in dataclasses using ``slots=True`` will result in
the following Exception being raised:
``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-TurnerAA-TurnerJul 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

@thejcannonthejcannonJul 28, 2023

Copy link
Copy Markdown
ContributorAuthor

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.

@carljm

carljm commented Jul 28, 2023

Copy link
Copy Markdown
Member

I feel like early in my CPython contribution I remember someone saying "we don't document bugs, we fix them."

But I'm also sympathetic to the point of view that this is a significant limitation that people are likely to hit and with an extremely confusing symptom, and there's no clear fix for it on the horizon, and it would be kinder to our users to surface it in the docs.

So while it bugs me slightly, on the whole I think I'm in favor of this. I'll leave the final say to our documentation experts (and @ericvsmith as dataclasses expert.)

wookie184
wookie184 approved these changes Aug 7, 2023
View reviewed changes

@wookie184wookie184 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This seems sensible to me. It took me a while to find out what was going on when I encountered this issue.

Comment threadDoc/library/dataclasses.rst Outdated
thejcannonand others added 2 commits August 7, 2023 12:02
@thejcannon@AA-Turner
Update Doc/library/dataclasses.rst
fdff6b5
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@erlend-aasland
Merge branch 'main' into patch-1
dde52b3
JelleZijlstra
JelleZijlstra reviewed Mar 12, 2024
View reviewed changes
Comment threadDoc/library/dataclasses.rst Outdated
@thejcannon@JelleZijlstra
Update Doc/library/dataclasses.rst
173d4b1
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@hugovkhugovk removed the needs backport to 3.11 only security fixes label Apr 11, 2024
@hugovk

hugovk commented Apr 11, 2024

Copy link
Copy Markdown
Member

(This now has a merge conflict.)

@serhiy-storchakaserhiy-storchaka added the needs backport to 3.13 bugs and security fixes label May 9, 2024
hugovk
hugovk reviewed May 21, 2024
View reviewed changes
Comment threadDoc/library/dataclasses.rst Outdated
@hugovk
hugovk enabled auto-merge (squash) May 21, 2024 12:06
@hugovk
hugovk merged commit e3ed574 into python:mainMay 21, 2024
@miss-islington-app

miss-islington-appBot commented May 21, 2024

Copy link
Copy Markdown

Thanks @thejcannon for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2024
@thejcannon@AA-Turner
@JelleZijlstra@erlend-aasland@hugovk@miss-islington
pythongh-90562: Mention slots pitfall in dataclass docs (pythonGH-107391
2580775
)
(cherry picked from commit e3ed574)
Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2024
@thejcannon@AA-Turner
@JelleZijlstra@erlend-aasland@hugovk@miss-islington
pythongh-90562: Mention slots pitfall in dataclass docs (pythonGH-107391
823328c
)
(cherry picked from commit e3ed574)
Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented May 21, 2024

Copy link
Copy Markdown

GH-119350 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label May 21, 2024
@bedevere-app

bedevere-appBot commented May 21, 2024

Copy link
Copy Markdown

GH-119351 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label May 21, 2024
@thejcannon
thejcannon deleted the patch-1 branch May 21, 2024 19:43
@thejcannon

thejcannon commented May 21, 2024

Copy link
Copy Markdown
ContributorAuthor

Huzzah! 🎉

hugovk added a commit that referenced this pull request May 23, 2024
@miss-islington@thejcannon
@AA-Turner@JelleZijlstra@erlend-aasland@hugovk
[3.13]gh-90562: Mention slots pitfall in dataclass docs (GH-107391) (#…
89e2689
…119350)
Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request May 23, 2024
@miss-islington@thejcannon
@AA-Turner@JelleZijlstra@erlend-aasland@hugovk
[3.12]gh-90562: Mention slots pitfall in dataclass docs (GH-107391) (#…
ddaed62
…119351)
Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@JelleZijlstraJelleZijlstra mentioned this pull request May 28, 2024
Closed
@e-gebes

e-gebes commented Jun 19, 2024

Copy link
Copy Markdown

Could you backport this also to the 3.10 docs? I ran into the issue, and since I need to use 3.10 atm I read the 3.10 docs.

@hugovk

hugovk commented Jun 19, 2024

Copy link
Copy Markdown
Member

Sorry, 3.10 and 3.11 are only allowed to have security fixes: https://devguide.python.org/versions/

@e-gebese-gebes mentioned this pull request Jun 20, 2024
Closed
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@thejcannon@AA-Turner
@JelleZijlstra@erlend-aasland@hugovk@estyxx
pythongh-90562: Mention slots pitfall in dataclass docs (python#107391)
a378ae7
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstraJelleZijlstraJelleZijlstra left review comments
@hugovkhugovkhugovk left review comments
@AA-TurnerAA-TurnerAA-Turner left review comments
@ericvsmithericvsmithericvsmith approved these changes
+1 more reviewer
@wookie184wookie184wookie184 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

11 participants

@thejcannon@ericvsmith@carljm@hugovk@e-gebes@JelleZijlstra@AA-Turner@wookie184@serhiy-storchaka@bedevere-bot@erlend-aasland