Skip to content

bpo-45446: add a way to hide dataclass fields #28904

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
NiumXp wants to merge 2 commits into from
Closed

bpo-45446: add a way to hide dataclass fields #28904

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb6f50e
add hide parameter in dataclass field
NiumXp Oct 12, 2021
26b8a96
add to ignore hided fields in dataclasses
NiumXp Oct 12, 2021
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
12 changes: 10 additions & 2 deletions Lib/dataclasses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ class Field:
'compare',
'metadata',
'kw_only',
'hide',
'_field_type', # Private: not to be used by user code.
)

Expand All @@ -277,6 +278,7 @@ def __init__(self, default, default_factory, init, repr, hash, compare,
if metadata is None else
types.MappingProxyType(metadata))
self.kw_only = kw_only
self.hide = hide
self._field_type = None

def __repr__(self):
Expand All @@ -291,6 +293,7 @@ def __repr__(self):
f'compare={self.compare!r},'
f'metadata={self.metadata!r},'
f'kw_only={self.kw_only!r},'
f'hide={self.hide!r}'
f'_field_type={self._field_type}'
')')

Expand Down Expand Up @@ -344,7 +347,8 @@ def __repr__(self):
# so that a type checker can be told (via overloads) that this is a
# function whose type depends on its parameters.
def field(*, default=MISSING, default_factory=MISSING, init=True, repr=True,
hash=None, compare=True, metadata=None, kw_only=MISSING):
hash=None, compare=True, metadata=None, kw_only=MISSING,
hide=False):
"""Return an object to identify dataclass fields.

default is the default value of the field. default_factory is a
Expand All @@ -364,7 +368,7 @@ def field(*, default=MISSING, default_factory=MISSING, init=True, repr=True,
if default is not MISSING and default_factory is not MISSING:
raise ValueError('cannot specify both default and default_factory')
return Field(default, default_factory, init, repr, hash, compare,
metadata, kw_only)
metadata, kw_only, hide)


def _fields_in_init_order(fields):
Expand Down Expand Up @@ -1236,6 +1240,8 @@ def _asdict_inner(obj, dict_factory):
if _is_dataclass_instance(obj):
result = []
for f in fields(obj):
if f.hide:
continue
value = _asdict_inner(getattr(obj, f.name), dict_factory)
result.append((f.name, value))
return dict_factory(result)
Expand Down Expand Up @@ -1301,6 +1307,8 @@ def _astuple_inner(obj, tuple_factory):
if _is_dataclass_instance(obj):
result = []
for f in fields(obj):
if f.hide:
continue
value = _astuple_inner(getattr(obj, f.name), tuple_factory)
result.append(value)
return tuple_factory(result)
Expand Down