SARepo 0.1.4__tar.gz → 0.1.6__tar.gz

{sarepo-0.1.4 → sarepo-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SARepo
-Version: 0.1.4
+Version: 0.1.6
 Summary: Minimal, explicit Repository & Unit-of-Work layer over SQLAlchemy 2.x
 Author: nurbergenovv
 License: MIT

sarepo-0.1.6/SARepo/repo.py

@@ -0,0 +1,50 @@
+
+from typing import Generic, List, TypeVar, Type, Optional, Any, Protocol
+
+from SARepo.sa_repo import Spec
+from .base import Page, PageRequest
+
+T = TypeVar("T")
+
+class CrudRepository(Protocol, Generic[T]):
+    model: Type[T]
+    def getAll(self, limit: Optional[int] = None, *, include_deleted: bool = False) -> List[T]: ...
+    def get(self, id_: Any, *, include_deleted: bool = False) -> T: ...
+    def try_get(self, id_: Any, *, include_deleted: bool = False) -> Optional[T]: ...
+    def add(self, entity: T) -> T: ...
+    def update(self, entity: T) -> T: ...
+    def remove(self, entity: Optional[T] = None, id: Optional[Any] = None) -> bool: ...
+    def delete_by_id(self, id_: Any) -> bool: ...
+    def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None, *, include_deleted: bool = False) -> Page[T]: ...
+    def get_all_by_column(
+    self,
+    column_name: str,
+    value: Any,
+    *,
+    limit: Optional[int] = None,
+    order_by=None,
+    include_deleted: bool = False,
+    **extra_filters
+) -> list[T]: ...
+    def find_all_by_column(
+    self,
+    column_name: str,
+    value: Any,
+    *,
+    limit: Optional[int] = None,
+    order_by=None,
+    include_deleted: bool = False,
+    **extra_filters
+) -> list[T]: ...
+    def get_or_create(
+        self,
+        defaults: Optional[dict] = None,
+        **unique_filters
+    ) -> tuple[T, bool]: ...
+    def raw_query(self, sql: str, params: Optional[dict] = None) -> list[dict]: ...
+    def aggregate_avg(self, column_name: str, **filters) -> Optional[float]: ...
+    def aggregate_min(self, column_name: str, **filters): ...
+    def aggregate_max(self, column_name: str, **filters): ...
+    def aggregate_sum(self, column_name: str, **filters): ... 
+    def count(self, **filters) -> int: ...
+    def restore(self, id_: Any) -> bool: ...

{sarepo-0.1.4 → sarepo-0.1.6}/SARepo/sa_repo.py

@@ -28,22 +28,38 @@ class SARepository(Generic[T]):
     def _select(self):
         return select(self.model)
 
-    def getAll(self, limit: Optional[int] = None) -> List[T]:
+    def _has_soft_delete(self) -> bool:
+        return hasattr(self.model, "is_deleted")
+
+    def _apply_alive_filter(self, stmt, include_deleted: bool) :
+        if self._has_soft_delete() and not include_deleted:
+            stmt = stmt.where(self.model.is_deleted == False)  # noqa: E712
+        return stmt
+    
+    def getAll(self, limit: Optional[int] = None, *, include_deleted: bool = False) -> List[T]:
         stmt = select(self.model)
+        stmt = self._apply_alive_filter(stmt, include_deleted)
         if limit is not None:
             stmt = stmt.limit(limit)
         result = self.session.execute(stmt)
-        return result.scalars().all()
+        return result.scalars().all()    
     
-    def get(self, id_: Any) -> T:
+    def get(self, id_: Any, *, include_deleted: bool = False) -> T:
         obj = self.session.get(self.model, id_)
         if not obj:
             raise NotFoundError(f"{self.model.__name__}({id_}) not found")
+        if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
+            raise NotFoundError(f"{self.model.__name__}({id_}) not found")  # скрываем как «нет»
         return obj
 
-    def try_get(self, id_: Any) -> Optional[T]:
-        return self.session.get(self.model, id_)
-
+    def try_get(self, id_: Any, *, include_deleted: bool = False) -> Optional[T]:
+        obj = self.session.get(self.model, id_)
+        if not obj:
+            return None
+        if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
+            return None
+        return obj
+    
     def add(self, entity: T) -> T:
         self.session.add(entity)
         self.session.flush()
@@ -55,7 +71,13 @@ class SARepository(Generic[T]):
         self.session.refresh(entity)
         return entity
 
-    def remove(self, entity: T) -> None:
+    def remove(self, entity: Optional[T] = None, id: Optional[Any] = None) -> bool:
+        if entity is None and id is None:
+            raise ValueError("remove() requires either entity or id")
+    
+        if id is not None:
+            return self._delete_by_id(id)
+        
         insp = inspect(entity, raiseerr=False)
         if not (insp and (insp.persistent or insp.pending)):
             pk = getattr(entity, "id", None)
@@ -63,30 +85,35 @@ class SARepository(Generic[T]):
                 raise ValueError("remove() needs a persistent entity or an entity with a primary key set")
             entity = self.session.get(self.model, pk)
             if entity is None:
-                return
+                return False
         if hasattr(entity, "is_deleted"):
             setattr(entity, "is_deleted", True)
         else:
             self.session.delete(entity)
+            
+        return True
 
-    def delete_by_id(self, id_: Any) -> bool:
+    def _delete_by_id(self, id_: Any) -> bool:
         obj = self.session.get(self.model, id_)
         if not obj:
             return False
         self.remove(obj)
         return True
 
-    def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None) -> Page[T]:
-        stmt = self._select()
+    def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None, *, include_deleted: bool = False) -> Page[T]:
+        base = self._select()
         if spec:
-            stmt = spec(stmt)
+            base = spec(base)
+        base = self._apply_alive_filter(base, include_deleted)
         if order_by is not None:
-            stmt = stmt.order_by(order_by)
+            base = base.order_by(order_by)
+
         total = self.session.execute(
-            select(func.count()).select_from(stmt.subquery())
+            select(func.count()).select_from(base.subquery())
         ).scalar_one()
+
         items = self.session.execute(
-            stmt.offset(page.page * page.size).limit(page.size)
+            base.offset(page.page * page.size).limit(page.size)
         ).scalars().all()
         return Page(items, total, page.page, page.size)
     
@@ -102,8 +129,7 @@ class SARepository(Generic[T]):
     ) -> list[T]:
         col = self._resolve_column(column_name)
         stmt = select(self.model).where(col == value)
-        if not include_deleted and hasattr(self.model, "is_deleted"):
-            stmt = stmt.where(self.model.is_deleted == False)  # noqa: E712
+        stmt = self._apply_alive_filter(stmt, include_deleted)
         stmt = self._apply_filters(stmt, **extra_filters)
         if order_by is not None:
             stmt = stmt.order_by(order_by)
@@ -111,7 +137,7 @@ class SARepository(Generic[T]):
             stmt = stmt.limit(limit)
         res = self.session.execute(stmt)
         return res.scalars().all()
-    
+        
     # Alias 
     def find_all_by_column(self, *args, **kwargs):
         return self.get_all_by_column(*args, **kwargs)
@@ -222,21 +248,37 @@ class SAAsyncRepository(Generic[T]):
     def _select(self):
         return select(self.model)
     
-    async def getAll(self, limit: Optional[int] = None) -> List[T]:
+    def _has_soft_delete(self) -> bool:
+        return hasattr(self.model, "is_deleted")
+
+    def _apply_alive_filter(self, stmt, include_deleted: bool) :
+        if self._has_soft_delete() and not include_deleted:
+            stmt = stmt.where(self.model.is_deleted == False)  # noqa: E712
+        return stmt
+
+    async def getAll(self, limit: Optional[int] = None, *, include_deleted: bool = False) -> List[T]:
         stmt = select(self.model)
+        stmt = self._apply_alive_filter(stmt, include_deleted)
         if limit is not None:
             stmt = stmt.limit(limit)
         result = await self.session.execute(stmt)
         return result.scalars().all()
 
-    async def get(self, id_: Any) -> T:
+    async def get(self, id_: Any, *, include_deleted: bool = False) -> T:
         obj = await self.session.get(self.model, id_)
         if not obj:
             raise NotFoundError(f"{self.model.__name__}({id_}) not found")
+        if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
+            raise NotFoundError(f"{self.model.__name__}({id_}) not found")
         return obj
 
-    async def try_get(self, id_: Any) -> Optional[T]:
-        return await self.session.get(self.model, id_)
+    async def try_get(self, id_: Any, *, include_deleted: bool = False) -> Optional[T]:
+        obj = await self.session.get(self.model, id_)
+        if not obj:
+            return None
+        if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
+            return None
+        return obj
 
     async def add(self, entity: T) -> T:
         self.session.add(entity)
@@ -249,7 +291,13 @@ class SAAsyncRepository(Generic[T]):
         await self.session.refresh(entity)
         return entity
 
-    async def remove(self, entity: T) -> None:
+    async def remove(self, entity: Optional[T] = None, id: Optional[Any] = None) -> bool:
+        if entity is None and id is None:
+            raise ValueError("remove() requires either entity or id")
+    
+        if id is not None:
+            return await self._delete_by_id(id)
+        
         insp = inspect(entity, raiseerr=False)
         if not (insp and (insp.persistent or insp.pending)):
             pk = getattr(entity, "id", None)
@@ -257,34 +305,40 @@ class SAAsyncRepository(Generic[T]):
                 raise ValueError("remove() needs a persistent entity or an entity with a primary key set")
             entity = await self.session.get(self.model, pk)
             if entity is None:
-                return
+                return False
         if hasattr(entity, "is_deleted"):
             setattr(entity, "is_deleted", True)
         else:
             await self.session.delete(entity)
+            
+        return True
 
-    async def delete_by_id(self, id_: Any) -> bool:
+    
+    async def _delete_by_id(self, id_: Any) -> bool:
         obj = await self.session.get(self.model, id_)
         if not obj:
             return False
         await self.remove(obj)
         return True
 
-    async def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None) -> Page[T]:
-        stmt = self._select()
+    async def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None, *, include_deleted: bool = False) -> Page[T]: # type: ignore
+        base = self._select()
         if spec:
-            stmt = spec(stmt)
+            base = spec(base)
+        base = self._apply_alive_filter(base, include_deleted)
         if order_by is not None:
-            stmt = stmt.order_by(order_by)
+            base = base.order_by(order_by)
+
         total = (await self.session.execute(
-            select(func.count()).select_from(stmt.subquery())
+            select(func.count()).select_from(base.subquery())
         )).scalar_one()
+
         res = await self.session.execute(
-            stmt.offset(page.page * page.size).limit(page.size)
+            base.offset(page.page * page.size).limit(page.size)
         )
         items = res.scalars().all()
         return Page(items, total, page.page, page.size)
-    
+
     async def get_all_by_column(
         self,
         column_name: str,
@@ -297,8 +351,7 @@ class SAAsyncRepository(Generic[T]):
     ) -> list[T]:
         col = self._resolve_column(column_name)
         stmt = select(self.model).where(col == value)
-        if not include_deleted and hasattr(self.model, "is_deleted"):
-            stmt = stmt.where(self.model.is_deleted == False)  # noqa: E712
+        stmt = self._apply_alive_filter(stmt, include_deleted)
         stmt = self._apply_filters(stmt, **extra_filters)
         if order_by is not None:
             stmt = stmt.order_by(order_by)

{sarepo-0.1.4 → sarepo-0.1.6}/SARepo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SARepo
-Version: 0.1.4
+Version: 0.1.6
 Summary: Minimal, explicit Repository & Unit-of-Work layer over SQLAlchemy 2.x
 Author: nurbergenovv
 License: MIT

{sarepo-0.1.4 → sarepo-0.1.6}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "SARepo"
-version = "0.1.4"
+version = "0.1.6"
 description = "Minimal, explicit Repository & Unit-of-Work layer over SQLAlchemy 2.x"
 readme = "README.md"
 requires-python = ">=3.11"

{sarepo-0.1.4 → sarepo-0.1.6}/tests/test_sync_basic.py

@@ -132,8 +132,11 @@ def test_restore(session, repo):
     seed(session, repo)
 
     beta = repo.find_all_by_column("title", "beta")[0]
-    beta.is_deleted = True
+    beta.is_deleted = False
     session.commit()
+    
+    deleted = repo.remove(id=beta.id)
+    print("DELETED ", deleted)
 
     ok = repo.restore(beta.id)
     assert ok is True

sarepo-0.1.4/SARepo/repo.py

@@ -1,48 +0,0 @@
-
-from typing import Generic, List, TypeVar, Type, Optional, Any, Protocol
-from .base import Page, PageRequest
-
-T = TypeVar("T")
-
-class CrudRepository(Protocol, Generic[T]):
-    model: Type[T]
-    def getAll(self, limit: Optional[int]) -> List[T]: ...
-    def get(self, id_: Any) -> T: ...
-    def try_get(self, id_: Any) -> Optional[T]: ...
-    def add(self, entity: T) -> T: ...
-    def update(self, entity: T) -> T: ...
-    def remove(self, entity: T) -> None: ...
-    def delete_by_id(self, id_: Any) -> bool: ...
-    def page(self, page: PageRequest, spec=None, order_by=None) -> Page[T]: ...
-    def get_all_by_column(
-        self,
-        column_name: str,
-        value: Any,
-        *,
-        limit: Optional[int] = None,
-        order_by=None,
-        include_deleted: bool = False,
-        **extra_filters
-    ) -> list[T]: ...
-    def find_all_by_column(
-        self,
-        column_name: str,
-        value: Any,
-        *,
-        limit: Optional[int] = None,
-        order_by=None,
-        include_deleted: bool = False,
-        **extra_filters
-    ) -> list[T]: ...
-    def get_or_create(
-        self,
-        defaults: Optional[dict] = None,
-        **unique_filters
-    ) -> tuple[T, bool]: ...
-    def raw_query(self, sql: str, params: Optional[dict] = None) -> list[dict]: ...
-    def aggregate_avg(self, column_name: str, **filters) -> Optional[float]: ...
-    def aggregate_min(self, column_name: str, **filters): ...
-    def aggregate_max(self, column_name: str, **filters): ...
-    def aggregate_sum(self, column_name: str, **filters): ... 
-    def count(self, **filters) -> int: ...
-    def restore(self, id_: Any) -> bool: ...