Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-99957: Add frozen_default parameter on dataclass_transform #99958

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

Merged
merged 7 commits into from
Dec 6, 2022
Merged

gh-99957: Add frozen_default parameter on dataclass_transform #99958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ab0ee4d
Update docs, typing.py, tests
debonte Dec 2, 2022
44e38d9
Jelle's suggestion
debonte Dec 3, 2022
85ea950
📜🤖 Added by blurb_it.
blurb-it[bot] Dec 3, 2022
6be4072
Merge branch 'main' into issue99957
debonte Dec 3, 2022
c6158c1
Double quotes around `frozen_default` in news
debonte Dec 3, 2022
c949233
Modify tests to validate that __dataclass_transform__ actually reflec…
debonte Dec 5, 2022
05a6414
Merge branch 'main' into issue99957
debonte Dec 5, 2022
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
4 changes: 4 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2575,6 +2575,10 @@ Functions and decorators
assumed to be True or False if it is omitted by the caller.
* ``kw_only_default`` indicates whether the ``kw_only`` parameter is
assumed to be True or False if it is omitted by the caller.
* ``frozen_default`` indicates whether the ``frozen`` parameter is
assumed to be True or False if it is omitted by the caller.

.. versionadded:: 3.12
* ``field_specifiers`` specifies a static list of supported classes
or functions that describe fields, similar to ``dataclasses.field()``.
* Arbitrary other keyword arguments are accepted in order to allow for
Expand Down
5 changes: 4 additions & 1 deletion Lib/test/test_typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7719,6 +7719,7 @@ class CustomerModel:
"eq_default": True,
"order_default": False,
"kw_only_default": True,
"frozen_default": False,
"field_specifiers": (),
"kwargs": {},
}
Expand Down Expand Up @@ -7749,6 +7750,7 @@ class CustomerModel(Decorated, frozen=True):
"eq_default": True,
"order_default": True,
"kw_only_default": False,
"frozen_default": False,
"field_specifiers": (),
"kwargs": {"make_everything_awesome": True},
}
Expand All @@ -7765,7 +7767,7 @@ def __new__(
return super().__new__(cls, name, bases, namespace)

Decorated = dataclass_transform(
order_default=True, field_specifiers=(Field,)
order_default=True, frozen_default=True, field_specifiers=(Field,)
)(ModelMeta)

class ModelBase(metaclass=Decorated): ...
Expand All @@ -7780,6 +7782,7 @@ class CustomerModel(ModelBase, init=False):
"eq_default": True,
"order_default": True,
"kw_only_default": False,
"frozen_default": True,
"field_specifiers": (Field,),
"kwargs": {},
}
Expand Down
4 changes: 4 additions & 0 deletions Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3363,6 +3363,7 @@ def dataclass_transform(
eq_default: bool = True,
order_default: bool = False,
kw_only_default: bool = False,
frozen_default: bool = False,
field_specifiers: tuple[type[Any] | Callable[..., Any], ...] = (),
**kwargs: Any,
) -> Callable[[T], T]:
Expand Down Expand Up @@ -3416,6 +3417,8 @@ class CustomerModel(ModelBase):
assumed to be True or False if it is omitted by the caller.
- ``kw_only_default`` indicates whether the ``kw_only`` parameter is
assumed to be True or False if it is omitted by the caller.
- ``frozen_default`` indicates whether the ``frozen`` parameter is
assumed to be True or False if it is omitted by the caller.
- ``field_specifiers`` specifies a static list of supported classes
or functions that describe fields, similar to ``dataclasses.field()``.
- Arbitrary other keyword arguments are accepted in order to allow for
Expand All @@ -3432,6 +3435,7 @@ def decorator(cls_or_fn):
"eq_default": eq_default,
"order_default": order_default,
"kw_only_default": kw_only_default,
"frozen_default": frozen_default,
"field_specifiers": field_specifiers,
"kwargs": kwargs,
}
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2022-12-03-05-58-48.gh-issue-99957.jLYYgN.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add ``frozen_default`` parameter to :func:`typing.dataclass_transform`.