statikk 0.1.4__tar.gz → 0.1.6__tar.gz

{statikk-0.1.4 → statikk-0.1.6}/PKG-INFO

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

{statikk-0.1.4 → statikk-0.1.6}/src/statikk/engine.py

@@ -313,7 +313,9 @@ class Table:
             raise InvalidIndexNameError(f"The provided index name '{index_name}' is not configured on the table.")
         index = index_filter[0]
         key_condition = hash_key.evaluate(index.hash_key.name)
-        if range_key is None and FIELD_STATIKK_TYPE not in model_class.index_definitions()[index_name].pk_fields:
+        if (
+            not range_key or (range_key and range_key.value != model_class.type())
+        ) and FIELD_STATIKK_TYPE not in model_class.index_definitions()[index_name].pk_fields:
             range_key = BeginsWith(model_class.type())
         if range_key:
             if not model_class.is_nested():

{statikk-0.1.4 → statikk-0.1.6}/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,6 +146,17 @@ 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()))

{statikk-0.1.4 → statikk-0.1.6}/src/statikk.egg-info/PKG-INFO

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

{statikk-0.1.4 → statikk-0.1.6}/tests/test_engine.py

@@ -13,6 +13,7 @@ from statikk.engine import (
     InvalidIndexNameError,
     ItemNotFoundError,
 )
+from statikk.fields import FIELD_STATIKK_TYPE
 from statikk.models import (
     DatabaseModel,
     KeySchema,
@@ -670,13 +671,13 @@ def test_query_no_range_key_provided():
     mock_dynamodb().stop()
 
 
-def test_query_no_range_is_provided_but_model_does_not_include_type_in_range_key():
+def test_query_hash_key_is_type():
     class Model(DatabaseModel):
         tier: str
 
         @classmethod
         def index_definitions(cls) -> dict[str, IndexFieldConfig]:
-            return {"main-index": IndexFieldConfig(pk_fields=["__statikk_type"], sk_fields=["tier"])}
+            return {"main-index": IndexFieldConfig(pk_fields=[FIELD_STATIKK_TYPE], sk_fields=["tier"])}
 
     mock_dynamodb().start()
     table = Table(

{statikk-0.1.4 → statikk-0.1.6}/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