Skip to content

gh-145369: document dataclass could possibly mutate provided field objects #145387

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

Open
v01dXYZ wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

gh-145369: document dataclass could possibly mutate provided field objects #145387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 0 deletions Doc/library/dataclasses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,11 @@ Module contents
used because ``None`` is a valid value for some parameters with
a distinct meaning. No code should directly use the :const:`MISSING` value.

:deco:`dataclass` is free to possibly mutate the provided field
objects. As such, do not use the same object for multiple fields
even if they share the same properties. If so, the updated class is
not ensured to be well-functioning.

The parameters to :func:`!field` are:

- *default*: If provided, this will be the default value for this
Expand Down
Loading