statikk 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

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
@@ -17,7 +17,7 @@ from statikk.models import (
     KeySchema,
 )
 from statikk.fields import FIELD_STATIKK_TYPE, FIELD_STATIKK_PARENT_ID
-
+from copy import deepcopy
 from aws_xray_sdk.core import patch_all
 
 patch_all()
@@ -58,6 +58,7 @@ class Table:
         for idx in self.indexes:
             for model in self.models:
                 self._set_index_fields(model, idx)
+                model.model_rebuild(force=True)
                 model.set_table_ref(self)
         self._client = None
         self._dynamodb_table = None
@@ -162,7 +163,12 @@ class Table:
         )
 
     def _get_model_type_by_statikk_type(self, statikk_type: str) -> Type[DatabaseModel]:
-        return [model_type for model_type in self.models if model_type.type() == statikk_type][0]
+        model_type_filter = [model_type for model_type in self.models if model_type.type() == statikk_type]
+        if not model_type_filter:
+            raise InvalidModelTypeError(
+                f"Model type '{statikk_type}' not found. Make sure to register it through the models list."
+            )
+        return model_type_filter[0]
 
     def delete(self):
         """Deletes the DynamoDB table."""
@@ -235,7 +241,7 @@ class Table:
 
         with self.batch_write() as batch:
             for item in model.split_to_simple_objects():
-                if item._should_delete:
+                if item.should_delete:
                     batch.delete(item)
                 else:
                     batch.put(item)
@@ -288,11 +294,28 @@ class Table:
         response = self._get_dynamodb_table().update_item(**request)
         data = response["Attributes"]
         for key, value in data.items():
-            if key == FIELD_STATIKK_TYPE:
+            if key in [FIELD_STATIKK_TYPE, FIELD_STATIKK_PARENT_ID]:
                 continue
             data[key] = self._deserialize_value(value, model.model_fields[key])
         return type(model)(**data)
 
+    def reparent_subtree(self, subtree_root: T, new_parent: T) -> T:
+        subtree_copy = deepcopy(subtree_root)
+        subtree_root._parent_changed = True
+
+        subtree_copy.set_parent_references(subtree_copy, force_override=True)
+        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)
+            setattr(node, FIELD_STATIKK_PARENT_ID, new_parent.id)
+
+        return subtree_copy
+
     def batch_write(self):
         """
         Returns a context manager for batch writing items to the database. This method handles all the buffering of the
@@ -462,12 +485,11 @@ class Table:
         self,
         item: DatabaseModel,
         indexes: List[GSI],
-        force_override_index_fields: bool = False,
     ) -> DatabaseModel:
         for idx in indexes:
             index_fields = self._compose_index_values(item, idx)
             for key, value in index_fields.items():
-                if hasattr(item, key) and (getattr(item, key) is not None and not force_override_index_fields):
+                if hasattr(item, key) and (getattr(item, key) is not None and not item._parent_changed):
                     continue
                 if value is not None:
                     setattr(item, key, value)
@@ -558,8 +580,11 @@ class Table:
         return self.delimiter.join(sort_key_values)
 
     def _compose_index_values(self, model: DatabaseModel, idx: GSI) -> Dict[str, Any]:
-        hash_key_fields = model.index_definitions().get(idx.name, []).pk_fields
+        hash_key_fields = model.index_definitions().get(idx.name, None)
+        if hash_key_fields is None:
+            raise IncorrectHashKeyError(f"Model {model.__class__} does not have a hash key defined.")
 
+        hash_key_fields = hash_key_fields.pk_fields
         if len(hash_key_fields) == 0 and not model.is_nested():
             raise IncorrectHashKeyError(f"Model {model.__class__} does not have a hash key defined.")
 
@@ -598,6 +623,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
@@ -679,7 +724,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/expressions.py

@@ -597,7 +597,7 @@ class UpdateExpressionBuilder:
 
     def _safe_name(self, key):
         """Replace reserved words with a safe placeholder."""
-        if key.upper() in RESERVED_WORDS:
+        if key.upper() in RESERVED_WORDS or key.startswith("_"):
             safe_key = self.safe_name(key)
             self.expression_attribute_names[safe_key] = key
             return safe_key

statikk/models.py

@@ -163,6 +163,20 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     _parent: Optional[DatabaseModel] = None
     _model_types_in_hierarchy: dict[str, Type[DatabaseModel]] = {}
     _should_delete: bool = False
+    _parent_changed: bool = False
+
+    def is_parent_changed(self):
+        """
+        Recursively check if this node or any of its ancestors has been marked as having changed parents.
+        Returns True if the node or any ancestor has _parent_changed=True, otherwise False.
+        """
+        if self._parent_changed:
+            return True
+
+        if self._parent is not None:
+            return self._parent.is_parent_changed()
+
+        return False
 
     @classmethod
     def type(cls) -> str:
@@ -188,6 +202,21 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def is_simple_object(self) -> bool:
         return len(self._model_types_in_hierarchy) == 1
 
+    @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
+
     @classmethod
     def query(
         cls: Type[T],
@@ -260,6 +289,9 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def mark_for_delete(self):
         self._should_delete = True
 
+    def change_parent_to(self, new_parent: DatabaseModel) -> T:
+        return self._table.reparent_subtree(self, new_parent)
+
     @classmethod
     def scan(
         cls,
@@ -280,7 +312,7 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def initialize_tracking(self):
         self._model_types_in_hierarchy[self.type()] = type(self)
         if not self.is_nested():
-            self._set_parent_references(self)
+            self.set_parent_references(self)
         self.init_tracking()
 
         return self
@@ -370,27 +402,58 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def get_type_from_hierarchy_by_name(self, name: str) -> Optional[Type[DatabaseModel]]:
         return self._model_types_in_hierarchy.get(name)
 
-    def _set_parent_to_field(self, field: DatabaseModel, parent: DatabaseModel, root: DatabaseModel):
-        if field._parent:
+    def _set_parent_to_field(
+        self, field: DatabaseModel, parent: DatabaseModel, root: DatabaseModel, force_override: bool = False
+    ):
+        if field._parent and not force_override:
             return  # Already set
         field._parent = parent
         root._model_types_in_hierarchy[field.type()] = type(field)
-        field._set_parent_references(root)
+        field.set_parent_references(root, force_override)
         field.init_tracking()
 
-    def _set_parent_references(self, root: DatabaseModel):
+    def set_parent_references(self, root: DatabaseModel, force_override: bool = False):
+        """
+        Sets parent references for all DatabaseModel objects in the hierarchy.
+        """
+        for parent, field_name, model in self.traverse_hierarchy():
+            self._set_parent_to_field(model, parent, root, force_override)
+
+    def traverse_hierarchy(self):
+        """
+        Traverses the object and yields tuples of (parent, field_name, field_value) for each DatabaseModel found.
+        """
         for field_name, field_value in self:
             if isinstance(field_value, DatabaseModel):
-                self._set_parent_to_field(field_value, self, root)
-            elif isinstance(field_value, list):
+                yield self, field_name, field_value
+            elif isinstance(field_value, (list, set)):
                 for item in field_value:
                     if isinstance(item, DatabaseModel):
-                        self._set_parent_to_field(item, self, root)
-            elif isinstance(field_value, set):
+                        yield self, field_name, item
+            elif isinstance(field_value, dict):
+                for key, value in field_value.items():
+                    if isinstance(value, DatabaseModel):
+                        yield self, key, value
+
+    def dfs_traverse_hierarchy(self):
+        """
+        Performs a depth-first traversal of the entire object hierarchy,
+        yielding each DatabaseModel in order from root to leaves.
+        """
+        yield self
+
+        fields = []
+        for field_name, field_value in self:
+            fields.append((field_name, field_value))
+
+        for field_name, field_value in fields:
+            if isinstance(field_value, DatabaseModel):
+                yield from field_value.dfs_traverse_hierarchy()
+            elif isinstance(field_value, (list, set)):
                 for item in field_value:
                     if isinstance(item, DatabaseModel):
-                        self._set_parent_to_field(item, self, root)
+                        yield from item.dfs_traverse_hierarchy()
             elif isinstance(field_value, dict):
                 for key, value in field_value.items():
                     if isinstance(value, DatabaseModel):
-                        self._set_parent_to_field(value, self, root)
+                        yield from value.dfs_traverse_hierarchy()

{statikk-0.1.7.dist-info → statikk-0.1.9.dist-info}/METADATA

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

statikk-0.1.9.dist-info/RECORD

@@ -0,0 +1,12 @@
+statikk/__init__.py,sha256=pH5i4Fj1tbXLqLtTVIdoojiplZssQn0nnud8-HXodRE,577
+statikk/conditions.py,sha256=63FYMR-UUaE-ZJEb_8CU721CQTwhajq39-BbokmKeMA,2166
+statikk/engine.py,sha256=0jF5pUZJtr_lBZMEZXd7PGDerr26CLZUh91gy15Leac,33252
+statikk/expressions.py,sha256=boAeGxZj2cDsXxoiX3IIEzfX9voSMQngi4-rE_jYeuE,12233
+statikk/fields.py,sha256=LkMP5NnX7WS0HSLxI3Q-dMOrfaJ0SD7SayZxJU5Acgg,86
+statikk/models.py,sha256=gzy_MV3LVsVlorqHencXyS7HCVV2QQ698aWK5bQIdFk,16115
+statikk/typing.py,sha256=qfpegORcdODuILK3gvuD4SdcZA1a7Myn0yvscOLPHOM,68
+statikk-0.1.9.dist-info/LICENSE.txt,sha256=uSH_2Hpb2Bigy5_HhBliN2fZbBU64G3ERM5zzhKPUEE,1078
+statikk-0.1.9.dist-info/METADATA,sha256=ZvTT-xMgID_v5WgHYz13E_JLHtqflVz9naDu9Qh-9rA,3160
+statikk-0.1.9.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+statikk-0.1.9.dist-info/top_level.txt,sha256=etKmBbjzIlLpSefXoiOfhWGEgvqUEALaFwCjFDBD9YI,8
+statikk-0.1.9.dist-info/RECORD,,

statikk-0.1.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-statikk/__init__.py,sha256=pH5i4Fj1tbXLqLtTVIdoojiplZssQn0nnud8-HXodRE,577
-statikk/conditions.py,sha256=63FYMR-UUaE-ZJEb_8CU721CQTwhajq39-BbokmKeMA,2166
-statikk/engine.py,sha256=_iUJYyKNypqQeg6f4MC45XWhOrwsYRsI8FZe0Hs3fDA,31067
-statikk/expressions.py,sha256=mF6Hmj3Kmj6KKXTymeTHSepVA7rhiSINpFgSAPeBTRY,12210
-statikk/fields.py,sha256=LkMP5NnX7WS0HSLxI3Q-dMOrfaJ0SD7SayZxJU5Acgg,86
-statikk/models.py,sha256=uGCfpmoagz98BlTWiyj8NFvd7PTcsj1XV2edTumxAqY,13862
-statikk/typing.py,sha256=qfpegORcdODuILK3gvuD4SdcZA1a7Myn0yvscOLPHOM,68
-statikk-0.1.7.dist-info/LICENSE.txt,sha256=uSH_2Hpb2Bigy5_HhBliN2fZbBU64G3ERM5zzhKPUEE,1078
-statikk-0.1.7.dist-info/METADATA,sha256=YiDH3MeMZuJypLtkjGb-prE-Aqe15kbKBDT9cAyBRmM,3160
-statikk-0.1.7.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-statikk-0.1.7.dist-info/top_level.txt,sha256=etKmBbjzIlLpSefXoiOfhWGEgvqUEALaFwCjFDBD9YI,8
-statikk-0.1.7.dist-info/RECORD,,