Merge pull request #33 from febus982/add_repository_methods_for_many_models

Add repository methods for collections of models

Author: febus982

sqlalchemy_bind_manager/_repository/async_.py

@@ -12,6 +12,7 @@
     Union,
 )
 
+from sqlalchemy import select
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from .._bind_manager import SQLAlchemyAsyncBind
@@ -84,17 +85,22 @@ async def get(self, identifier: PRIMARY_KEY) -> MODEL:
             raise ModelNotFound("No rows found for provided primary key.")
         return model
 
-    async def delete(
-        self,
-        entity: Union[MODEL, PRIMARY_KEY],
-    ) -> None:
-        # TODO: delete without loading the model
-        if isinstance(entity, self._model):
-            obj = entity
-        else:
-            obj = await self.get(entity)  # type: ignore
+    async def get_many(self, identifiers: Iterable[PRIMARY_KEY]) -> List[MODEL]:
+        stmt = select(self._model).where(
+            getattr(self._model, self._model_pk()).in_(identifiers)
+        )
+
+        async with self._get_session(commit=False) as session:
+            return [x for x in (await session.execute(stmt)).scalars()]
+
+    async def delete(self, instance: MODEL) -> None:
+        async with self._get_session() as session:
+            await session.delete(instance)
+
+    async def delete_many(self, instances: Iterable[MODEL]) -> None:
         async with self._get_session() as session:
-            await session.delete(obj)
+            for instance in instances:
+                await session.delete(instance)
 
     async def find(
         self,

sqlalchemy_bind_manager/_repository/sync.py

@@ -12,6 +12,7 @@
     Union,
 )
 
+from sqlalchemy import select
 from sqlalchemy.orm import Session
 
 from .._bind_manager import SQLAlchemyBind
@@ -73,14 +74,22 @@ def get(self, identifier: PRIMARY_KEY) -> MODEL:
             raise ModelNotFound("No rows found for provided primary key.")
         return model
 
-    def delete(self, entity: Union[MODEL, PRIMARY_KEY]) -> None:
-        # TODO: delete without loading the model
-        if isinstance(entity, self._model):
-            obj = entity
-        else:
-            obj = self.get(entity)  # type: ignore
+    def get_many(self, identifiers: Iterable[PRIMARY_KEY]) -> List[MODEL]:
+        stmt = select(self._model).where(
+            getattr(self._model, self._model_pk()).in_(identifiers)
+        )
+
+        with self._get_session(commit=False) as session:
+            return [x for x in session.execute(stmt).scalars()]
+
+    def delete(self, instance: MODEL) -> None:
+        with self._get_session() as session:
+            session.delete(instance)
+
+    def delete_many(self, instances: Iterable[MODEL]) -> None:
         with self._get_session() as session:
-            session.delete(obj)
+            for model in instances:
+                session.delete(model)
 
     def find(
         self,

sqlalchemy_bind_manager/protocols.py

@@ -47,14 +47,29 @@ async def get(self, identifier: PRIMARY_KEY) -> MODEL:
         :return: A model instance
         :raises ModelNotFound: No model has been found using the primary key
         """
-        # TODO: implement get_many()
         ...
 
-    async def delete(self, entity: Union[MODEL, PRIMARY_KEY]) -> None:
+    async def get_many(self, identifiers: Iterable[PRIMARY_KEY]) -> List[MODEL]:
+        """Get a list of models by primary keys.
+
+        :param identifiers: A list of primary keys
+        :type identifiers: List
+        :return: A list of models
+        :rtype: List
+        """
+        ...
+
+    async def delete(self, instance: MODEL) -> None:
         """Deletes a model.
 
-        :param entity: The model instance or the primary key
-        :type entity: Union[MODEL, PRIMARY_KEY]
+        :param instance: The model instance
+        """
+        ...
+
+    async def delete_many(self, instances: Iterable[MODEL]) -> None:
+        """Deletes a collection of models in a single transaction.
+
+        :param instances: The model instances
         """
         ...
 
@@ -188,14 +203,29 @@ def get(self, identifier: PRIMARY_KEY) -> MODEL:
         :return: A model instance
         :raises ModelNotFound: No model has been found using the primary key
         """
-        # TODO: implement get_many()
         ...
 
-    def delete(self, entity: Union[MODEL, PRIMARY_KEY]) -> None:
+    def get_many(self, identifiers: Iterable[PRIMARY_KEY]) -> List[MODEL]:
+        """Get a list of models by primary keys.
+
+        :param identifiers: A list of primary keys
+        :type identifiers: List
+        :return: A list of models
+        :rtype: List
+        """
+        ...
+
+    def delete(self, instance: MODEL) -> None:
         """Deletes a model.
 
-        :param entity: The model instance or the primary key
-        :type entity: Union[MODEL, PRIMARY_KEY]
+        :param instance: The model instance
+        """
+        ...
+
+    async def delete_many(self, instances: Iterable[MODEL]) -> None:
+        """Deletes a collection of models in a single transaction.
+
+        :param instances: The model instances
         """
         ...
 

tests/repository/async_/test_delete.py

@@ -1,26 +1,5 @@
 import pytest
-
-
-async def test_can_delete_by_pk(repository_class, model_class, sa_manager):
-    model = model_class(
-        model_id=1,
-        name="Someone",
-    )
-    model2 = model_class(
-        model_id=2,
-        name="SomeoneElse",
-    )
-    repo = repository_class(sa_manager.get_bind())
-    await repo.save_many({model, model2})
-
-    results = [x for x in await repo.find()]
-    assert len(results) == 2
-
-    await repo.delete(1)
-    results = [x for x in await repo.find()]
-    assert len(results) == 1
-    assert results[0].model_id == 2
-    assert results[0].name == "SomeoneElse"
+from sqlalchemy import select
 
 
 async def test_can_delete_by_instance(repository_class, model_class, sa_manager):
@@ -55,3 +34,37 @@ async def test_delete_inexistent_raises_exception(
 
     with pytest.raises(Exception):
         await repo.delete(4)
+
+    with pytest.raises(Exception):
+        await repo.delete(
+            model_class(
+                model_id=823,
+                name="Someone",
+            )
+        )
+
+
+async def test_relationships_are_respected(
+    related_repository_class, related_model_classes, sa_manager
+):
+    parent = related_model_classes[0](
+        name="A Parent",
+    )
+    child = related_model_classes[1](name="A Child")
+    child2 = related_model_classes[1](name="Another Child")
+    parent.children.append(child)
+    parent.children.append(child2)
+    repo = related_repository_class(sa_manager.get_bind())
+    await repo.save(parent)
+
+    retrieved_parent = await repo.get(parent.parent_model_id)
+    assert len(retrieved_parent.children) == 2
+
+    await repo.delete(retrieved_parent)
+
+    async with repo._get_session() as session:
+        result = [
+            x
+            for x in (await session.execute(select(related_model_classes[1]))).scalars()
+        ]
+        assert len(result) == 0

tests/repository/async_/test_delete_many.py

@@ -0,0 +1,72 @@
+import pytest
+from sqlalchemy import select
+
+
+async def test_can_delete_by_instance(repository_class, model_class, sa_manager):
+    model = model_class(
+        model_id=1,
+        name="Someone",
+    )
+    model2 = model_class(
+        model_id=2,
+        name="SomeoneElse",
+    )
+    repo = repository_class(sa_manager.get_bind())
+    await repo.save_many({model, model2})
+
+    results = [x for x in await repo.find()]
+    assert len(results) == 2
+
+    await repo.delete_many([model])
+    results = [x for x in await repo.find()]
+    assert len(results) == 1
+    assert results[0].model_id == 2
+    assert results[0].name == "SomeoneElse"
+
+
+async def test_delete_inexistent_raises_exception(
+    repository_class, model_class, sa_manager
+):
+    repo = repository_class(sa_manager.get_bind())
+
+    results = [x for x in await repo.find()]
+    assert len(results) == 0
+
+    with pytest.raises(Exception):
+        await repo.delete_many([4])
+
+    with pytest.raises(Exception):
+        await repo.delete_many(
+            [
+                model_class(
+                    model_id=823,
+                    name="Someone",
+                )
+            ]
+        )
+
+
+async def test_relationships_are_respected(
+    related_repository_class, related_model_classes, sa_manager
+):
+    parent = related_model_classes[0](
+        name="A Parent",
+    )
+    child = related_model_classes[1](name="A Child")
+    child2 = related_model_classes[1](name="Another Child")
+    parent.children.append(child)
+    parent.children.append(child2)
+    repo = related_repository_class(sa_manager.get_bind())
+    await repo.save(parent)
+
+    retrieved_parent = await repo.get(parent.parent_model_id)
+    assert len(retrieved_parent.children) == 2
+
+    await repo.delete_many([retrieved_parent])
+
+    async with repo._get_session() as session:
+        result = [
+            x
+            for x in (await session.execute(select(related_model_classes[1]))).scalars()
+        ]
+        assert len(result) == 0

tests/repository/async_/test_get.py

@@ -19,6 +19,39 @@ async def test_get_returns_model(repository_class, model_class, sa_manager):
     assert isinstance(result, model_class)
 
 
+async def test_get_many_returns_models(repository_class, model_class, sa_manager):
+    model = model_class(
+        model_id=1,
+        name="Someone",
+    )
+    model2 = model_class(
+        model_id=2,
+        name="SomeoneElse",
+    )
+    model3 = model_class(
+        model_id=3,
+        name="StillSomeoneElse",
+    )
+    repo = repository_class(sa_manager.get_bind())
+    await repo.save_many({model, model2, model3})
+
+    result = await repo.get_many([1, 2])
+    assert isinstance(result, list)
+    assert len(result) == 2
+    assert result[0].model_id == 1
+    assert result[1].model_id == 2
+
+
+async def test_get_many_returns_empty_list_if_nothing_found(
+    repository_class, model_class, sa_manager
+):
+    repo = repository_class(sa_manager.get_bind())
+
+    result = await repo.get_many([1, 2])
+    assert isinstance(result, list)
+    assert len(result) == 0
+
+
 async def test_get_raises_exception_if_not_found(repository_class, sa_manager):
     repo = repository_class(sa_manager.get_bind())
 

tests/repository/sync/test_delete.py

@@ -1,26 +1,5 @@
 import pytest
-
-
-def test_can_delete_by_pk(repository_class, model_class, sa_manager):
-    model = model_class(
-        model_id=1,
-        name="Someone",
-    )
-    model2 = model_class(
-        model_id=2,
-        name="SomeoneElse",
-    )
-    repo = repository_class(sa_manager.get_bind())
-    repo.save_many({model, model2})
-
-    results = [x for x in repo.find()]
-    assert len(results) == 2
-
-    repo.delete(1)
-    results = [x for x in repo.find()]
-    assert len(results) == 1
-    assert results[0].model_id == 2
-    assert results[0].name == "SomeoneElse"
+from sqlalchemy import select
 
 
 def test_can_delete_by_instance(repository_class, model_class, sa_manager):
@@ -53,3 +32,36 @@ def test_delete_inexistent_raises_exception(repository_class, model_class, sa_ma
 
     with pytest.raises(Exception):
         repo.delete(4)
+
+    with pytest.raises(Exception):
+        repo.delete(
+            model_class(
+                model_id=823,
+                name="Someone",
+            )
+        )
+
+
+def test_relationships_are_respected(
+    related_repository_class, related_model_classes, sa_manager
+):
+    parent = related_model_classes[0](
+        name="A Parent",
+    )
+    child = related_model_classes[1](name="A Child")
+    child2 = related_model_classes[1](name="Another Child")
+    parent.children.append(child)
+    parent.children.append(child2)
+    repo = related_repository_class(sa_manager.get_bind())
+    repo.save(parent)
+
+    retrieved_parent = repo.get(parent.parent_model_id)
+    assert len(retrieved_parent.children) == 2
+
+    repo.delete(retrieved_parent)
+
+    with repo._get_session() as session:
+        result = [
+            x for x in session.execute(select(related_model_classes[1])).scalars()
+        ]
+        assert len(result) == 0