feat: add soft deletion mixin for model handling

Generated-by: aiautocommit

activemodel/base_model.py

@@ -8,7 +8,7 @@
 import sqlmodel as sm
 from sqlalchemy import Connection, event
 from sqlalchemy.orm import Mapper, declared_attr
-from sqlmodel import Session, SQLModel, select
+from sqlmodel import Field, Session, SQLModel, select
 
 from .logger import logger
 from .query_wrapper import QueryWrapper
@@ -123,6 +123,19 @@ def __tablename__(cls) -> str:
         """
         return pydash.strings.snake_case(cls.__name__)
 
+    @classmethod
+    def foreign_key(cls):
+        """
+        Returns a Field object referencing the foreign key of the model.
+        """
+
+        return Field(
+            # TODO id field is hard coded
+            sa_type=cls.model_fields["id"].sa_column.type,  # type: ignore
+            foreign_key=f"{cls.__tablename__}.id",
+            nullable=False,
+        )
+
     @classmethod
     def select(cls, *args):
         return QueryWrapper[cls](cls, *args)

activemodel/mixins/__init__.py

@@ -1,2 +1,3 @@
+from .soft_delete import SoftDeletionMixin
 from .timestamps import TimestampsMixin
 from .typeid import TypeIDMixin

activemodel/mixins/soft_delete.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+
+import sqlalchemy as sa
+from sqlmodel import Field
+
+
+class SoftDeletionMixin:
+    deleted_at: datetime = Field(
+        default=None,
+        nullable=True,
+        # TODO https://github.com/fastapi/sqlmodel/discussions/1228
+        sa_type=sa.DateTime(timezone=True),  # type: ignore
+    )
+
+    def soft_delete(self):
+        self.deleted_at = datetime.now()
+        raise NotImplementedError("Soft deletion is not implemented")