statikk 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

statikk/engine.py

@@ -8,6 +8,7 @@ from pydantic.fields import FieldInfo
 from boto3.dynamodb.conditions import ComparisonCondition, Key
 from boto3.dynamodb.types import TypeDeserializer, Decimal
 
+from statikk.typing import T
 from statikk.conditions import Condition, Equals, BeginsWith
 from statikk.expressions import UpdateExpressionBuilder
 from statikk.models import (
@@ -170,10 +171,10 @@ class Table:
     def get_item(
         self,
         id: str,
-        model_class: Type[DatabaseModel],
+        model_class: Type[T],
         sort_key: Optional[Any] = None,
         consistent_read: bool = False,
-    ):
+    ) -> T:
         """
         Returns an item from the database by id, using the partition key of the table.
         :param id: The id of the item to retrieve.
@@ -331,11 +332,11 @@ class Table:
     def query_index(
         self,
         hash_key: Union[Condition | str],
-        model_class: Type[DatabaseModel],
+        model_class: Type[T],
         range_key: Optional[Condition] = None,
         filter_condition: Optional[ComparisonCondition] = None,
         index_name: Optional[str] = None,
-    ):
+    ) -> list[T]:
         """
         Queries the database using the provided hash key and range key conditions. A filter condition can also be provided
         using the filter_condition parameter. The method returns a list of items matching the query, deserialized into the
@@ -397,7 +398,7 @@ class Table:
         self,
         filter_condition: Optional[ComparisonCondition] = None,
         consistent_read: bool = False,
-    ):
+    ) -> list[DatabaseModel]:
         """
         Scans the database for items matching the provided filter condition. The method returns a list of items matching
         the query, deserialized into the provided model_class parameter.
@@ -421,9 +422,7 @@ class Table:
         deserializer = TypeDeserializer()
         return {k: deserializer.deserialize(v) for k, v in item.items()}
 
-    def batch_get_items(
-        self, ids: List[str], model_class: Type[DatabaseModel], batch_size: int = 100
-    ) -> List[DatabaseModel]:
+    def batch_get_items(self, ids: List[str], model_class: Type[T], batch_size: int = 100) -> list[T]:
         dynamodb = self._dynamodb_client()
 
         id_batches = [ids[i : i + batch_size] for i in range(0, len(ids), batch_size)]

statikk/models.py

@@ -4,6 +4,7 @@ import typing
 import logging
 from uuid import uuid4
 from typing import Optional, List, Any, Set, Type
+from statikk.typing import T
 
 from boto3.dynamodb.conditions import ComparisonCondition
 from pydantic import BaseModel, model_serializer, model_validator, Field, Extra
@@ -55,6 +56,10 @@ class IndexFieldConfig(BaseModel):
 class TrackingMixin:
     _original_hash: int = Field(exclude=True)
 
+    @classmethod
+    def should_track(cls) -> bool:
+        return True
+
     def __init__(self):
         self._original_hash = self._recursive_hash()
 
@@ -126,7 +131,10 @@ class TrackingMixin:
 
     @property
     def was_modified(self) -> bool:
-        return self._recursive_hash() != self._original_hash
+        if self.should_track():
+            return self._recursive_hash() != self._original_hash
+
+        return True
 
 
 class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
@@ -160,12 +168,12 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
 
     @classmethod
     def query(
-        cls,
+        cls: Type[T],
         hash_key: Condition,
         range_key: Optional[Condition] = None,
         filter_condition: Optional[ComparisonCondition] = None,
         index_name: Optional[str] = None,
-    ):
+    ) -> T:
         return cls._table.query_index(
             hash_key=hash_key,
             model_class=cls,
@@ -176,12 +184,12 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
 
     @classmethod
     def query_hierarchy(
-        cls,
+        cls: Type[T],
         hash_key: Union[Condition | str],
         range_key: Optional[Condition] = None,
         filter_condition: Optional[ComparisonCondition] = None,
         index_name: Optional[str] = None,
-    ) -> DatabaseModel:
+    ) -> T:
         return cls._table.query_hierarchy(
             hash_key=hash_key,
             model_class=cls,
@@ -215,11 +223,11 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
         )
 
     @classmethod
-    def get(cls, id: str, sort_key: Optional[str] = None, consistent_read: bool = False):
+    def get(cls: Type[T], id: str, sort_key: Optional[str] = None, consistent_read: bool = False) -> T:
         return cls._table.get_item(id=id, model_class=cls, sort_key=sort_key, consistent_read=consistent_read)
 
     @classmethod
-    def batch_get(cls, ids: List[str], batch_size: int = 100):
+    def batch_get(cls: Type[T], ids: List[str], batch_size: int = 100) -> list[T]:
         return cls._table.batch_get_items(ids=ids, model_class=cls, batch_size=batch_size)
 
     def should_write_to_database(self) -> bool:
@@ -232,7 +240,7 @@ class DatabaseModel(BaseModel, TrackingMixin, extra=Extra.allow):
         cls,
         filter_condition: Optional[ComparisonCondition] = None,
         consistent_read: bool = False,
-    ):
+    ) -> list[DatabaseModel]:
         return cls._table.scan(filter_condition=filter_condition)
 
     @model_serializer(mode="wrap")

statikk/typing.py

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

{statikk-0.1.1.dist-info → statikk-0.1.2.dist-info}/METADATA

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

statikk-0.1.2.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=hMA6V_aneWpJlCa4mogu6rE3-T7qwFuRGAkK-0nREj8,30884
+statikk/expressions.py,sha256=mF6Hmj3Kmj6KKXTymeTHSepVA7rhiSINpFgSAPeBTRY,12210
+statikk/fields.py,sha256=LkMP5NnX7WS0HSLxI3Q-dMOrfaJ0SD7SayZxJU5Acgg,86
+statikk/models.py,sha256=rekTKPnN-I3oBOTzqkAy4FmSnaXI-woQNyG3rG85en8,13155
+statikk/typing.py,sha256=qfpegORcdODuILK3gvuD4SdcZA1a7Myn0yvscOLPHOM,68
+statikk-0.1.2.dist-info/LICENSE.txt,sha256=uSH_2Hpb2Bigy5_HhBliN2fZbBU64G3ERM5zzhKPUEE,1078
+statikk-0.1.2.dist-info/METADATA,sha256=7IOtn9UQIVO-Iy0jJKooQrtzbtSJRq90Q_Z0wKg05-Y,3160
+statikk-0.1.2.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+statikk-0.1.2.dist-info/top_level.txt,sha256=etKmBbjzIlLpSefXoiOfhWGEgvqUEALaFwCjFDBD9YI,8
+statikk-0.1.2.dist-info/RECORD,,

statikk-0.1.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-statikk/__init__.py,sha256=pH5i4Fj1tbXLqLtTVIdoojiplZssQn0nnud8-HXodRE,577
-statikk/conditions.py,sha256=63FYMR-UUaE-ZJEb_8CU721CQTwhajq39-BbokmKeMA,2166
-statikk/engine.py,sha256=ny15q1yLEJYTszxCaHxqdm7GRC3xsCZBtjPfNGHn0Dk,30878
-statikk/expressions.py,sha256=mF6Hmj3Kmj6KKXTymeTHSepVA7rhiSINpFgSAPeBTRY,12210
-statikk/fields.py,sha256=LkMP5NnX7WS0HSLxI3Q-dMOrfaJ0SD7SayZxJU5Acgg,86
-statikk/models.py,sha256=6ssCECKFCHZwN_-LA-epHhqtVNJK0pt6PlIVj9UxKUI,12928
-statikk-0.1.1.dist-info/LICENSE.txt,sha256=uSH_2Hpb2Bigy5_HhBliN2fZbBU64G3ERM5zzhKPUEE,1078
-statikk-0.1.1.dist-info/METADATA,sha256=bfSuQ9QD8mDp_9CdmlgApWp0h-rlAhCsgO-ChPETOkQ,3160
-statikk-0.1.1.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-statikk-0.1.1.dist-info/top_level.txt,sha256=etKmBbjzIlLpSefXoiOfhWGEgvqUEALaFwCjFDBD9YI,8
-statikk-0.1.1.dist-info/RECORD,,