fastapi-sqlalchemy-toolkit 0.7.3.1__tar.gz → 0.7.4.1__tar.gz

{fastapi_sqlalchemy_toolkit-0.7.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: fastapi_sqlalchemy_toolkit
-Version: 0.7.3.1
+Version: 0.7.4.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.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/docs/extension.md

@@ -53,9 +53,7 @@ class MyModelManager[MyModel, MyModelCreateSchema, MyModelUpdateSchema](ModelMan
     return created
 ```
 
-This approach aligns with the "*Fat Models, Skinny Views*" principle from Django.
-
-### Using declarative dilters in non-standard list queries
+### Using declarative filters in non-standard list queries
 If you need to retrieve not just a list of objects but also other fields (e.g., the number of child objects)
 or aggregations, and you also need declarative filtering, you can create a new manager method,
 calling the `super().get_filter_expression` method within it:

fastapi_sqlalchemy_toolkit-0.7.4.1/docs/ru/benefits.md

@@ -0,0 +1,105 @@
+# Предпосылки
+Необязательный раздел с примером сокращения количества шаблонного кода при использовании `fastapi_sqlalchemy_toolkit`.
+
+Если в эндпоинт `FastAPI` с использованием `SQLAlchemy`
+нужно добавить фильтры по значениям полей при получении списка,
+то код будет выглядеть примерно так:
+
+```python
+from uuid import UUID
+
+from fastapi_pagination import Page
+from fastapi_pagination.ext.sqlalchemy import paginate
+from sqlalchemy import select
+
+from .deps import Session
+from .models import MyModel, ParentModel
+from .schemas import MyObjectListSchema
+
+
+@router.get("/my-objects")
+async def get_my_objects(
+    session: Session,
+    user_id: UUID | None = None,
+    name: str | None = None,
+    parent_name: str | None = None,
+) -> Page[MyObjectListSchema]:
+    stmt = select(MyModel)
+    if user_id is not None:
+        stmt = stmt.filter_by(user_id=user_id)
+    if name is not None:
+        stmt = stmt.filter(MyModel.name.ilike == f"%{name}%")
+    if parent_name is not None:
+        stmt = stmt.join(MyModel.parent)
+        stmt = stmt.filter(ParentModel.name.ilike == f"%{parent_name}%")
+    return await paginate(session, stmt)
+```
+
+В `fastapi-sqlalchemy-toolkit` этот эндпоинт выглядит так:
+
+```python
+from app.managers import my_object_manager
+
+@router.get("/my-objects")
+async def get_my_objects(
+    session: Session,
+    user_id: UUID | None = None,
+    name: str | None = None,
+    parent_name: str | None = None,
+) -> Page[MyObjectListSchema]:
+    return await my_object_manager.paginated_list(
+        session,
+        user_id=user_id,
+        filter_expressions={
+            MyObject.name: name,
+            MyObjectParent.name: parent_name
+        }
+    )
+```
+
+Теперь рассмотрим создание объекта, который имеет FK и уникальное поле. Без `fastapi-sqlalchemy-toolkit`:
+
+```python
+@router.post("/my-objects")
+async def create_my_object(
+    session: Session, in_obj: MyObjectCreateSchema
+) -> MyObjectListSchema:
+    if in_obj.parent_id:
+        parent_exists = (
+            await session.execute(select(ParentModel.id).filter_by(id=in_obj.parent_id))
+        ).first() is not None
+        if not parent_exists:
+            raise HTTPException(
+                status.HTTP_400_BAD_REQUEST,
+                detail=f"Parent with id {in_obj.parent_id} does not exist",
+            )
+
+    slug_exists = (
+        await session.execute(select(MyModel.id).filter_by(slug=in_obj.slug))
+    ).first() is not None
+    if slug_exists:
+        raise HTTPException(
+            status.HTTP_400_BAD_REQUEST,
+            detail=f"MyModel with slug {in_obj.slug} already exists",
+        )
+
+    db_obj = MyModel(**in_obj.model_dump())
+    session.add(db_obj)
+    await session.commit()
+    await session.refresh(db_obj)
+    return db_obj
+```
+
+С использованием `fastapi-sqlalchemy-toolkit`:
+
+```python
+@router.post("/my-objects")
+async def create_my_object(
+    session: Session, in_obj: MyObjectCreateSchema
+) -> MyObjectListSchema:
+    return await my_object_manager.create(session, in_obj=in_obj)
+```
+
+В обоих случаях, использование `fastapi-sqlalchemy-toolkit` значительно сокращает
+код приложения за счёт внутренней реализации в методах `ModelManager` стандартной логики,
+необходимой при создании REST API.

{fastapi_sqlalchemy_toolkit-0.7.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/docs/ru/usage.md

@@ -1,6 +1,9 @@
 ### Инициализация ModelManager
 
-Для использования `fastapi-sqlaclhemy-toolkit` необходимо создать экземпляр `ModelManager` для своей модели:
+Для взаимодействия с моделью `SQLAlchemy`, `fastapi-sqlalchemy-toolkit` предоставляет
+класс `ModelManager`. Его методы используются для взаимодействия с БД.
+
+Создать экземпляр `ModelManager` для конкретной модели можно следующим образом:
 
 ```python
 from fastapi_sqlalchemy_toolkit import ModelManager
@@ -8,10 +11,17 @@ from fastapi_sqlalchemy_toolkit import ModelManager
 from .models import MyModel
 from .schemas import MyModelCreateSchema, MyModelUpdateSchema
 
-my_model_manager = ModelManager[MyModel, MyModelCreateSchema, MyModelUpdateSchema](MyModel)
+my_model_manager = ModelManager[MyModel, MyModelCreateSchema, MyModelUpdateSchema](
+    MyModel
+)
 ```
 
-Атрибут `default_ordering` определяет сортировку по умолчанию при получении списка объектов. В него нужно передать поле основной модели.
+В качестве аргумента передаётся модель `SQLAlchemy`. Кроме того, используется параметризация типов 
+класса `ModelManager`. В параметры типа передаётся модель `SQLAlchemy`, `Pydantic` модель для
+создания объекта и `Pydantic` модель для обновления объекта.
+
+Атрибут `default_ordering` определяет сортировку по умолчанию при получении списка объектов.
+В него можно передать поле модели:
 
 ```python
 from fastapi_sqlalchemy_toolkit import ModelManager
@@ -38,3 +48,8 @@ my_model_manager = ModelManager[MyModel, MyModelCreateSchema, MyModelUpdateSchem
 - `count` - получение количества объектов
 - `update` - обновление объекта; выполняет валидацию значений полей на уровне БД
 - `delete` - удаление объекта
+
+Использование методов `paginated_list` и `paginated_filter`, согласно документации 
+`fastapi_pagination`, требует применения `fastapi_pagination.add_pagination`
+к приложению `FastAPI`, и использование `fastapi_pagination.Page` в типизации ответа
+эндпоинта FastAPI.

{fastapi_sqlalchemy_toolkit-0.7.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/fastapi_sqlalchemy_toolkit/model_manager.py

@@ -847,7 +847,10 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             stmt = stmt.options(option)
 
         if where is not None:
-            stmt = stmt.where(where)
+            if isinstance(where, tuple):
+                stmt = stmt.where(*where)
+            else:
+                stmt = stmt.where(where)
 
         return stmt
 

{fastapi_sqlalchemy_toolkit-0.7.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/fastapi_sqlalchemy_toolkit/utils.py

@@ -2,6 +2,7 @@ from copy import deepcopy
 from typing import Annotated, Any, Optional, TypeVar
 
 import pydantic
+import pydantic_core
 from fastapi import Query
 
 BaseModelT = TypeVar("BaseModelT", bound=pydantic.BaseModel)
@@ -12,9 +13,7 @@ def _make_field_optional(
 ) -> tuple[Any, pydantic.fields.FieldInfo]:
     new = deepcopy(field)
     new.default = (
-        None
-        if field.default == pydantic.pydantic_core.PydanticUndefined
-        else field.default
+        None if field.default == pydantic_core.PydanticUndefined else field.default
     )
     new.annotation = Optional[field.annotation]  # type: ignore  # noqa: UP007
     return (new.annotation, new)

{fastapi_sqlalchemy_toolkit-0.7.3.1 → fastapi_sqlalchemy_toolkit-0.7.4.1}/pyproject.toml

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

fastapi_sqlalchemy_toolkit-0.7.3.1/docs/ru/benefits.md

@@ -1,64 +0,0 @@
-# Предпосылки
-Необязательный раздел с демо сокращения количества шаблонного кода при использовании `fastapi_sqlalchemy_toolkit`.
-
-Если в эндпоинт `FastAPI` нужно добавить фильтры по значениям полей, то код будет выглядеть примерно так:
-
-```python
-from typing import Annotated
-from uuid import UUID
-
-from fastapi import APIRouter, Depends, Response, status
-from sqlalchemy import select
-from sqlalchemy.ext.asyncio import AsyncSession
-
-from app.deps import get_async_session
-from app.models import MyModel, MyParentModel
-from app.schemas import MyObjectListSchema
-
-router = APIRouter()
-Session = Annotated[AsyncSession, Depends(get_async_session)]
-
-
-@router.get("/my-objects")
-async def get_my_objects(
-    session: Session,
-    user_id: UUID | None = None,
-    name: str | None = None,
-    parent_name: str | None = None,
-) -> list[MyObjectListSchema]:
-    stmt = select(MyModel)
-    if user_id is not None:
-        stmt = stmt.filter_by(user_id=user_id)
-    if name is not None:
-        stmt = stmt.filter(MyModel.name.ilike == f"%{name}%")
-    if parent_name is not None:
-        stmt = stmt.join(MyModel.parent)
-        stmt = stmt.filter(ParentModel.name.ilike == f"%{parent_name}%")
-    result = await session.execute(stmt)
-    return result.scalars().all()
-```
-Как можно заметить, для реализации фильтрации необходима дубликация шаблонного кода.
-
-В `fastapi-sqlalchemy-toolkit` этот эндпоинт выглядит так:
-
-```python
-from fastapi_sqlalchemy_toolkit import FieldFilter
-
-from app.managers import my_object_manager
-
-@router.get("/my-objects")
-async def get_my_objects(
-    session: Session,
-    user_id: UUID | None = None,
-    name: str | None = None,
-    parent_name: str | None = None,
-) -> list[MyObjectListSchema]:
-    return await my_object_manager.list(
-        session,
-        user_id=user_id,
-        filter_expressions={
-            MyObject.name: name,
-            MyObjectParent.name: parent_name
-        }
-    )
-```