statikk 0.1.12__tar.gz → 0.1.13__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statikk
-Version: 0.1.12
+Version: 0.1.13
 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.13}/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 (
@@ -627,26 +627,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 +708,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.13}/src/statikk/models.py

@@ -4,7 +4,7 @@ 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
@@ -296,6 +296,37 @@ 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 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__}")
+
+        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
+
+        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)
+            return 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)
+            return reparented
+
+        elif issubclass(field_type, DatabaseModel):
+            reparented = child_node.change_parent_to(self)
+            setattr(self, field_name, reparented)
+            return reparented
+
+        raise ValueError(f"Unsupported field type: {field_type}")
+
     @classmethod
     def scan(
         cls,

statikk-0.1.13/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.13}/src/statikk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: statikk
-Version: 0.1.12
+Version: 0.1.13
 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.13}/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,56 @@ 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])}
+
+    _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

{statikk-0.1.12 → statikk-0.1.13}/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")