Add get_many

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,6 +85,14 @@ async def get(self, identifier: PRIMARY_KEY) -> MODEL:
             raise ModelNotFound("No rows found for provided primary key.")
         return model
 
+    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,
         entity: Union[MODEL, PRIMARY_KEY],

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,6 +74,14 @@ def get(self, identifier: PRIMARY_KEY) -> MODEL:
             raise ModelNotFound("No rows found for provided primary key.")
         return model
 
+    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, entity: Union[MODEL, PRIMARY_KEY]) -> None:
         # TODO: delete without loading the model
         if isinstance(entity, self._model):

sqlalchemy_bind_manager/protocols.py

@@ -47,7 +47,16 @@ 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 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, entity: Union[MODEL, PRIMARY_KEY]) -> None:
@@ -191,6 +200,16 @@ def get(self, identifier: PRIMARY_KEY) -> MODEL:
         # TODO: implement get_many()
         ...
 
+    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, entity: Union[MODEL, PRIMARY_KEY]) -> None:
         """Deletes a model.
 

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_get.py

@@ -19,6 +19,39 @@ def test_get_returns_model(repository_class, model_class, sa_manager):
     assert isinstance(result, model_class)
 
 
+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())
+    repo.save_many({model, model2, model3})
+
+    result = 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
+
+
+def test_get_many_returns_empty_list_if_nothing_found(
+    repository_class, model_class, sa_manager
+):
+    repo = repository_class(sa_manager.get_bind())
+
+    result = repo.get_many([1, 2])
+    assert isinstance(result, list)
+    assert len(result) == 0
+
+
 def test_get_raises_exception_if_not_found(repository_class, sa_manager):
     repo = repository_class(sa_manager.get_bind())