statikk 0.1.8__tar.gz → 0.1.10__tar.gz

{statikk-0.1.8 → statikk-0.1.10}/PKG-INFO

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

{statikk-0.1.8 → statikk-0.1.10}/src/statikk/engine.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime
-from typing import Any, Dict, Type, Optional, List, Union
+from typing import Any, Dict, Type, Optional, List, Union, get_type_hints, get_origin, get_args
 
 import boto3
 from botocore.config import Config
@@ -307,15 +307,20 @@ class Table:
         subtree_copy._parent = new_parent
         for node in subtree_copy.dfs_traverse_hierarchy():
             for idx in self.indexes:
-                new_index_values = self._compose_index_values(node, idx)
-                new_sort_key_value = new_index_values[idx.sort_key.name]
-                setattr(node, idx.sort_key.name, new_sort_key_value)
-                new_hash_key_value = new_index_values[idx.hash_key.name]
-                setattr(node, idx.hash_key.name, new_hash_key_value)
+                self.build_model_indexes(node)
             setattr(node, FIELD_STATIKK_PARENT_ID, new_parent.id)
 
         return subtree_copy
 
+    def build_model_indexes(self, model: T) -> T:
+        for idx in self.indexes:
+            new_index_values = self._compose_index_values(model, idx)
+            new_sort_key_value = new_index_values[idx.sort_key.name]
+            setattr(model, idx.sort_key.name, new_sort_key_value)
+            new_hash_key_value = new_index_values[idx.hash_key.name]
+            setattr(model, idx.hash_key.name, new_hash_key_value)
+        return model
+
     def batch_write(self):
         """
         Returns a context manager for batch writing items to the database. This method handles all the buffering of the
@@ -623,6 +628,26 @@ class Table:
                     data = self._serialize_item(enriched_item)
                     batch.delete_item(Key=data)
 
+    def inspect_optional_field(self, model_class, field_name):
+        field_type = model_class.model_fields[field_name].annotation
+
+        is_optional = False
+        inner_type = field_type
+
+        if get_origin(field_type) is Union:
+            args = get_args(field_type)
+            if len(args) == 2 and args[1] is type(None):
+                is_optional = True
+                inner_type = args[0]
+
+        elif hasattr(field_type, "__origin__") and field_type.__origin__ is Union:
+            args = getattr(field_type, "__args__", [])
+            if len(args) == 2 and args[1] is type(None):
+                is_optional = True
+                inner_type = args[0]
+
+        return (is_optional, inner_type)
+
     def reconstruct_hierarchy(self, items: list[dict]) -> Optional[dict]:
         """
         Reconstructs a hierarchical dictionary structure from a flat list of dictionaries
@@ -704,7 +729,9 @@ class Table:
                 if field_name.startswith("_"):
                     continue
 
-                field_type = field_info.annotation
+                is_optional, inner_type = self.inspect_optional_field(parent_model_class, field_name)
+
+                field_type = inner_type if is_optional else field_info.annotation
 
                 if field_type == child_model_class:
                     matching_fields.append((field_name, "single"))

{statikk-0.1.8 → statikk-0.1.10}/src/statikk/models.py

@@ -204,8 +204,22 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
 
     @property
     def should_delete(self) -> bool:
+        if self._is_any_parent_marked_for_deletion():
+            return True
+
         return self._should_delete or self.is_parent_changed()
 
+    def _is_any_parent_marked_for_deletion(self) -> bool:
+        current = self._parent
+        while current is not None:
+            if current._should_delete:
+                return True
+            current = current._parent
+        return False
+
+    def build_model_indexes(self) -> T:
+        return self._table.build_model_indexes(self)
+
     @classmethod
     def query(
         cls: Type[T],

{statikk-0.1.8 → statikk-0.1.10}/src/statikk.egg-info/PKG-INFO

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

{statikk-0.1.8 → statikk-0.1.10}/tests/test_engine.py

@@ -775,8 +775,20 @@ def test_nested_raw_models():
 
 
 def test_nested_hierarchies():
+    class OptionalModel(DatabaseModel):
+        xax: str = "xax"
+
+        @classmethod
+        def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+            return {"main-index": IndexFieldConfig(sk_fields=["xax"])}
+
+        @classmethod
+        def is_nested(cls) -> bool:
+            return True
+
     class TriplyNested(DatabaseModel):
         faz: str = "faz"
+        optional: Optional[OptionalModel] = None
 
         @classmethod
         def index_definitions(cls) -> dict[str, IndexFieldConfig]:
@@ -833,10 +845,10 @@ def test_nested_hierarchies():
                 sort_key=Key(name="gsi_sk"),
             )
         ],
-        models=[ModelHierarchy, NestedModel, DoublyNestedModel, TriplyNested],
+        models=[ModelHierarchy, NestedModel, DoublyNestedModel, TriplyNested, OptionalModel],
     )
     _create_dynamodb_table(table)
-    triple_nested_model = TriplyNested(faz="faz")
+    triple_nested_model = TriplyNested(faz="faz", optional=OptionalModel(xax="xax"))
     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])
@@ -851,6 +863,15 @@ 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"
+    assert (
+        hierarchy.nested.doubly_nested[0].items[0].gsi_sk
+        == "ModelHierarchy|state|NestedModel|foo|DoublyNestedModel|bar|TriplyNested|faz"
+    )
+    assert hierarchy.nested.doubly_nested[0].items[0].optional.gsi_pk == "foo_id"
+    assert (
+        hierarchy.nested.doubly_nested[0].items[0].optional.gsi_sk
+        == "ModelHierarchy|state|NestedModel|foo|DoublyNestedModel|bar|TriplyNested|faz|OptionalModel|xax"
+    )
     hierarchy.nested.doubly_nested[0].items[0].mark_for_delete()
     hierarchy.save()
     hierarchy = ModelHierarchy.query_hierarchy(hash_key=Equals("foo_id"))
@@ -930,3 +951,32 @@ def test_update_parent():
     hierarchy.save()
     hierarchy = Model.query_hierarchy(hash_key=Equals("model-1"))
     assert len(hierarchy.nested) == 0
+
+
+def test_rebuild_model_indexes():
+    class MyDatabaseModel(DatabaseModel):
+        foo: str = "foo"
+        bar: str = "bar"
+
+        @classmethod
+        def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+            return {"main-index": IndexFieldConfig(pk_fields=["foo"], sk_fields=["bar"])}
+
+    mock_dynamodb().start()
+    table = Table(
+        name="my-dynamodb-table",
+        key_schema=KeySchema(hash_key="id"),
+        indexes=[
+            GSI(
+                name="main-index",
+                hash_key=Key(name="gsi_pk"),
+                sort_key=Key(name="gsi_sk"),
+            )
+        ],
+        models=[MyDatabaseModel],
+    )
+    _create_dynamodb_table(table)
+    my_database_model = MyDatabaseModel(foo="foo", bar="bar")
+    my_database_model.build_model_indexes()
+    assert my_database_model.gsi_pk == "foo"
+    assert my_database_model.gsi_sk == "MyDatabaseModel|bar"

{statikk-0.1.8 → statikk-0.1.10}/tests/test_models.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel
-from statikk.models import DatabaseModel
+from statikk.models import DatabaseModel, IndexFieldConfig
 
 
 class SimpleObject(BaseModel):