gh-88071: Update docstrings of dataclass' astuple and asdict#101806
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
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
…ct that they deep copy objects in the field values, according to the changes in the docs, see python#26154
bedevere-bot commented Feb 10, 2023
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
All commit authors signed the Contributor License Agreement. |
arhadthedev added the stdlib 
hauntsaninja changed the title 
carljm approved these changes Mar 8, 2023
Member
carljm left a comment
carljm left a comment There was a problem hiding this comment.
Seems reasonable to mention this in the docstring as well as the docs; change LGTM.
iritkatriel pushed a commit to iritkatriel/cpython that referenced this pull request Mar 12, 2023
…ython#101806) Update dataclasses.astuple and dataclasses.asdict docstrings to reflect that they deep copy objects in the field values.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
5 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.
Updated docstrings of
astupleandasdictto reflect that they deep copy objects in the field values, according to the changes in the docs (see #26154 and #88071).I believe that this behaviour of
astupleandasdictis rather counter-intuitive and it is important to inform the developer about it in the docstring. (I personally spent half an hour trying to fix a bug that appeared because I wasn't aware of it.)