fastapi-mongo-base 1.7.0__tar.gz → 1.7.2__tar.gz

{fastapi_mongo_base-1.7.0/src/fastapi_mongo_base.egg-info → fastapi_mongo_base-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 1.7.0
+Version: 1.7.2
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>

{fastapi_mongo_base-1.7.0 → fastapi_mongo_base-1.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-base"
-version = "1.7.0"
+version = "1.7.2"
 description = "A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB"
 readme = "README.md"
 requires-python = ">=3.10"

fastapi_mongo_base-1.7.2/src/fastapi_mongo_base/utils/mongo_aggregate.py

@@ -0,0 +1,47 @@
+"""Mongo aggregation helpers compatible with Motor and PyMongo async."""
+
+from __future__ import annotations
+
+import inspect
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from beanie import Document
+
+
+def _get_collection(model: type[Document]) -> object:
+    """Return the Beanie collection (Beanie 2 pymongo or Beanie 1 motor)."""
+    getter = getattr(model, "get_pymongo_collection", None) or getattr(
+        model, "get_motor_collection", None
+    )
+    if getter is None:
+        raise AttributeError(
+            f"{model.__name__} has neither get_pymongo_collection "
+            "nor get_motor_collection"
+        )
+    return getter()
+
+
+async def aggregate_to_list(
+    model: type[Document],
+    pipeline: list[dict[str, object]],
+    *,
+    length: int | None = None,
+    **kwargs: object,
+) -> list[dict[str, object]]:
+    """
+    Run an aggregation pipeline and return documents as a list.
+
+    Beanie's ``aggregate().to_list()`` assumes Motor cursors; PyMongo 4.x
+    native async may return a coroutine from ``aggregate()`` — this helper
+    supports both drivers. Collection access works with Beanie 2
+    (``get_pymongo_collection``) and Beanie 1 (``get_motor_collection``).
+    """
+    collection = _get_collection(model)
+    cursor = collection.aggregate(pipeline, **kwargs)
+    if inspect.isawaitable(cursor):
+        cursor = await cursor
+    result = cursor.to_list(length=length)
+    if inspect.isawaitable(result):
+        return await result
+    return result

{fastapi_mongo_base-1.7.0 → fastapi_mongo_base-1.7.2/src/fastapi_mongo_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 1.7.0
+Version: 1.7.2
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>

{fastapi_mongo_base-1.7.0 → fastapi_mongo_base-1.7.2}/src/fastapi_mongo_base.egg-info/SOURCES.txt

@@ -69,6 +69,7 @@ src/fastapi_mongo_base/utils/__init__.py
 src/fastapi_mongo_base/utils/basic.py
 src/fastapi_mongo_base/utils/bsontools.py
 src/fastapi_mongo_base/utils/delegated_create.py
+src/fastapi_mongo_base/utils/mongo_aggregate.py
 src/fastapi_mongo_base/utils/timezone.py
 src/fastapi_mongo_base/utils/trace.py
 src/fastapi_mongo_base/utils/usso_routes.py
@@ -87,6 +88,7 @@ tests/test_http_errors.py
 tests/test_i18n.py
 tests/test_i18n_timezone.py
 tests/test_middlewares.py
+tests/test_mongo_aggregate.py
 tests/test_mongodb_errors.py
 tests/test_monitoring_middleware.py
 tests/test_monitoring_mongo.py

fastapi_mongo_base-1.7.2/tests/test_mongo_aggregate.py

@@ -0,0 +1,63 @@
+"""Tests for Motor/PyMongo-compatible aggregation helper."""
+
+from __future__ import annotations
+
+from typing import Any
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+
+from src.fastapi_mongo_base.utils.mongo_aggregate import aggregate_to_list
+
+
+@pytest.mark.asyncio
+async def test_aggregate_to_list_beanie2_pymongo_collection() -> None:
+    """Beanie 2: use get_pymongo_collection; aggregate/to_list may be sync."""
+    docs = [{"_id": 1}]
+    cursor = MagicMock()
+    cursor.to_list.return_value = docs
+    collection = MagicMock()
+    collection.aggregate.return_value = cursor
+    model = MagicMock(spec=["get_pymongo_collection"])
+    model.get_pymongo_collection.return_value = collection
+    model.__name__ = "Doc"
+
+    result = await aggregate_to_list(model, [{"$match": {}}], length=10)
+
+    assert result == docs
+    model.get_pymongo_collection.assert_called_once_with()
+    collection.aggregate.assert_called_once_with([{"$match": {}}])
+    cursor.to_list.assert_called_once_with(length=10)
+
+
+@pytest.mark.asyncio
+async def test_aggregate_to_list_beanie1_motor_fallback() -> None:
+    """Beanie 1: fall back to get_motor_collection."""
+    docs = [{"_id": 2}]
+    cursor = MagicMock()
+    cursor.to_list = AsyncMock(return_value=docs)
+    collection = MagicMock()
+    collection.aggregate = AsyncMock(return_value=cursor)
+    model = MagicMock(spec=["get_motor_collection"])
+    model.get_motor_collection.return_value = collection
+    model.__name__ = "Doc"
+
+    pipeline: list[dict[str, Any]] = [{"$group": {"_id": None}}]
+    result = await aggregate_to_list(
+        model, pipeline, length=None, allowDiskUse=True
+    )
+
+    assert result == docs
+    model.get_motor_collection.assert_called_once_with()
+    collection.aggregate.assert_awaited_once_with(pipeline, allowDiskUse=True)
+    cursor.to_list.assert_awaited_once_with(length=None)
+
+
+@pytest.mark.asyncio
+async def test_aggregate_to_list_missing_collection_getter() -> None:
+    """Raise when the model exposes neither collection getter."""
+    model = MagicMock(spec=[])
+    model.__name__ = "Broken"
+
+    with pytest.raises(AttributeError, match="get_pymongo_collection"):
+        await aggregate_to_list(model, [])