statikk 0.1.5__tar.gz → 0.1.7__tar.gz

{statikk-0.1.5 → statikk-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: statikk
-Version: 0.1.5
+Version: 0.1.7
 Summary: statikk is a single table application (STA) library for DynamoDb.
 Home-page: https://github.com/terinia/statikk
 Author: Balint Biro

{statikk-0.1.5 → statikk-0.1.7}/src/statikk/engine.py

@@ -232,9 +232,13 @@ class Table:
 
         Returns the enriched database model instance.
         """
+
         with self.batch_write() as batch:
             for item in model.split_to_simple_objects():
-                batch.put(item)
+                if item._should_delete:
+                    batch.delete(item)
+                else:
+                    batch.put(item)
 
     def update_item(
         self,

{statikk-0.1.5 → statikk-0.1.7}/src/statikk/models.py

@@ -67,16 +67,18 @@ class TrackingMixin:
 
     def _recursive_hash(self) -> int:
         """
-        Compute a hash value for the model, ignoring nested DatabaseModel instances.
+        Compute a hash value for the model, ignoring specified fields and nested DatabaseModel instances.
 
-        This ensures that changes to child models don't affect the parent's hash.
+        This ensures that changes to ignored fields or child models don't affect the parent's hash.
 
         Returns:
-            A hash value representing the model's non-model fields.
+            A hash value representing the model's non-ignored fields.
         """
         if not self.should_track:
             return 0
 
+        ignored_fields = self.ignore_tracking_fields()
+
         values = []
         for field_name in self.model_fields:
             if not hasattr(self, field_name):
@@ -85,6 +87,9 @@ class TrackingMixin:
             if field_name.startswith("_"):
                 continue
 
+            if field_name in ignored_fields:
+                continue
+
             value = getattr(self, field_name)
 
             if hasattr(value, "__class__") and issubclass(value.__class__, DatabaseModel):
@@ -141,11 +146,23 @@ class TrackingMixin:
 
         return True
 
+    def ignore_tracking_fields(self) -> set:
+        """
+        Override this method to specify fields to ignore when tracking changes.
+
+        Returns:
+            A set specifying fields to ignore.
+            Example:
+            {"field1", "field2"}
+        """
+        return {}
+
 
 class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     id: str = Field(default_factory=lambda: str(uuid4()))
     _parent: Optional[DatabaseModel] = None
     _model_types_in_hierarchy: dict[str, Type[DatabaseModel]] = {}
+    _should_delete: bool = False
 
     @classmethod
     def type(cls) -> str:
@@ -240,6 +257,9 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
             return self._parent.should_write_to_database()
         return True
 
+    def mark_for_delete(self):
+        self._should_delete = True
+
     @classmethod
     def scan(
         cls,

{statikk-0.1.5 → statikk-0.1.7}/src/statikk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: statikk
-Version: 0.1.5
+Version: 0.1.7
 Summary: statikk is a single table application (STA) library for DynamoDb.
 Home-page: https://github.com/terinia/statikk
 Author: Balint Biro

{statikk-0.1.5 → statikk-0.1.7}/tests/test_engine.py

@@ -788,7 +788,7 @@ def test_nested_hierarchies():
 
     class DoublyNestedModel(DatabaseModel):
         bar: str
-        items: list[TriplyNested]
+        items: list[TriplyNested] = []
 
         @classmethod
         def index_definitions(cls) -> dict[str, IndexFieldConfig]:
@@ -803,7 +803,7 @@ def test_nested_hierarchies():
 
     class NestedModel(DatabaseModel):
         foo: str
-        doubly_nested: list[DoublyNestedModel]
+        doubly_nested: list[DoublyNestedModel] = []
 
         @classmethod
         def index_definitions(cls) -> dict[str, IndexFieldConfig]:
@@ -836,7 +836,8 @@ def test_nested_hierarchies():
         models=[ModelHierarchy, NestedModel, DoublyNestedModel, TriplyNested],
     )
     _create_dynamodb_table(table)
-    doubly_nested = DoublyNestedModel(bar="bar", items=[TriplyNested(faz="faz")])
+    triple_nested_model = TriplyNested(faz="faz")
+    doubly_nested = DoublyNestedModel(bar="bar", items=[triple_nested_model])
     double_nested_no_write = DoublyNestedModel(bar="far", items=[TriplyNested(faz="faz")])
     nested = NestedModel(foo="foo", doubly_nested=[doubly_nested, double_nested_no_write])
     model_hierarchy = ModelHierarchy(foo_id="foo_id", state="state", nested=nested)
@@ -850,5 +851,9 @@ def test_nested_hierarchies():
     assert hierarchy.nested.doubly_nested[0].gsi_pk == "foo_id"
     assert hierarchy.nested.doubly_nested[0].gsi_sk == "ModelHierarchy|state|NestedModel|foo|DoublyNestedModel|bar"
     assert hierarchy.nested.doubly_nested[0].items[0].gsi_pk == "foo_id"
+    hierarchy.nested.doubly_nested[0].items[0].mark_for_delete()
+    hierarchy.save()
+    hierarchy = ModelHierarchy.query_hierarchy(hash_key=Equals("foo_id"))
+    assert len(hierarchy.nested.doubly_nested[0].items) == 0
     hierarchy.delete()
     assert list(table.scan()) == []

{statikk-0.1.5 → statikk-0.1.7}/tests/test_models.py

@@ -106,3 +106,52 @@ def test_tracking_disabled():
     assert my_database_model.was_modified is True  # untracked models should always be marked as modified
     my_database_model.foo = "bar"
     assert my_database_model.was_modified is True
+
+
+def test_testing_configuration():
+    class MyOtherNestedDatabaseModel(DatabaseModel):
+        baz: str = "baz"
+        qux: str = "qux"
+        xax: str = "xax"
+
+        @classmethod
+        def is_nested(cls) -> bool:
+            return True
+
+        def ignore_tracking_fields(self) -> set:
+            return {"baz", "qux"}
+
+    class MyNestedDatabaseModel(DatabaseModel):
+        bar: str = "bar"
+        other_nested: MyOtherNestedDatabaseModel
+
+        @classmethod
+        def is_nested(cls) -> bool:
+            return True
+
+    class MyDatabaseModel(DatabaseModel):
+        foo: str = "foo"
+        nested: MyNestedDatabaseModel
+
+        @property
+        def should_track(self) -> bool:
+            return True
+
+        def ignore_tracking_fields(self) -> set:
+            return {"foo"}
+
+    my_database_model = MyDatabaseModel(
+        foo="foo",
+        nested=MyNestedDatabaseModel(
+            bar="bar", other_nested=MyOtherNestedDatabaseModel(baz="baz", qux="qux", xax="xax")
+        ),
+    )
+    assert my_database_model.was_modified is False
+    my_database_model.foo = "bar"
+    assert my_database_model.was_modified is False
+    my_database_model.nested.other_nested.baz = "qux"
+    assert my_database_model.nested.other_nested.was_modified is False
+    my_database_model.nested.other_nested.qux = "xax"
+    assert my_database_model.nested.other_nested.was_modified is False
+    my_database_model.nested.bar = "baz"
+    assert my_database_model.nested.was_modified is True