fastapi-rtk 1.0.11__tar.gz → 1.0.13__tar.gz

{fastapi_rtk-1.0.11 → fastapi_rtk-1.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 1.0.11
+Version: 1.0.13
 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
@@ -25,3 +25,4 @@ Requires-Dist: polib>=1.2.0
 Requires-Dist: prometheus-fastapi-instrumentator>=7.1.0
 Requires-Dist: secweb>=1.25.2
 Requires-Dist: sqlalchemy-utils>=0.42.0
+Requires-Dist: uvicorn==0.38.0

fastapi_rtk-1.0.13/fastapi_rtk/_version.py

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

{fastapi_rtk-1.0.11 → fastapi_rtk-1.0.13}/fastapi_rtk/api/model_rest_api.py

@@ -462,6 +462,17 @@ class ModelRestApi(BaseApi):
     DO NOT MODIFY UNLESS YOU KNOW WHAT YOU ARE DOING.
     """
 
+    """
+    -------------
+     LIST
+    -------------
+    """
+
+    list_query_count_enabled = True
+    """
+    Whether to enable counting the total number of items in the list endpoint. Defaults to `True`.
+    """
+
     """
     -------------
      TITLES
@@ -1030,6 +1041,28 @@ class ModelRestApi(BaseApi):
         """
         return current_permissions(self)
 
+    def get_q_and_session_count_factory(self):
+        """
+        Returns a dependency that yields a tuple of (QuerySchema, session or None).
+
+        If `list_query_count_enabled` is False or `q.with_count` is False, the session will be None.
+
+        Returns:
+            Callable[..., Coroutine[Any, Any, Tuple[QuerySchema, AsyncSession | Session | None]]]: The dependency that yields the tuple.
+        """
+        session_factory = self.datamodel.get_session_factory()
+
+        async def dependency(q: self.query_schema = Depends()):  # type: ignore
+            q: QuerySchema = q
+            if not self.list_query_count_enabled or not q.with_count:
+                yield q, None
+                return
+
+            async for session in session_factory():
+                yield q, session
+
+        return dependency
+
     """
     -------------
      ROUTES
@@ -1508,19 +1541,17 @@ class ModelRestApi(BaseApi):
 
     async def get_list_headless(
         self,
-        q: QuerySchema = SelfType.with_depends().query_schema,
         session: AsyncSession | Session = SelfDepends().datamodel.get_session_factory,
-        session_count: AsyncSession
-        | Session = SelfDepends().datamodel.get_session_factory,
+        q_session_count: tuple[
+            QuerySchema, AsyncSession | Session | None
+        ] = SelfDepends().get_q_and_session_count_factory,
     ):
         """
         Retrieves all items in a headless mode.
 
         Args:
-            q (QuerySchema): The query schema.
-            query (QueryManager): The query manager object.
             session (AsyncSession | Session): A database scoped session.
-            session_count (AsyncSession | Session): A database scoped session for counting.
+            q_session_count (tuple[QuerySchema, AsyncSession | Session | None]): A tuple of query schema and a database scoped session for counting.
 
         Returns:
             list_return_schema: The list return schema.
@@ -1529,6 +1560,7 @@ class ModelRestApi(BaseApi):
             If you are overriding this method, make sure to copy all the decorators too.
         """
         async with AsyncTaskRunner():
+            q, session_count = q_session_count
             self._validate_query_parameters(q)
             params = self._handle_query_params(q)
             try:
@@ -1536,9 +1568,14 @@ class ModelRestApi(BaseApi):
                     task_items = tg.create_task(
                         smart_run(self.datamodel.get_many, session, params)
                     )
-                    task_count = tg.create_task(
-                        smart_run(self.datamodel.count, session_count, params)
-                    )
+                    if session_count:
+                        task_count = tg.create_task(
+                            smart_run(self.datamodel.count, session_count, params)
+                        )
+                    else:
+                        task_count = tg.create_task(
+                            asyncio.sleep(0, result=None)
+                        )  # Dummy task
                 items, count = await task_items, await task_count
                 pks, data = self.datamodel.convert_to_result(items)
                 schema = self.list_return_schema

{fastapi_rtk-1.0.11 → fastapi_rtk-1.0.13}/fastapi_rtk/schemas.py

@@ -323,7 +323,7 @@ class BaseResponseMany(BaseResponse):
     Represents a response containing multiple items.
 
     Attributes:
-        count (int): The count of items.
+        count (int | None): The count of items. If None, count is not provided.
         ids (List[PRIMARY_KEY]): The IDs of the items.
         list_columns (List[str]): The columns to show in the list.
         list_title (str): The title for the list.
@@ -331,7 +331,7 @@ class BaseResponseMany(BaseResponse):
         result (List[BaseModel] | None): The result of the response.
     """
 
-    count: int
+    count: int | None = None
     ids: list[PRIMARY_KEY]
     list_columns: list[str] = []
     list_title: str = ""
@@ -384,24 +384,26 @@ class QuerySchema(BaseModel):
     Represents the query parameters for selection, pagination, ordering, and filtering.
 
     Attributes:
-        columns (str, optional): The columns to select in the query. Defaults to '[]'.
         page (int): The page number for pagination. Defaults to 0.
         page_size (int, optional): The number of items per page. Defaults to 25.
         order_column (str, optional): The column to order the results by.
         order_direction (Literal['asc', 'desc'], optional): The direction of the ordering (asc or desc).
+        columns (str, optional): The columns to select in the query. Defaults to '[]'.
         filters (str, optional): The filters to apply to the query. Defaults to '[]'.
         opr_filters (str, optional): The filters to apply without column name. Defaults to '[]'.
         global_filter (str, optional): The filter to apply globally across all columns.
+        with_count (bool): Whether to include the total count of items. Defaults to True.
     """
 
-    columns: str = "[]"
     page: int = 0
     page_size: int | None = 25
     order_column: str | None = None
     order_direction: Literal["asc", "desc"] | None = None
+    columns: str = "[]"
     filters: str = "[]"
     opr_filters: str = "[]"
     global_filter: str | None = None
+    with_count: bool = True
 
     @field_validator("columns")
     @classmethod

{fastapi_rtk-1.0.11 → fastapi_rtk-1.0.13}/pyproject.toml

@@ -38,6 +38,7 @@ dependencies = [
   "prometheus-fastapi-instrumentator>=7.1.0",
   "secweb>=1.25.2",
   "sqlalchemy-utils>=0.42.0",
+  "uvicorn==0.38.0",
 ]
 urls = { Homepage = "https://codeberg.org/datatactics/fastapi-rtk", Issues = "https://codeberg.org/datatactics/fastapi-rtk/issues" }
 scripts = { "fastapi-rtk" = "fastapi_rtk.cli:main" }

fastapi_rtk-1.0.11/fastapi_rtk/_version.py

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