[Python-checkins] gh-88071: Update docstrings of dataclass' astuple and asdict (#101806)
carljm
webhook-mailer at python.org
Fri Mar 10 19:27:48 EST 2023
https://github.com/python/cpython/commit/767d3a8f6f2f94daa15ad3759d0ecdf4c009b7ab
commit: 767d3a8f6f2f94daa15ad3759d0ecdf4c009b7ab
branch: main
author: Ilya V. Schurov <ilya at schurov.com>
committer: carljm <carl at oddbird.net>
date: 2023-03-10T17:27:41-07:00
summary:
gh-88071: Update docstrings of dataclass' astuple and asdict (#101806)
Update dataclasses.astuple and dataclasses.asdict docstrings to reflect that they deep copy objects in the field values.
files:
M Lib/dataclasses.py
diff --git a/Lib/dataclasses.py b/Lib/dataclasses.py
index 24f3779ebb8e..f4617b1dbdac 100644
--- a/Lib/dataclasses.py
+++ b/Lib/dataclasses.py
@@ -1281,7 +1281,7 @@ class C:
If given, 'dict_factory' will be used instead of built-in dict.
The function applies recursively to field values that are
dataclass instances. This will also look into built-in containers:
- tuples, lists, and dicts.
+ tuples, lists, and dicts. Other objects are copied with 'copy.deepcopy()'.
"""
if not _is_dataclass_instance(obj):
raise TypeError("asdict() should be called on dataclass instances")
@@ -1353,7 +1353,7 @@ class C:
If given, 'tuple_factory' will be used instead of built-in tuple.
The function applies recursively to field values that are
dataclass instances. This will also look into built-in containers:
- tuples, lists, and dicts.
+ tuples, lists, and dicts. Other objects are copied with 'copy.deepcopy()'.
"""
if not _is_dataclass_instance(obj):
More information about the Python-checkins
mailing list