fastapi-sqlalchemy-toolkit 0.7.9__tar.gz → 0.7.11__tar.gz

{fastapi_sqlalchemy_toolkit-0.7.9 → fastapi_sqlalchemy_toolkit-0.7.11}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastapi_sqlalchemy_toolkit
-Version: 0.7.9
+Version: 0.7.11
 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.9 → fastapi_sqlalchemy_toolkit-0.7.11}/docs/ru/sorting.md

@@ -7,11 +7,11 @@
 
 Для применения декларативной сортировки нужно:
 
-- Определить поля, по которым доступна фильтрация.
+## Определить поля, по которым доступна фильтрация
 
 Это может быть:
 
-1. Cпискок или кортеж полей основной модели:
+- Cписок или кортеж полей основной модели:
 
 ```python
 from app.models import Child
@@ -27,7 +27,7 @@ child_ordering_fields = (
 
 Дефис первым символом означает направление сортировки по убыванию.
 
-2. Маппинг строковых полей для сортировки на соответствующие поля моделей:
+- Маппинг строковых полей для сортировки на соответствующие поля моделей:
 
 ```python
 from app.models import Child, Parent
@@ -41,7 +41,7 @@ child_ordering_fields = {
 В таком случае, будут доступны следующий параметря для сортировки:
 `title`, `-title`, `parent_title`, `-parent_title`.
 
-- В параметрах энпдоинта передать определённый выше список
+## В параметрах энпдоинта передать определённый выше список
 в `ordering_depends`
 
 ```python
@@ -55,7 +55,7 @@ async def get_child_objects(
     ...
 ```
 
-- Передать параметр сортировки как параметр `order_by` в методы `ModelManager`
+## Передать параметр сортировки как параметр `order_by` в методы `ModelManager`
 
 ```python
     return await child_manager.list(session=session, order_by=order_by)

{fastapi_sqlalchemy_toolkit-0.7.9 → fastapi_sqlalchemy_toolkit-0.7.11}/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
@@ -243,7 +243,9 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
 
         result = await session.execute(stmt)
         if base_stmt is None:
-            return result.scalars().first()
+            if order_by is not None:
+                return result.scalars().first()
+            return result.scalar_one_or_none()
         return result.first()
 
     async def get_or_404(
@@ -484,6 +486,8 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         options: List[Any] | Any | None = None,
         where: Any | None = None,
         base_stmt: Select | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
         *,
         unique: bool = False,
         **simple_filters: Any,
@@ -505,12 +509,24 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         :param base_stmt: объект Select для SQL запроса. Если передан, то метод вернёт
         список Row, а не ModelT.
 
+        :param limit: ограничение, передаётся в параметр limit запроса SQLAlchemy
+
+        :param offset: смещение, передаётся в параметр offset запроса SQLAlchemy
+
         :param simple_filters: параметры для фильтрации по точному соответствию,
         аналогично методу .filter_by() SQLAlchemy
 
         :returns: список объектов или Row
         """
-        stmt = self.assemble_stmt(base_stmt, order_by, options, where, **simple_filters)
+        stmt = self.assemble_stmt(
+            base_stmt,
+            order_by,
+            options,
+            where,
+            limit=limit,
+            offset=offset,
+            **simple_filters,
+        )
         result = await session.execute(stmt)
 
         if base_stmt is None:
@@ -530,6 +546,8 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         options: List[Any] | Any | None = None,
         where: Any | None = None,
         base_stmt: Select | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
         *,
         unique: bool = False,
         **simple_filters: Any,
@@ -563,6 +581,10 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         Примечание: фильтрация и сортировка по связанным моделям скорее всего
         не будут работать вместе с этим параметром.
 
+        :param limit: ограничение, передаётся в параметр limit запроса SQLAlchemy
+
+        :param offset: смещение, передаётся в параметр offset запроса SQLAlchemy
+
         :param simple_filters: параметры для фильтрации по точному соответствию,
         аналогично методу .filter_by() SQLAlchemy
 
@@ -577,7 +599,15 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         self.handle_nullable_filter_expressions(nullable_filter_expressions)
         filter_expressions = filter_expressions | nullable_filter_expressions
 
-        stmt = self.assemble_stmt(base_stmt, order_by, options, where, **simple_filters)
+        stmt = self.assemble_stmt(
+            base_stmt,
+            order_by,
+            options,
+            where,
+            limit=limit,
+            offset=offset,
+            **simple_filters,
+        )
         stmt = self.get_joins(
             stmt,
             options=options,
@@ -667,7 +697,9 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         """
         update_data = in_obj.model_dump(exclude_unset=exclude_unset) if in_obj else {}
         update_data.update(attrs)
-        update_data = await self.run_db_validation(session, db_obj=db_obj, in_obj=update_data)
+        update_data = await self.run_db_validation(
+            session, db_obj=db_obj, in_obj=update_data
+        )
         for field in update_data:
             setattr(db_obj, field, update_data[field])
         await self.save(session, commit=commit)
@@ -949,6 +981,8 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         order_by: InstrumentedAttribute | UnaryExpression | None = None,
         options: List[Any] | Any | None = None,
         where: Any | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
         **simple_filters: Any,
     ) -> Select:
         if base_stmt is not None:
@@ -990,6 +1024,11 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             else:
                 stmt = stmt.where(where)
 
+        if limit is not None:
+            stmt = stmt.limit(limit)
+        if offset is not None:
+            stmt = stmt.offset(offset)
+
         return stmt
 
     async def validate_fk_exists(

{fastapi_sqlalchemy_toolkit-0.7.9 → fastapi_sqlalchemy_toolkit-0.7.11}/pyproject.toml

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