add testing

Author: SkafteNicki

tests/tests_pytorch/models/test_hparams.py

@@ -17,7 +17,7 @@
 import pickle
 import sys
 from argparse import Namespace
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from enum import Enum
 from unittest import mock
 
@@ -881,6 +881,32 @@ def test_dataclass_lightning_module(tmp_path):
     assert model.hparams == {"mandatory": 33, "optional": "cocofruit"}
 
 
+def test_dataclass_with_init_false_fields():
+    """Test that save_hyperparameters() filters out fields with init=False and issues a warning."""
+
+    @dataclass
+    class DataClassWithInitFalseFieldsModel(BoringModel):
+        mandatory: int
+        optional: str = "optional"
+        non_init_field: int = field(default=999, init=False)
+        another_non_init: str = field(default="not_in_init", init=False)
+
+        def __post_init__(self):
+            super().__init__()
+            self.save_hyperparameters()
+
+    with pytest.warns(UserWarning, match="Detected a dataclass with fields with `init=False`"):
+        model = DataClassWithInitFalseFieldsModel(33, optional="cocofruit")
+
+    expected_hparams = {"mandatory": 33, "optional": "cocofruit"}
+    assert model.hparams == expected_hparams
+
+    assert model.non_init_field == 999
+    assert model.another_non_init == "not_in_init"
+    assert "non_init_field" not in model.hparams
+    assert "another_non_init" not in model.hparams
+
+
 class NoHparamsModel(BoringModel):
     """Tests a model without hparams."""