Validate the dataclass is frozen when allow_unfrozen=True (Fix #406)

PiperOrigin-RevId: 572257669
google · Oct 10, 2023 · a7e91dc · a7e91dc
1 parent ea1f487
commit a7e91dc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ Changelog follow https://keepachangelog.com/ format.
 
 ## [Unreleased]
 
+*   `edc`:
+    *   Changed: Raise an error if `allow_unfrozen=` is used on a non-frozen
+        dataclass
+
 ## [1.5.0] - 2023-09-19
 
 *   `ecolab`:

diff --git a/etils/edc/frozen_utils.py b/etils/edc/frozen_utils.py
@@ -30,6 +30,11 @@
 
 def add_unfrozen(cls: _Cls) -> _Cls:
   """Add the `frozen`, `unfrozen` methods."""
+  if not cls.__dataclass_params__.frozen:
+    raise ValueError(
+        'allow_unfrozen require the dataclass to be defined with'
+        f' `frozen=True`. For {cls}'
+    )
   cls_frozen = getattr(cls, 'frozen', None)
   cls_unfrozen = getattr(cls, 'has_unfrozen', None)