fastapi-sqlalchemy-toolkit 0.7.20__tar.gz → 0.8.1__tar.gz

{fastapi_sqlalchemy_toolkit-0.7.20 → fastapi_sqlalchemy_toolkit-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_sqlalchemy_toolkit
-Version: 0.7.20
+Version: 0.8.1
 Summary: FastAPI SQLAlchemy Toolkit
 Project-URL: Homepage, https://github.com/e-kondr01/fastapi-sqlalchemy-toolkit
 Author-email: Egor Kondrashov <e.kondr01@gmail.com>

{fastapi_sqlalchemy_toolkit-0.7.20 → fastapi_sqlalchemy_toolkit-0.8.1}/fastapi_sqlalchemy_toolkit/model_manager.py

@@ -1,6 +1,6 @@
 # ruff: noqa: UP006
 from collections.abc import Callable, Iterable
-from typing import Any, Generic, List, TypeVar  # noqa: UP035
+from typing import Any, Generic, List, TypeVar, overload  # noqa: UP035
 
 from fastapi import HTTPException, status
 from fastapi_pagination.bases import BasePage
@@ -26,6 +26,7 @@ from sqlalchemy.orm.attributes import InstrumentedAttribute
 from sqlalchemy.orm.relationships import Relationship
 from sqlalchemy.sql import Select
 from sqlalchemy.sql.elements import UnaryExpression
+from sqlalchemy.sql.expression import BinaryExpression, ColumnElement
 from sqlalchemy.sql.functions import Function
 from sqlalchemy.sql.schema import ScalarElementColumnDefault
 from sqlalchemy.sql.selectable import Exists
@@ -234,6 +235,32 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             return result.scalars().all()
         return None
 
+    @overload
+    async def get(
+        self,
+        session: AsyncSession,
+        options: List[Any] | Any | None = ...,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> ModelT | None: ...
+
+    @overload
+    async def get(
+        self,
+        session: AsyncSession,
+        options: List[Any] | Any | None = ...,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> Row | None: ...
+
     async def get(
         self,
         session: AsyncSession,
@@ -280,6 +307,32 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             return result.scalar_one_or_none()
         return result.first()
 
+    @overload
+    async def get_or_404(
+        self,
+        session: AsyncSession,
+        options: List[Any] | Any | None = ...,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> ModelT: ...
+
+    @overload
+    async def get_or_404(
+        self,
+        session: AsyncSession,
+        options: List[Any] | Any | None = ...,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> Row: ...
+
     async def get_or_404(
         self,
         session: AsyncSession,
@@ -407,6 +460,30 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             )
         return True
 
+    @overload
+    async def paginated_filter(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        transformer: Callable | None = ...,
+        **simple_filters: Any,
+    ) -> BasePage[ModelT]: ...
+
+    @overload
+    async def paginated_filter(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        transformer: Callable | None = ...,
+        **simple_filters: Any,
+    ) -> BasePage[Row]: ...
+
     async def paginated_filter(
         self,
         session: AsyncSession,
@@ -416,7 +493,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         base_stmt: Select | None = None,
         transformer: Callable | None = None,
         **simple_filters: Any,
-    ) -> BasePage[ModelT | Row]:
+    ) -> BasePage[Any]:
         """
         Получение списка объектов с фильтрами и пагинацией.
 
@@ -443,11 +520,46 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         stmt = self.assemble_stmt(base_stmt, order_by, options, where, **simple_filters)
         return await paginate(session, stmt, transformer=transformer)
 
+    @overload
+    async def paginated_list(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = ...,
+        nullable_filter_expressions: (
+            dict[InstrumentedAttribute | Callable, Any] | None
+        ) = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        transformer: Callable | None = ...,
+        **simple_filters: Any,
+    ) -> BasePage[ModelT]: ...
+
+    @overload
+    async def paginated_list(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = ...,
+        nullable_filter_expressions: (
+            dict[InstrumentedAttribute | Callable, Any] | None
+        ) = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        transformer: Callable | None = ...,
+        **simple_filters: Any,
+    ) -> BasePage[Row]: ...
+
     async def paginated_list(
         self,
         session: AsyncSession,
         order_by: InstrumentedAttribute | UnaryExpression | None = None,
-        filter_expressions: dict[InstrumentedAttribute | Callable, Any] | None = None,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = None,
         nullable_filter_expressions: (
             dict[InstrumentedAttribute | Callable, Any] | None
         ) = None,
@@ -456,7 +568,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         base_stmt: Select | None = None,
         transformer: Callable | None = None,
         **simple_filters: Any,
-    ) -> BasePage[ModelT | Row]:
+    ) -> BasePage[Any]:
         """
         Получение списка объектов с фильтрами и пагинацией.
         Пропускает фильтры, значения которых None.
@@ -510,13 +622,46 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         )
 
         for filter_expression, value in filter_expressions.items():
-            if isinstance(filter_expression, InstrumentedAttribute | Function):
+            if isinstance(
+                filter_expression,
+                InstrumentedAttribute | Function | BinaryExpression | ColumnElement,
+            ):
                 stmt = stmt.filter(filter_expression == value)
             else:
                 stmt = stmt.filter(filter_expression(value))
 
         return await paginate(session, stmt, transformer=transformer)
 
+    @overload
+    async def filter(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        limit: int | None = ...,
+        offset: int | None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> List[ModelT]: ...
+
+    @overload
+    async def filter(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        limit: int | None = ...,
+        offset: int | None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> List[Row]: ...
+
     async def filter(
         self,
         session: AsyncSession,
@@ -529,7 +674,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         *,
         unique: bool = False,
         **simple_filters: Any,
-    ) -> List[ModelT] | List[Row]:
+    ) -> List[Any]:
         """
         Получение списка объектов с фильтрами
 
@@ -573,11 +718,52 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             return result.scalars().all()
         return result.all()
 
+    @overload
+    async def list(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = ...,
+        nullable_filter_expressions: (
+            dict[InstrumentedAttribute | Callable, Any] | None
+        ) = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: None = ...,
+        limit: int | None = ...,
+        offset: int | None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> List[ModelT]: ...
+
+    @overload
+    async def list(
+        self,
+        session: AsyncSession,
+        order_by: InstrumentedAttribute | UnaryExpression | None = ...,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = ...,
+        nullable_filter_expressions: (
+            dict[InstrumentedAttribute | Callable, Any] | None
+        ) = ...,
+        options: List[Any] | Any | None = ...,
+        where: Any | None = ...,
+        base_stmt: Select = ...,
+        limit: int | None = ...,
+        offset: int | None = ...,
+        *,
+        unique: bool = ...,
+        **simple_filters: Any,
+    ) -> List[Row]: ...
+
     async def list(
         self,
         session: AsyncSession,
         order_by: InstrumentedAttribute | UnaryExpression | None = None,
-        filter_expressions: dict[InstrumentedAttribute | Callable, Any] | None = None,
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any]
+        | None = None,
         nullable_filter_expressions: (
             dict[InstrumentedAttribute | Callable, Any] | None
         ) = None,
@@ -589,7 +775,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         *,
         unique: bool = False,
         **simple_filters: Any,
-    ) -> List[ModelT] | List[Row]:
+    ) -> List[Any]:
         """
         Получение списка объектов с фильтрами.
         Пропускает фильтры, значения которых None.
@@ -654,7 +840,10 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         )
 
         for filter_expression, value in filter_expressions.items():
-            if isinstance(filter_expression, InstrumentedAttribute):
+            if isinstance(
+                filter_expression,
+                InstrumentedAttribute | BinaryExpression | ColumnElement,
+            ):
                 stmt = stmt.filter(filter_expression == value)
             else:
                 stmt = stmt.filter(filter_expression(value))
@@ -899,7 +1088,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
     def get_joins(
         self,
         base_query: Select,
-        filter_expressions: dict[InstrumentedAttribute | Callable, Any],
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any],
         options: List[Any] | None = None,
         order_by: InstrumentedAttribute | UnaryExpression | None = None,
     ) -> Select:
@@ -932,6 +1121,8 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
                 model = filter_expression.parent._identity_class
             elif isinstance(filter_expression, Function):
                 model = filter_expression.entity_namespace
+            elif isinstance(filter_expression, ColumnElement):
+                model = self.model  # Not supported
             else:
                 model = filter_expression.__self__.parent._identity_class
             if model != self.model:
@@ -981,7 +1172,7 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
 
     @staticmethod
     def handle_filter_expressions(
-        filter_expressions: dict[InstrumentedAttribute | Callable, Any],
+        filter_expressions: dict[InstrumentedAttribute | Callable | ColumnElement, Any],
     ) -> None:
         for filter_expression, value in filter_expressions.copy().items():
             if value is None:
@@ -993,7 +1184,9 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
 
     @staticmethod
     def handle_nullable_filter_expressions(
-        nullable_filter_expressions: dict[InstrumentedAttribute | Callable, Any],
+        nullable_filter_expressions: dict[
+            InstrumentedAttribute | Callable | ColumnElement, Any
+        ],
     ) -> None:
         for filter_expression, value in nullable_filter_expressions.copy().items():
             if value in null_query_values:

{fastapi_sqlalchemy_toolkit-0.7.20 → fastapi_sqlalchemy_toolkit-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi_sqlalchemy_toolkit"
-version = "0.7.20"
+version = "0.8.1"
 authors = [
   { name="Egor Kondrashov", email="e.kondr01@gmail.com" },
 ]