gh-145369: Warn against reusing dataclass field objects#145373
Closed
gourijain029-del wants to merge 1 commit intopython:mainfrom
Closed
gh-145369: Warn against reusing dataclass field objects#145373gourijain029-del wants to merge 1 commit intopython:mainfrom
gourijain029-del wants to merge 1 commit intopython:mainfrom
Conversation
…reused Add warning to dataclasses documentation explaining that Field objects returned by field() should not be reused across multiple fields or classes, as they are modified in place by the decorator.
bedevere-app
bot
added
awaiting review
docs
Member
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a warning to the dataclasses documentation explaining that field objects should not be reused across multiple fields or classes.
The issue is that field() returns an object that gets modified in place by the @DataClass decorator. If you reuse the same field object, it becomes corrupted and causes the class to behave incorrectly.
The warning includes:
Fixes #145369
📚 Documentation preview 📚: https://cpython-previews--145373.org.readthedocs.build/