Skip to content

gh-137714: Improving the repr of dataclasses.Field and dataclasses._DataclassParams #137715

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

Closed
wants to merge 3 commits into from
Closed

gh-137714: Improving the repr of dataclasses.Field and dataclasses._DataclassParams #137715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63c2362
Improving the repr of dataclasses.Field and dataclasses._DataclassParams
osvathbotond Aug 13, 2025
c22056e
Merge branch 'main' into fix-issue-137714
osvathbotond Aug 13, 2025
f5f7493
📜🤖 Added by blurb_it.
blurb-it[bot] Aug 13, 2025
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
40 changes: 20 additions & 20 deletions Lib/dataclasses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,17 +311,17 @@ def __init__(self, default, default_factory, init, repr, hash, compare,
@recursive_repr()
def __repr__(self):
return ('Field('
f'name={self.name!r},'
f'type={self.type!r},'
f'default={self.default!r},'
f'default_factory={self.default_factory!r},'
f'init={self.init!r},'
f'repr={self.repr!r},'
f'hash={self.hash!r},'
f'compare={self.compare!r},'
f'metadata={self.metadata!r},'
f'kw_only={self.kw_only!r},'
f'doc={self.doc!r},'
f'name={self.name!r}, '
f'type={self.type!r}, '
f'default={self.default!r}, '
f'default_factory={self.default_factory!r}, '
f'init={self.init!r}, '
f'repr={self.repr!r}, '
f'hash={self.hash!r}, '
f'compare={self.compare!r}, '
f'metadata={self.metadata!r}, '
f'kw_only={self.kw_only!r}, '
f'doc={self.doc!r}, '
f'_field_type={self._field_type}'
')')

Expand Down Expand Up @@ -372,15 +372,15 @@ def __init__(self,

def __repr__(self):
return ('_DataclassParams('
f'init={self.init!r},'
f'repr={self.repr!r},'
f'eq={self.eq!r},'
f'order={self.order!r},'
f'unsafe_hash={self.unsafe_hash!r},'
f'frozen={self.frozen!r},'
f'match_args={self.match_args!r},'
f'kw_only={self.kw_only!r},'
f'slots={self.slots!r},'
f'init={self.init!r}, '
f'repr={self.repr!r}, '
f'eq={self.eq!r}, '
f'order={self.order!r}, '
f'unsafe_hash={self.unsafe_hash!r}, '
f'frozen={self.frozen!r}, '
f'match_args={self.match_args!r}, '
f'kw_only={self.kw_only!r}, '
f'slots={self.slots!r}, '
f'weakref_slot={self.weakref_slot!r}'
')')

Expand Down
24 changes: 12 additions & 12 deletions Lib/test/test_dataclasses/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ def test_field_repr(self):
int_field = field(default=1, init=True, repr=False, doc='Docstring')
int_field.name = "id"
repr_output = repr(int_field)
expected_output = "Field(name='id',type=None," \
f"default=1,default_factory={MISSING!r}," \
"init=True,repr=False,hash=None," \
"compare=True,metadata=mappingproxy({})," \
f"kw_only={MISSING!r}," \
"doc='Docstring'," \
expected_output = "Field(name='id', type=None, " \
f"default=1, default_factory={MISSING!r}, " \
"init=True, repr=False, hash=None, " \
"compare=True, metadata=mappingproxy({}), " \
f"kw_only={MISSING!r}, " \
"doc='Docstring', " \
"_field_type=None)"

self.assertEqual(repr_output, expected_output)
Expand All @@ -84,7 +84,7 @@ def test_field_recursive_repr(self):
rec_field.name = "id"
repr_output = repr(rec_field)

self.assertIn(",type=...,", repr_output)
self.assertIn(", type=..., ", repr_output)

def test_recursive_annotation(self):
class C:
Expand All @@ -94,7 +94,7 @@ class C:
class D:
C: C = field()

self.assertIn(",type=...,", repr(D.__dataclass_fields__["C"]))
self.assertIn(", type=..., ", repr(D.__dataclass_fields__["C"]))

def test_dataclass_params_repr(self):
# Even though this is testing an internal implementation detail,
Expand All @@ -104,10 +104,10 @@ def test_dataclass_params_repr(self):
class Some: pass

repr_output = repr(Some.__dataclass_params__)
expected_output = "_DataclassParams(init=True,repr=True," \
"eq=True,order=False,unsafe_hash=False,frozen=True," \
"match_args=True,kw_only=False," \
"slots=True,weakref_slot=False)"
expected_output = "_DataclassParams(init=True, repr=True, " \
"eq=True, order=False, unsafe_hash=False, frozen=True, " \
"match_args=True, kw_only=False, " \
"slots=True, weakref_slot=False)"
self.assertEqual(repr_output, expected_output)

def test_dataclass_params_signature(self):
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core_and_Builtins/2025-08-13-16-25-21.gh-issue-137714.pgwdGY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improving the repr of dataclasses.Field and dataclasses._DataclassParams by adding spaces between attributes.
Loading