Merge pull request #116 from ayasyrev:changed_fields

changed_fields with default value

Author: ayasyrev

src/model_constructor/helpers.py

@@ -73,8 +73,7 @@ class Cfg(BaseModel):
 
     name: Optional[str] = None
 
-    def _get_str_value(self, field: str) -> str:
-        value = getattr(self, field)
+    def _get_str(self, value: Any) -> str:
         if isinstance(value, type):
             value = value.__name__
         elif isinstance(value, partial):
@@ -83,6 +82,9 @@ def _get_str_value(self, field: str) -> str:
             value = value.__name__
         return value
 
+    def _get_str_value(self, field: str) -> str:
+        return self._get_str(getattr(self, field))
+
     def __repr__(self) -> str:
         return f"{self.__repr_name__()}(\n  {self.__repr_str__(chr(10) + '  ')})"
 
@@ -135,11 +137,14 @@ def print_set_fields(self) -> None:
         else:
             print("Nothing changed")
 
-    def print_changed_fields(self) -> None:
+    def print_changed_fields(self, show_default: bool = False, separator: str = " | ") -> None:
         """Print fields changed at init."""
         if self.changed_fields:
+            default_value = ""
             print("Changed fields:")
             for field in self.changed_fields:
-                print(f"{field}: {self._get_str_value(field)}")
+                if show_default:
+                    default_value = f"{separator}{self._get_str(self.model_fields[field].default)}"
+                print(f"{field}: {self._get_str_value(field)}{default_value}")
         else:
             print("Nothing changed")

tests/test_helpers.py

@@ -75,16 +75,27 @@ def test_cfg_repr_print(capsys: CaptureFixture[str]):
     cfg.print_set_fields()
     out = capsys.readouterr().out
     assert out == "Set fields:\nint_value: 0\n"
+
     # Changed fields
     cfg = Cfg2(name="cfg_name")
     assert cfg.changed_fields == {"name": "cfg_name"}
     cfg.int_value = 1
     cfg.name = None
     assert cfg.changed_fields == {"int_value": 1}
+
     # print
     cfg.print_changed_fields()
     out = capsys.readouterr().out
     assert out == "Changed fields:\nint_value: 1\n"
+
+    cfg.print_changed_fields(show_default=True)
+    out = capsys.readouterr().out
+    assert out == "Changed fields:\nint_value: 1 | 10\n"
+
+    cfg.print_changed_fields(show_default=True, separator=" / ")
+    out = capsys.readouterr().out
+    assert out == "Changed fields:\nint_value: 1 / 10\n"
+
     # return to default
     cfg.int_value = 10
     assert not cfg.changed_fields