fastapi-rtk 2.18.0__tar.gz → 2.18.1__tar.gz

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastapi-rtk
-Version: 2.18.0
+Version: 2.18.1
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.18.1/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.18.1"

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/fastapi_rtk/agent_docs/guide/backend.md

@@ -551,7 +551,7 @@ The task runs later, possibly after the loop has advanced or the enclosing funct
 
 ### Sizing the `/download` stream
 
-`/download` exports every row matching the query, so it ignores `page` and `page_size` from the request; they reach the handler and are overwritten. It reads the rows in chunks, and the `download_page_size` attribute on the Api decides how large a chunk is (since the first release after v2.15.0). It is either an int (a fixed chunk) or a resolver `(api, session, params) -> int`. It defaults to the `API_DOWNLOAD_PAGE_SIZE` config key, which is itself the built-in resolver: it counts the matching rows and takes a tenth of them, floored at the `API_DOWNLOAD_MIN_PAGE_SIZE` config key (default `100`) and capped at `API_DOWNLOAD_MAX_PAGE_SIZE` (default `10000`) so a large table cannot size the chunk into an out-of-memory read.
+`/download` exports every row matching the query, so it ignores `page` and `page_size` from the request; they reach the handler and are overwritten. It reads the rows in chunks, and the `download_page_size` attribute on the Api decides how large a chunk is (since the first release after v2.15.0). It is either an int (a fixed chunk) or a resolver `(api, session, params) -> int`. It defaults to the `API_DOWNLOAD_PAGE_SIZE` config key, which is itself the built-in resolver: it counts the matching rows and takes a tenth of them, floored at the `API_DOWNLOAD_MIN_PAGE_SIZE` config key (default `100`) and capped at `API_DOWNLOAD_MAX_PAGE_SIZE` (default `1000`) so a large table cannot size the chunk into an out-of-memory read.
 
 Set it to an int for a fixed chunk, which also skips the count query the default runs:
 

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/fastapi_rtk/backends/sqla/interface.py

@@ -157,9 +157,14 @@ class SQLAInterface(
             if not chunk:
                 break
             yield chunk
-            # Drop the consumed chunk from the identity map so a large export
-            # does not retain every fetched row and exhaust memory.
-            await smart_run(session.expunge_all)
+
+            # Expunge consumed rows one by one; expunge_all() swaps the identity
+            # map the streaming result still holds, killing mid-stream fetches.
+            def expunge_chunk() -> None:
+                for item in chunk:
+                    session.expunge(item)
+
+            await smart_run(expunge_chunk)
         await safe_call(self.close(session))
 
     async def add(self, session, item, *, flush=True, commit=True, refresh=True):

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/fastapi_rtk/const.py

@@ -73,7 +73,7 @@ DEFAULT_PUBLIC_ROLE = "Public"
 DEFAULT_API_PAGE_SIZE = 25
 DEFAULT_API_MAX_PAGE_SIZE = 25
 DEFAULT_API_DOWNLOAD_MIN_PAGE_SIZE = 100
-DEFAULT_API_DOWNLOAD_MAX_PAGE_SIZE = 10000
+DEFAULT_API_DOWNLOAD_MAX_PAGE_SIZE = 1000
 DEFAULT_TOKEN_URL = "/api/v1/auth/jwt/login"
 DEFAULT_SECRET = "SUPERSECRET"
 DEFAULT_COOKIE_NAME = "dataTactics"

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/tests/unit/backends/sqla/test_interface.py

@@ -4,6 +4,7 @@ import enum
 
 import pytest
 import sqlalchemy
+import sqlalchemy.ext.asyncio
 import sqlalchemy.orm
 
 from fastapi_rtk import (
@@ -35,6 +36,12 @@ class _RichModel(Model):
     score: Mapped[float | None] = mapped_column(sqlalchemy.Float)
 
 
+class _StreamRow(Model):
+    __tablename__ = "tier8_stream"
+    id: Mapped[int] = mapped_column(primary_key=True)
+    name: Mapped[str | None] = mapped_column(sqlalchemy.String(50))
+
+
 @pytest.fixture
 def rich_iface():
     return SQLAInterface(_RichModel)
@@ -372,20 +379,37 @@ class TestCRUD:
         total = sum(len(c) for c in chunks)
         assert total == 3
 
-    async def test_yield_per_expunges_each_chunk(self, session, iface, monkeypatch):
-        expunge_calls = 0
-        original = session.expunge_all
+    async def test_yield_per_expunges_consumed_rows(self, session, iface, monkeypatch):
+        expunged = []
+        original = session.expunge
 
-        def expunge_all():
-            nonlocal expunge_calls
-            expunge_calls += 1
-            original()
+        def expunge(item):
+            expunged.append(item)
+            original(item)
 
-        monkeypatch.setattr(session, "expunge_all", expunge_all)
+        monkeypatch.setattr(session, "expunge", expunge)
         async for _chunk in iface.yield_per(session, {"page_size": 2}):
             pass
-        assert expunge_calls >= 1
-        assert len(session.identity_map) == 0
+        assert len(expunged) == 3
+
+    async def test_yield_per_async_survives_chunk_boundary(self):
+        engine = sqlalchemy.ext.asyncio.create_async_engine("sqlite+aiosqlite://")
+        try:
+            async with engine.begin() as conn:
+                await conn.run_sync(_StreamRow.__table__.create)
+            interface = SQLAInterface(_StreamRow)
+            async with sqlalchemy.ext.asyncio.AsyncSession(engine) as write_session:
+                write_session.add_all(
+                    [_StreamRow(id=i, name=f"n{i}") for i in range(1, 7)]
+                )
+                await write_session.commit()
+            async with sqlalchemy.ext.asyncio.AsyncSession(engine) as read_session:
+                total = 0
+                async for chunk in interface.yield_per(read_session, {"page_size": 2}):
+                    total += len(chunk)
+            assert total == 6
+        finally:
+            await engine.dispose()
 
     async def test_add(self, session, iface, Person_cls):
         new = Person_cls(id=99, name="Dave", age=50, country_id=1)

{fastapi_rtk-2.18.0 → fastapi_rtk-2.18.1}/tests/unit/test_const.py

@@ -59,7 +59,7 @@ class TestDefaults:
         assert const.DEFAULT_API_PAGE_SIZE == 25
         assert const.DEFAULT_API_MAX_PAGE_SIZE == 25
         assert const.DEFAULT_API_DOWNLOAD_MIN_PAGE_SIZE == 100
-        assert const.DEFAULT_API_DOWNLOAD_MAX_PAGE_SIZE == 10000
+        assert const.DEFAULT_API_DOWNLOAD_MAX_PAGE_SIZE == 1000
 
     def test_default_token_url(self):
         assert const.DEFAULT_TOKEN_URL.startswith("/")

fastapi_rtk-2.18.0/fastapi_rtk/_version.py

@@ -1 +0,0 @@
-__version__ = "2.18.0"