statikk 0.1.12__tar.gz → 0.1.14__tar.gz

{statikk-0.1.12 → statikk-0.1.14}/PKG-INFO

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

{statikk-0.1.12 → statikk-0.1.14}/src/statikk/engine.py

@@ -1,14 +1,14 @@
 import os
 from datetime import datetime
-from typing import Any, Dict, Type, Optional, List, Union, get_type_hints, get_origin, get_args
+from typing import Any, Dict, Type, Optional, List, Union
 
 import boto3
 from botocore.config import Config
 from pydantic.fields import FieldInfo
-from boto3.dynamodb.conditions import ComparisonCondition, Key
+from boto3.dynamodb.conditions import ComparisonCondition
 from boto3.dynamodb.types import TypeDeserializer, Decimal
 
-from statikk.typing import T
+from statikk.typing import T, inspect_optional_field
 from statikk.conditions import Condition, Equals, BeginsWith
 from statikk.expressions import UpdateExpressionBuilder
 from statikk.models import (
@@ -246,6 +246,8 @@ class Table:
                 else:
                     batch.put(item)
 
+        model._session.reset()
+
     def update_item(
         self,
         hash_key: str,
@@ -627,26 +629,6 @@ class Table:
                     data = self._serialize_item(enriched_item)
                     batch.put_item(Item=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
@@ -728,7 +710,7 @@ class Table:
                 if field_name.startswith("_"):
                     continue
 
-                is_optional, inner_type = self.inspect_optional_field(parent_model_class, field_name)
+                is_optional, inner_type = inspect_optional_field(parent_model_class, field_name)
 
                 field_type = inner_type if is_optional else field_info.annotation
 

{statikk-0.1.12 → statikk-0.1.14}/src/statikk/models.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
+from datetime import datetime
 import typing
 import logging
 from uuid import uuid4
 from typing import Optional, List, Any, Set, Type
-from statikk.typing import T
+from statikk.typing import T, inspect_optional_field
 
 from boto3.dynamodb.conditions import ComparisonCondition
 from pydantic import BaseModel, model_serializer, model_validator, Field, Extra
@@ -53,6 +54,43 @@ class IndexFieldConfig(BaseModel):
     sk_fields: list[str] = []
 
 
+class TreeStructureChange(BaseModel):
+    new_parent: Optional[Any]
+    new_parent_field_name: Optional[str]
+    subtree: Any
+    timestamp: datetime = Field(default_factory=datetime.now)
+
+
+class Session(BaseModel):
+    _changes: list[TreeStructureChange] = []
+
+    def add_change(self, new_parent: Optional[T], new_parent_field_name: Optional[str], subtree: T):
+        self._changes.append(
+            TreeStructureChange(new_parent=new_parent, new_parent_field_name=new_parent_field_name, subtree=subtree)
+        )
+
+    def get_subtree_changes_by_parent_id(
+        self, parent_id: str, subtree_id: str, field_name: str
+    ) -> Optional[TreeStructureChange]:
+        sorted_changes = sorted(self._changes, key=lambda change: change.timestamp, reverse=True)
+        return next(
+            filter(
+                lambda change: change.new_parent.id == parent_id
+                and change.subtree.id == subtree_id
+                and change.new_parent_field_name == field_name,
+                sorted_changes,
+            ),
+            None,
+        )
+
+    def get_last_change_for(self, subtree_id):
+        sorted_changes = sorted(self._changes, key=lambda change: change.timestamp, reverse=True)
+        return next(filter(lambda change: change.subtree.id == subtree_id, sorted_changes), None)
+
+    def reset(self):
+        self._changes = []
+
+
 class TrackingMixin:
     _original_hash: int = Field(exclude=True)
 
@@ -164,6 +202,10 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     _model_types_in_hierarchy: dict[str, Type[DatabaseModel]] = {}
     _should_delete: bool = False
     _parent_changed: bool = False
+    _session = Session()
+
+    def __eq__(self, other):
+        return self.id == other.id
 
     def is_parent_changed(self):
         """
@@ -182,6 +224,17 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def type(cls) -> str:
         return cls.__name__
 
+    @property
+    def should_track_session(self) -> bool:
+        """
+        If set to True, subtree movements across the database model will be tracked in a session.
+        Use this if you need to move a subtree across multiple parent-child relationships within a single session.
+        Session is reset after each save.
+        """
+        if self._parent is not None:
+            return self._parent.should_track_session
+        return False
+
     @classmethod
     def index_definitions(cls) -> dict[str, IndexFieldConfig]:
         return {"main_index": IndexFieldConfig(pk_fields=[], sk_fields=[])}
@@ -296,6 +349,61 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
     def change_parent_to(self, new_parent: DatabaseModel) -> T:
         return self._table.reparent_subtree(self, new_parent)
 
+    def _remove_from_parent(self, parent, field_name, subtree):
+        is_optional, inner_type = inspect_optional_field(parent.__class__, field_name)
+        field_type = inner_type if is_optional else parent.model_fields[field_name].annotation
+        field = getattr(self, field_name)
+        if hasattr(field_type, "__origin__") and field_type.__origin__ == list:
+            if not isinstance(field, list):
+                setattr(self, field_name, [])
+            field.remove(next(filter(lambda item: item.id == subtree.id, getattr(parent, field_name)), None))
+
+        elif hasattr(field_type, "__origin__") and field_type.__origin__ == set:
+            if not isinstance(field, set):
+                setattr(self, field_name, set())
+            field.remove(next(filter(lambda item: item.id == subtree.id, getattr(parent, field_name)), None))
+
+        elif issubclass(field_type, DatabaseModel):
+            setattr(parent, field_name, None)
+
+    def add_child_node(self, field_name: str, child_node: DatabaseModel):
+        if not child_node.is_nested():
+            raise ValueError("Child node must be nested.")
+
+        if not hasattr(self, field_name):
+            raise ValueError(f"Field {field_name} does not exist on {self.__class__.__name__}")
+
+        if self.should_track_session:
+            previous_change = self._session.get_subtree_changes_by_parent_id(self.id, child_node.id, field_name)
+            if previous_change:
+                self._remove_from_parent(previous_change.new_parent, previous_change.new_parent_field_name, child_node)
+
+        is_optional, inner_type = inspect_optional_field(self.__class__, field_name)
+        field_type = inner_type if is_optional else self.model_fields[field_name].annotation
+        reparented = None
+        if hasattr(field_type, "__origin__") and field_type.__origin__ == list:
+            if not isinstance(getattr(self, field_name), list):
+                setattr(self, field_name, [])
+            reparented = child_node.change_parent_to(self)
+            getattr(self, field_name).append(reparented)
+
+        elif hasattr(field_type, "__origin__") and field_type.__origin__ == set:
+            if not isinstance(getattr(self, field_name), set):
+                setattr(self, field_name, set())
+            reparented = child_node.change_parent_to(self)
+            getattr(self, field_name).add(reparented)
+
+        elif issubclass(field_type, DatabaseModel):
+            reparented = child_node.change_parent_to(self)
+            setattr(self, field_name, reparented)
+
+        if reparented:
+            if self.should_track_session:
+                self._session.add_change(self, field_name, reparented)
+            return reparented
+
+        raise ValueError(f"Unsupported field type: {field_type}")
+
     @classmethod
     def scan(
         cls,
@@ -340,9 +448,7 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
             if self not in items:
                 items.append(self)
 
-        # Iterate through all fields of the model
         for field_name, field_value in self:
-            # Skip fields that start with underscore (private fields)
             if field_name.startswith("_"):
                 continue
 
@@ -352,7 +458,6 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
                     items.append(field_value)
                 field_value.split_to_simple_objects(items)
 
-            # Handle lists containing DatabaseModel instances
             elif isinstance(field_value, list):
                 for item in field_value:
                     if hasattr(item, "__class__") and issubclass(item.__class__, DatabaseModel):
@@ -360,7 +465,6 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
                             items.append(item)
                         item.split_to_simple_objects(items)
 
-            # Handle sets containing DatabaseModel instances
             elif isinstance(field_value, set):
                 for item in field_value:
                     if hasattr(item, "__class__") and issubclass(item.__class__, DatabaseModel):
@@ -368,15 +472,6 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
                             items.append(item)
                         item.split_to_simple_objects(items)
 
-            # Handle dictionaries that may contain DatabaseModel instances
-            elif isinstance(field_value, dict):
-                # Check dictionary values
-                for value in field_value.values():
-                    if hasattr(value, "__class__") and issubclass(value.__class__, DatabaseModel):
-                        if value not in items:
-                            items.append(value)
-                        value.split_to_simple_objects(items)
-
         return items
 
     def get_attribute(self, attribute_name: str):
@@ -407,11 +502,18 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
         return self._model_types_in_hierarchy.get(name)
 
     def _set_parent_to_field(
-        self, field: DatabaseModel, parent: DatabaseModel, root: DatabaseModel, force_override: bool = False
+        self,
+        field: DatabaseModel,
+        field_name: str,
+        parent: DatabaseModel,
+        root: DatabaseModel,
+        force_override: bool = False,
     ):
         if field._parent and not force_override:
             return  # Already set
         field._parent = parent
+        if field.should_track_session:
+            field._session.add_change(parent, field_name, field)
         root._model_types_in_hierarchy[field.type()] = type(field)
         field.set_parent_references(root, force_override)
         field.init_tracking()
@@ -421,7 +523,7 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
         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)
+            self._set_parent_to_field(model, field_name, parent, root, force_override)
 
     def traverse_hierarchy(self):
         """

statikk-0.1.14/src/statikk/typing.py

@@ -0,0 +1,24 @@
+from typing import TypeVar, get_origin, Union, get_args
+
+T = TypeVar("T", bound="DatabaseModel")
+
+
+def inspect_optional_field(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)

{statikk-0.1.12 → statikk-0.1.14}/src/statikk.egg-info/PKG-INFO

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

{statikk-0.1.12 → statikk-0.1.14}/tests/test_engine.py

@@ -1,6 +1,6 @@
 from _decimal import Decimal
 from datetime import datetime, timezone
-from typing import List, Optional
+from typing import List, Optional, Type
 
 import pytest
 from boto3.dynamodb.conditions import Attr
@@ -24,6 +24,23 @@ from statikk.models import (
 )
 
 
+def _create_default_dynamodb_table(models: list[Type[DatabaseModel]]):
+    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=models,
+    )
+    _create_dynamodb_table(table)
+
+
 class MyAwesomeModel(DatabaseModel):
     player_id: str
     tier: str
@@ -980,3 +997,74 @@ def test_rebuild_model_indexes():
     my_database_model.build_model_indexes()
     assert my_database_model.gsi_pk == "foo"
     assert my_database_model.gsi_sk == "MyDatabaseModel|bar"
+
+
+def test_add_child_node():
+    class MyOtherNestedDatabaseModel(DatabaseModel):
+        baz: str
+
+        @classmethod
+        def is_nested(cls) -> bool:
+            return True
+
+        @classmethod
+        def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+            return {"main-index": IndexFieldConfig(sk_fields=["baz"])}
+
+        __hash__ = object.__hash__
+
+    class MyNestedDatabaseModel(DatabaseModel):
+        bar: str
+        other_nested: Optional[MyOtherNestedDatabaseModel] = None
+        list_nested: list[MyOtherNestedDatabaseModel] = []
+        set_nested: set[MyOtherNestedDatabaseModel] = {}
+
+        @classmethod
+        def is_nested(cls) -> bool:
+            return True
+
+        @classmethod
+        def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+            return {"main-index": IndexFieldConfig(sk_fields=["bar"])}
+
+    class MyDatabaseModel(DatabaseModel):
+        foo: str
+        nested: MyNestedDatabaseModel
+
+        @classmethod
+        def index_definitions(cls) -> dict[str, IndexFieldConfig]:
+            return {"main-index": IndexFieldConfig(pk_fields=["foo"], sk_fields=[FIELD_STATIKK_TYPE])}
+
+        @property
+        def should_track_session(self) -> bool:
+            return True
+
+    _create_default_dynamodb_table([MyDatabaseModel, MyNestedDatabaseModel, MyOtherNestedDatabaseModel])
+    my_database_model = MyDatabaseModel(foo="foo", nested=MyNestedDatabaseModel(bar="bar"))
+    my_database_model.build_model_indexes()
+    my_database_model.nested.add_child_node("other_nested", MyOtherNestedDatabaseModel(baz="baz"))
+    my_database_model.nested.add_child_node("list_nested", MyOtherNestedDatabaseModel(baz="bazz"))
+    my_database_model.nested.add_child_node("set_nested", MyOtherNestedDatabaseModel(baz="bazzz"))
+    assert my_database_model.nested.other_nested.baz == "baz"
+    assert my_database_model.nested.list_nested[0].baz == "bazz"
+    set_nested_item = my_database_model.nested.set_nested.pop()
+    assert set_nested_item.baz == "bazzz"
+    assert set_nested_item._parent == my_database_model.nested
+    assert set_nested_item.gsi_pk == set_nested_item._parent.gsi_pk
+    assert set_nested_item.gsi_sk == "MyDatabaseModel|MyNestedDatabaseModel|bar|MyOtherNestedDatabaseModel|bazzz"
+    assert my_database_model.nested.other_nested._parent == my_database_model.nested
+    assert my_database_model.nested.list_nested[0]._parent == my_database_model.nested
+    my_database_model.nested.add_child_node("set_nested", my_database_model.nested.list_nested[0])
+    assert my_database_model.nested.list_nested[0]._parent_changed is True
+    set_nested_new = my_database_model.nested.set_nested.pop()
+    assert set_nested_new._parent_changed is False
+    assert set_nested_new.gsi_sk == "MyDatabaseModel|MyNestedDatabaseModel|bar|MyOtherNestedDatabaseModel|bazz"
+    my_database_model.nested.add_child_node("list_nested", set_nested_new)
+    assert my_database_model.nested.list_nested[0]._parent_changed is False
+    assert my_database_model.nested.list_nested[0]._parent == my_database_model.nested
+    assert my_database_model.nested.list_nested[0].gsi_pk == "foo"
+    assert (
+        my_database_model.nested.list_nested[0].gsi_sk
+        == "MyDatabaseModel|MyNestedDatabaseModel|bar|MyOtherNestedDatabaseModel|bazz"
+    )
+    assert set_nested_new._parent_changed is True

{statikk-0.1.12 → statikk-0.1.14}/tests/test_models.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from pydantic import BaseModel
 from statikk.models import DatabaseModel, IndexFieldConfig
 

statikk-0.1.12/src/statikk/typing.py

@@ -1,3 +0,0 @@
-from typing import TypeVar
-
-T = TypeVar("T", bound="DatabaseModel")