SARepo 0.1.5__tar.gz → 0.1.7__tar.gz

{sarepo-0.1.5 → sarepo-0.1.7}/PKG-INFO

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

sarepo-0.1.7/SARepo/repo.py

@@ -0,0 +1,74 @@
+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,
+               order_by=None,
+               **filters) -> List[T]: ...
+
+    def get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> T: ...
+
+    def try_get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> 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.5 → sarepo-0.1.7}/SARepo/sa_repo.py

@@ -1,4 +1,3 @@
-
 from typing import List, Type, Generic, TypeVar, Optional, Sequence, Any, Callable
 from sqlalchemy.orm import Session
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -8,8 +7,10 @@ from .base import PageRequest, Page, NotFoundError
 T = TypeVar("T")
 Spec = Callable
 
+
 class SARepository(Generic[T]):
     """Synchronous repository implementation for SQLAlchemy 2.x."""
+
     def __init__(self, model: Type[T], session: Session):
         self.model = model
         self.session = session
@@ -31,35 +32,52 @@ class SARepository(Generic[T]):
     def _has_soft_delete(self) -> bool:
         return hasattr(self.model, "is_deleted")
 
-    def _apply_alive_filter(self, stmt, include_deleted: bool) :
+    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]:
+
+    def getAll(
+            self,
+            limit: Optional[int] = None,
+            *,
+            include_deleted: bool = False,
+            order_by=None,
+            **filters
+    ) -> List[T]:
         stmt = select(self.model)
+        stmt = self._apply_filters(stmt, **filters)
         stmt = self._apply_alive_filter(stmt, include_deleted)
+        if order_by is not None:
+            stmt = stmt.order_by(order_by)
         if limit is not None:
             stmt = stmt.limit(limit)
         result = self.session.execute(stmt)
-        return result.scalars().all()    
-    
-    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")
+        return result.scalars().all()
+
+    def get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> T:
+        if id_ is not None:
+            obj = self.session.get(self.model, id_)
+            if not obj:
+                raise NotFoundError(f"{self.model.__name__}({id_}) not found")
+        else:
+            stmt = select(self.model)
+            stmt = self._apply_filters(stmt, **filters)
+            stmt = self._apply_alive_filter(stmt, include_deleted)
+            res = self.session.execute(stmt)
+            obj = res.scalars().first()
+            if not obj:
+                raise NotFoundError(f"{self.model.__name__} not found for {filters}")
         if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
-            raise NotFoundError(f"{self.model.__name__}({id_}) not found")  # скрываем как «нет»
+            raise NotFoundError(f"{self.model.__name__}({getattr(obj, 'id', '?')}) deleted")
         return obj
 
-    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):
+    def try_get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> Optional[T]:
+        try:
+            return self.get(id_=id_, include_deleted=include_deleted, **filters)
+        except NotFoundError:
             return None
-        return obj
-    
+
     def add(self, entity: T) -> T:
         self.session.add(entity)
         self.session.flush()
@@ -71,7 +89,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)
@@ -79,20 +103,23 @@ 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)
 
-    def delete_by_id(self, id_: Any) -> bool:
+        return True
+
+    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, *, include_deleted: bool = False) -> Page[T]:
+    def page(self, page: PageRequest, spec: Optional[Spec] = None, order_by=None, *, include_deleted: bool = False) -> \
+    Page[T]:
         base = self._select()
         if spec:
             base = spec(base)
@@ -108,16 +135,16 @@ class SARepository(Generic[T]):
             base.offset(page.page * page.size).limit(page.size)
         ).scalars().all()
         return Page(items, total, page.page, page.size)
-    
+
     def get_all_by_column(
-        self,
-        column_name: str,
-        value: Any,
-        *,
-        limit: Optional[int] = None,
-        order_by=None,
-        include_deleted: bool = False,
-        **extra_filters
+            self,
+            column_name: str,
+            value: Any,
+            *,
+            limit: Optional[int] = None,
+            order_by=None,
+            include_deleted: bool = False,
+            **extra_filters
     ) -> list[T]:
         col = self._resolve_column(column_name)
         stmt = select(self.model).where(col == value)
@@ -129,15 +156,15 @@ 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)
-    
+
     def get_or_create(
-        self,
-        defaults: Optional[dict] = None,
-        **unique_filters
+            self,
+            defaults: Optional[dict] = None,
+            **unique_filters
     ) -> tuple[T, bool]:
         """
         Возвращает (obj, created). unique_filters определяют уникальность.
@@ -220,12 +247,14 @@ class SARepository(Generic[T]):
             return True
         return False
 
+
 class SAAsyncRepository(Generic[T]):
     """Async repository implementation for SQLAlchemy 2.x."""
+
     def __init__(self, model: Type[T], session: AsyncSession):
         self.model = model
         self.session = session
-    
+
     def _resolve_column(self, column_name: str):
         try:
             return getattr(self.model, column_name)
@@ -236,41 +265,71 @@ class SAAsyncRepository(Generic[T]):
         if filters:
             stmt = stmt.filter_by(**filters)
         return stmt
-    
+
     def _select(self):
         return select(self.model)
-    
+
     def _has_soft_delete(self) -> bool:
         return hasattr(self.model, "is_deleted")
 
-    def _apply_alive_filter(self, stmt, include_deleted: bool) :
+    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]:
+    async def getAll(
+            self,
+            limit: Optional[int] = None,
+            *,
+            include_deleted: bool = False,
+            order_by=None,
+            **filters
+    ) -> List[T]:
+        """
+        Получить все записи с возможностью фильтрации (username='foo', age__gt=20, и т.д.)
+        """
         stmt = select(self.model)
+        stmt = self._apply_filters(stmt, **filters)
         stmt = self._apply_alive_filter(stmt, include_deleted)
+        if order_by is not None:
+            stmt = stmt.order_by(order_by)
         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, *, 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")
+    async def get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> T:
+        """
+        Получить один объект по id или по произвольным фильтрам.
+        Пример:
+            await repo.get(id_=1)
+            await repo.get(username='ibrahim')
+            await repo.get(username__ilike='%rah%')
+        """
+        if id_ is not None:
+            obj = await self.session.get(self.model, id_)
+            if not obj:
+                raise NotFoundError(f"{self.model.__name__}({id_}) not found")
+        else:
+            stmt = select(self.model)
+            stmt = self._apply_filters(stmt, **filters)
+            stmt = self._apply_alive_filter(stmt, include_deleted)
+            res = await self.session.execute(stmt)
+            obj = res.scalars().first()
+            if not obj:
+                raise NotFoundError(f"{self.model.__name__} not found for {filters}")
         if self._has_soft_delete() and not include_deleted and getattr(obj, "is_deleted", False):
-            raise NotFoundError(f"{self.model.__name__}({id_}) not found")
+            raise NotFoundError(f"{self.model.__name__}({getattr(obj, 'id', '?')}) deleted")
         return obj
 
-    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):
+    async def try_get(self, id_: Any = None, *, include_deleted: bool = False, **filters) -> Optional[T]:
+        """
+        Как get(), но не выбрасывает исключение при отсутствии объекта.
+        """
+        try:
+            return await self.get(id_=id_, include_deleted=include_deleted, **filters)
+        except NotFoundError:
             return None
-        return obj
 
     async def add(self, entity: T) -> T:
         self.session.add(entity)
@@ -283,7 +342,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)
@@ -291,20 +356,23 @@ 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)
 
-    async def delete_by_id(self, id_: Any) -> bool:
+        return True
+
+    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, *, include_deleted: bool = False) -> Page[T]: # type: ignore
+    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:
             base = spec(base)
@@ -323,14 +391,14 @@ class SAAsyncRepository(Generic[T]):
         return Page(items, total, page.page, page.size)
 
     async def get_all_by_column(
-        self,
-        column_name: str,
-        value: Any,
-        *,
-        limit: Optional[int] = None,
-        order_by=None,
-        include_deleted: bool = False,
-        **extra_filters
+            self,
+            column_name: str,
+            value: Any,
+            *,
+            limit: Optional[int] = None,
+            order_by=None,
+            include_deleted: bool = False,
+            **extra_filters
     ) -> list[T]:
         col = self._resolve_column(column_name)
         stmt = select(self.model).where(col == value)
@@ -346,11 +414,11 @@ class SAAsyncRepository(Generic[T]):
     # Alias
     async def find_all_by_column(self, *args, **kwargs):
         return await self.get_all_by_column(*args, **kwargs)
-    
+
     async def get_or_create(
-        self,
-        defaults: Optional[dict] = None,
-        **unique_filters
+            self,
+            defaults: Optional[dict] = None,
+            **unique_filters
     ) -> tuple[T, bool]:
         stmt = select(self.model).filter_by(**unique_filters)
         if hasattr(self.model, "is_deleted"):
@@ -420,4 +488,4 @@ class SAAsyncRepository(Generic[T]):
             setattr(obj, "is_deleted", False)
             await self.session.flush()
             return True
-        return False
+        return False

{sarepo-0.1.5 → sarepo-0.1.7}/SARepo.egg-info/PKG-INFO

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

{sarepo-0.1.5 → sarepo-0.1.7}/pyproject.toml

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

{sarepo-0.1.5 → sarepo-0.1.7}/tests/test_sync_basic.py

@@ -54,20 +54,6 @@ def seed(session, repo):
 
 
 
-def test_find_all_by_column_basic(session, repo):
-    seed(session, repo)
-
-    items = repo.find_all_by_column("city", "Almaty")
-    titles = {x.title for x in items}
-    assert titles == {"alpha", "gamma"}
-
-    limited = repo.find_all_by_column("city", "Almaty", limit=1, order_by=Item.amount.desc())
-    assert len(limited) == 1 and limited[0].title == "gamma"
-
-    with pytest.raises(ValueError):
-        repo.find_all_by_column("no_such_column", "x")
-
-
 def test_get_or_create(session, repo):
     seed(session, repo)
 
@@ -132,8 +118,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.5/SARepo/repo.py

@@ -1,50 +0,0 @@
-
-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: T) -> None: ...
-    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: ...