Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Ilya V. Schurov 2023-03-11 01:27:41 +01:00 committed by GitHub
parent b48be8fa18
commit 767d3a8f6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Lib/dataclasses.py
View File

@ -1281,7 +1281,7 @@ def asdict(obj, *, dict_factory=dict):
If given, 'dict_factory' will be used instead of built-in dict. If given, 'dict_factory' will be used instead of built-in dict.
The function applies recursively to field values that are The function applies recursively to field values that are
dataclass instances. This will also look into built-in containers: 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): if not _is_dataclass_instance(obj):
raise TypeError("asdict() should be called on dataclass instances") raise TypeError("asdict() should be called on dataclass instances")
@ -1353,7 +1353,7 @@ def astuple(obj, *, tuple_factory=tuple):
If given, 'tuple_factory' will be used instead of built-in tuple. If given, 'tuple_factory' will be used instead of built-in tuple.
The function applies recursively to field values that are The function applies recursively to field values that are
dataclass instances. This will also look into built-in containers: 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): if not _is_dataclass_instance(obj):