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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_sqlalchemy_toolkit
-Version: 0.7.4.1
+Version: 0.7.5.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.4.1 → fastapi_sqlalchemy_toolkit-0.7.5.1}/docs/ru/usage.md

@@ -52,4 +52,10 @@ my_model_manager = ModelManager[MyModel, MyModelCreateSchema, MyModelUpdateSchem
 Использование методов `paginated_list` и `paginated_filter`, согласно документации 
 `fastapi_pagination`, требует применения `fastapi_pagination.add_pagination`
 к приложению `FastAPI`, и использование `fastapi_pagination.Page` в типизации ответа
-эндпоинта FastAPI.
+эндпоинта FastAPI.
+
+Также доступны следующие методы для выполнения действий "пачкой":
+
+- `bulk_create` - создание объектов (частично выполняет валидацию на уровне БД)
+- `bulk_update` - обновление объектов (не выполняет валидацию на уровне БД)
+- `bulk_delete` - удаление объектов

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

@@ -6,7 +6,17 @@ from fastapi import HTTPException, status
 from fastapi_pagination.bases import BasePage
 from fastapi_pagination.ext.sqlalchemy import paginate
 from pydantic import BaseModel
-from sqlalchemy import Integer, Row, String, UniqueConstraint, func, select
+from sqlalchemy import (
+    Integer,
+    Row,
+    String,
+    UniqueConstraint,
+    delete,
+    func,
+    insert,
+    select,
+    update,
+)
 from sqlalchemy.dialects.postgresql import BOOLEAN
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import DeclarativeBase, contains_eager, load_only
@@ -152,6 +162,48 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         await session.refresh(db_obj, attribute_names=refresh_attribute_names)
         return db_obj
 
+    async def bulk_create(
+        self,
+        session: AsyncSession,
+        in_objs: list[CreateSchemaT],
+        *,
+        commit: bool = True,
+        returning: bool = True,
+        **attrs: Any,
+    ) -> list[ModelT] | None:
+        """
+        Создание экземпляров модели пачкой и сохранение в БД.
+
+        Валидация на уровне БД выполняется для каждого объекта
+        (могут быть ошибки, если несколько создаваемых объектов
+        имеют одинаковое значение для уникального поля).
+
+        :param session: сессия SQLAlchemy
+
+        :param in_objs: модели Pydantic для создания объектов
+
+        :param commit: нужно ли вызывать `session.commit()`, если используется
+        подход commit as you go
+
+        :param returning: нужно ли возвращать созданные объекты
+
+        :param attrs: дополнительные значения полей создаваемых экземпляров
+
+        :returns: созданные экземпляры модели или None
+        """
+        create_data = [in_obj.model_dump() | attrs for in_obj in in_objs]
+        for in_obj in create_data:
+            await self.run_db_validation(session, in_obj)
+
+        stmt = insert(self.model).values(create_data)
+        if returning:
+            stmt = stmt.returning(self.model)
+        result = await session.execute(stmt)
+        await self.save(session, commit=commit)
+        if returning:
+            return result.scalars().all()
+        return None
+
     async def get(
         self,
         session: AsyncSession,
@@ -618,6 +670,56 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         await session.refresh(db_obj, attribute_names=refresh_attribute_names)
         return db_obj
 
+    async def bulk_update(
+        self,
+        session: AsyncSession,
+        in_obj: UpdateSchemaT | None = None,
+        ids: Iterable | None = None,
+        where: Any | None = None,
+        *,
+        commit: bool = True,
+        returning: bool = True,
+        **attrs: Any,
+    ) -> List[ModelT] | None:
+        """
+        Обновление экземпляров модели пачкой и сохранение в БД.
+        Не выполняет валидацию на уровне БД.
+
+        :param session: сессия SQLAlchemy
+
+        :param in_obj: модель Pydantic для обновления объектов
+
+        :param ids: ID обновляемых объектов (в списке, кортеже и т.д.)
+
+        :param where: фильтр для обновления объектов,
+        передаётся в метод .where() SQLAlchemy.
+        Используется, если не передан параметр :ids:
+
+        :param commit: нужно ли вызывать `session.commit()`, если используется
+        подход commit as you go
+
+        :param returning: нужно ли возвращать обновлённые объекты
+
+        :param attrs: дополнительные значения полей обновляемых экземпляров
+
+        :returns: обновлённые экземпляры модели или None
+        """
+        update_data = in_obj.model_dump() if in_obj else {}
+        update_data.update(attrs)
+
+        stmt = update(self.model).values(update_data)
+        if ids:
+            stmt = stmt.where(self.model.id.in_(ids))
+        elif where:
+            stmt = stmt.where(where)
+        if returning:
+            stmt = stmt.returning(self.model)
+        result = await session.execute(stmt)
+        await self.save(session, commit=commit)
+        if returning:
+            return result.scalars().all()
+        return None
+
     async def delete(
         self, session: AsyncSession, db_obj: ModelT, *, commit: bool = True
     ) -> ModelT:
@@ -637,6 +739,38 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
         await self.save(session, commit=commit)
         return db_obj
 
+    async def bulk_delete(
+        self,
+        session: AsyncSession,
+        ids: Iterable | None = None,
+        where: Any | None = None,
+        *,
+        commit: bool = True,
+    ) -> None:
+        """
+        Удаление экземпляров модели пачкой из БД.
+
+        :param session: сессия SQLAlchemy
+
+        :param ids: ID удаляемых объектов (в списке, кортеже и т.д.)
+
+        :param where: фильтр для удаления объектов,
+        передаётся в метод .where() SQLAlchemy.
+        Используется, если не передан параметр :ids:
+
+        :param commit: нужно ли вызывать `session.commit()`, если используется
+        подход commit as you go
+
+        :returns: None
+        """
+        stmt = delete(self.model)
+        if ids:
+            stmt = stmt.where(self.model.id.in_(ids))
+        elif where:
+            stmt = stmt.where(where)
+        await session.execute(stmt)
+        await self.save(session, commit=commit)
+
     ##################################################################################
     # Internal methods
     ##################################################################################
@@ -779,9 +913,9 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             if value is None:
                 del filter_expressions[filter_expression]
             elif "ilike" in str(filter_expression):
-                filter_expressions[
-                    filter_expression
-                ] = f"%{filter_expressions[filter_expression]}%"
+                filter_expressions[filter_expression] = (
+                    f"%{filter_expressions[filter_expression]}%"
+                )
 
     @staticmethod
     def handle_nullable_filter_expressions(
@@ -793,9 +927,9 @@ class ModelManager(Generic[ModelT, CreateSchemaT, UpdateSchemaT]):
             elif value is None:
                 del nullable_filter_expressions[filter_expression]
             elif "ilike" in str(filter_expression):
-                nullable_filter_expressions[
-                    filter_expression
-                ] = f"%{nullable_filter_expressions[filter_expression]}%"
+                nullable_filter_expressions[filter_expression] = (
+                    f"%{nullable_filter_expressions[filter_expression]}%"
+                )
 
     def get_reverse_relation_filter_stmt(
         self,

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

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

fastapi_sqlalchemy_toolkit-0.7.5.1/requirements/docs.txt

@@ -0,0 +1,4 @@
+mkdocs==1.6.0
+mkdocs-material==9.5.26
+mkdocs-static-i18n==1.2.3
+pymdown-extensions==10.8.1

fastapi_sqlalchemy_toolkit-0.7.4.1/requirements/docs.txt

@@ -1,4 +0,0 @@
-mkdocs==1.5.3
-mkdocs-material==9.5.8
-mkdocs-static-i18n==1.2.0
-pymdown-extensions==10.7