FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-43905: Expand dataclasses.astuple() and asdict() docs by akulakov · Pull Request #26154 · python/cpython · GitHub

/ cpython Public

bpo-43905: Expand dataclasses.astuple() and asdict() docs - #26154

Merged
miss-islington merged 8 commits into
python:mainfrom
akulakov:update-dataclass-astuple-doc
Nov 29, 2021
ConversationCommits (8)ChecksFiles changed
Merged

bpo-43905: Expand dataclasses.astuple() and asdict() docs#26154
miss-islington merged 8 commits into
python:mainfrom
akulakov:update-dataclass-astuple-doc

Conversation

akulakov commented May 15, 2021 •
edited by miss-islington
Loading

Copy link
Copy Markdown
Contributor

Expanded astuple() docs, warning about deepcopy being applied
and providing a workaround.

https://bugs.python.org/issue43905

Automerge-Triggered-By: GH:ericvsmith

Update dataclasses.rst
75a6626 
Expanded ``astuple()`` docs.
akulakov requested a review from ericvsmith as a code owner May 15, 2021 22:19
bedevere-bot added the docs Documentation in the Doc dir label May 15, 2021
akulakov changed the title bpo-43905: Expand dataclass.astuple() docs bpo-43905: Expand dataclasses.astuple() docs May 15, 2021
ericvsmith reviewed May 15, 2021
View reviewed changes
Comment thread Doc/library/dataclasses.rst Outdated

akulakov commented May 24, 2021

Copy link
Copy Markdown
Contributor Author

@ericvsmith thanks for the review, updated per your comment.

github-actions Bot commented Jun 24, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Jun 24, 2021

ericvsmith commented Nov 28, 2021

Copy link
Copy Markdown
Member

Closing and re-opening in order to run tests again.

ericvsmith closed this Nov 28, 2021
ericvsmith reopened this Nov 28, 2021
ericvsmith requested changes Nov 29, 2021
View reviewed changes
Comment thread Doc/library/dataclasses.rst Outdated
Comment thread Doc/library/dataclasses.rst Outdated

bedevere-bot commented Nov 29, 2021

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

ericvsmith requested changes Nov 29, 2021
View reviewed changes

ericvsmith left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This looks good to me. Can you add the corresponding asdict change?

akulakov changed the title bpo-43905: Expand dataclasses.astuple() docs bpo-43905: Expand dataclasses.astuple() and asdict() docs Nov 29, 2021

akulakov commented Nov 29, 2021

Copy link
Copy Markdown
Contributor Author

@ericvsmith I've added the note and workaround to asdict and tweaked the wording a bit to make it clearer that the last paragraph refers to the respective function rather than the workaround example.

ericvsmith requested changes Nov 29, 2021
View reviewed changes

ericvsmith left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Other than the news entry, this looks good to me.

Comment thread Misc/NEWS.d/next/Documentation/2021-05-24-05-00-12.bpo-43905.tBIndE.rst Outdated
@@ -0,0 +1,2 @@
Expanded ``dataclasses.astuple()`` docs, warning about deepcopy being applied
and providing a workaround. No newline at end of file

ericvsmith Nov 29, 2021

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This should also mention asdict().

ericvsmith removed the stale Stale PR or inactive for long period of time. label Nov 29, 2021

akulakov commented Nov 29, 2021

Copy link
Copy Markdown
Contributor Author

@ericvsmith Updated the news, please take a look.

miss-islington merged commit c1f93f0 into python:main Nov 29, 2021

miss-islington commented Nov 29, 2021

Copy link
Copy Markdown
Contributor

Thanks @akulakov for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 29, 2021
bpo-43905: Expand dataclasses.astuple() and asdict() docs (pythonGH-2…
066327b 
…6154)

Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 29, 2021

bedevere-bot commented Nov 29, 2021

Copy link
Copy Markdown

GH-29851 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 29, 2021
bpo-43905: Expand dataclasses.astuple() and asdict() docs (pythonGH-2…
30747fd 
…6154)

Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>

bedevere-bot commented Nov 29, 2021

Copy link
Copy Markdown

GH-29852 is a backport of this pull request to the 3.9 branch.

miss-islington added a commit that referenced this pull request Nov 29, 2021
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
376b24e 
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
miss-islington added a commit that referenced this pull request Nov 29, 2021
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
32f1491 
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
shihai1991 added a commit to shihai1991/cpython that referenced this pull request Dec 1, 2021
Merge branch 'main' into bpo_44133
6edb6f5 
* main: (21 commits)
  bpo-45876:  Have stdev() also use decimal specific square root. (pythonGH-29869)
  bpo-45876:  Correctly rounded stdev() and pstdev() for the Decimal case (pythonGH-29828)
  bpo-45711: Change exc_info related APIs to derive type and traceback from the exception instance (pythonGH-29780)
  bpo-30533:Add function inspect.getmembers_static that does not call properties or dynamic properties. (python#20911)
  bpo-45476: Disallow using asdl_seq_GET() as l-value (pythonGH-29866)
  bpo-45476: Add _Py_RVALUE() macro (pythonGH-29860)
  bpo-33381: [doc] strftime's %f option may pad zeros on the left or the right (pythonGH-29801)
  Fix EncodingWarning in Tools/freeze/test/freeze.py (pythonGH-29742)
  no-issue: remove unused import from test_graphlib.py (pythonGH-29853)
  bpo-45931: Prevent Directory.Build.props/targets from leaking from directories above the repo when building on Windows (pythonGH-29854)
  bpo-45653: fix test_embed on windows (pythonGH-29814)
  bpo-45917: Add math.exp2() method - return 2 raised to the power of x (pythonGH-29829)
  bpo-43905: Expand dataclasses.astuple() and asdict() docs (pythonGH-26154)
  bpo-44391: Remove unused argument from a varargs call. (pythonGH-29843)
  bpo-45881: configure --with-freeze-module --with-build-python (pythonGH-29835)
  bpo-45847: PY_STDLIB_MOD_SIMPLE now checks py_stdlib_not_available (pythonGH-29844)
  bpo-45828: Use unraisable exceptions within sqlite3 callbacks (FH-29591)
  bpo-40280: Emscripten systems use .wasm suffix by default (pythonGH-29842)
  bpo-45723: Sort the grand AC_CHECK_HEADERS check (pythonGH-29846)
  bpo-45847: Make socket module conditional (pythonGH-29769)
  ...
shihai1991 added a commit to shihai1991/cpython that referenced this pull request Dec 1, 2021
Merge branch 'main' into bpo_44133
b71b124 
* main: (21 commits)
  bpo-45876:  Have stdev() also use decimal specific square root. (pythonGH-29869)
  bpo-45876:  Correctly rounded stdev() and pstdev() for the Decimal case (pythonGH-29828)
  bpo-45711: Change exc_info related APIs to derive type and traceback from the exception instance (pythonGH-29780)
  bpo-30533:Add function inspect.getmembers_static that does not call properties or dynamic properties. (python#20911)
  bpo-45476: Disallow using asdl_seq_GET() as l-value (pythonGH-29866)
  bpo-45476: Add _Py_RVALUE() macro (pythonGH-29860)
  bpo-33381: [doc] strftime's %f option may pad zeros on the left or the right (pythonGH-29801)
  Fix EncodingWarning in Tools/freeze/test/freeze.py (pythonGH-29742)
  no-issue: remove unused import from test_graphlib.py (pythonGH-29853)
  bpo-45931: Prevent Directory.Build.props/targets from leaking from directories above the repo when building on Windows (pythonGH-29854)
  bpo-45653: fix test_embed on windows (pythonGH-29814)
  bpo-45917: Add math.exp2() method - return 2 raised to the power of x (pythonGH-29829)
  bpo-43905: Expand dataclasses.astuple() and asdict() docs (pythonGH-26154)
  bpo-44391: Remove unused argument from a varargs call. (pythonGH-29843)
  bpo-45881: configure --with-freeze-module --with-build-python (pythonGH-29835)
  bpo-45847: PY_STDLIB_MOD_SIMPLE now checks py_stdlib_not_available (pythonGH-29844)
  bpo-45828: Use unraisable exceptions within sqlite3 callbacks (FH-29591)
  bpo-40280: Emscripten systems use .wasm suffix by default (pythonGH-29842)
  bpo-45723: Sort the grand AC_CHECK_HEADERS check (pythonGH-29846)
  bpo-45847: Make socket module conditional (pythonGH-29769)
  ...
ischurov added a commit to ischurov/cpython that referenced this pull request Feb 10, 2023
Update dataclasses.astuple and dataclasses.asdict docstrings to refle…
c537df5 
…ct that they deep copy objects in the field values, according to the changes in the docs, see python#26154
ischurov mentioned this pull request Feb 10, 2023
Merged
mandolaerik mannequin mentioned this pull request Apr 10, 2022
Closed
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ericvsmith ericvsmith approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL