fastapi-rtk 2.1.3__tar.gz → 2.1.5__tar.gz

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.1.3
+Version: 2.1.5
 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.1.5/fastapi_rtk/_version.py

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

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/base_api.py

@@ -21,11 +21,10 @@ class BaseApi:
     """
     Base API class for FastAPI.
 
-    Provides a foundation for exposing API routes with integrated permission and authentication support.
-    Handles route registration, permission management, and toolkit integration, allowing you to build
-    secure and extensible APIs.
+    Exposes API routes with integrated permission and authentication support,
+    handling route registration, permission management, and toolkit integration.
 
-    See [FastAPI path]("https://fastapi.tiangolo.com/tutorial/path-params/") and [FastAPI query]("https://fastapi.tiangolo.com/tutorial/query-params/") for more details on how to use path and query parameters in your API endpoints.
+    See [FastAPI path]("https://fastapi.tiangolo.com/tutorial/path-params/") and [FastAPI query]("https://fastapi.tiangolo.com/tutorial/query-params/") for details on path and query parameters in your API endpoints.
 
     Usage:
 
@@ -130,17 +129,13 @@ class BaseApi:
 
     async def on_startup(self):
         """
-        Method to run on startup.
-
-        This will be called by `FastAPIReactToolkit` when the application starts.
+        Called by `FastAPIReactToolkit` when the application starts.
         """
         pass
 
     async def on_shutdown(self):
         """
-        Method to run on shutdown.
-
-        This will be called by `FastAPIReactToolkit` when the application shuts down.
+        Called by `FastAPIReactToolkit` when the application shuts down.
         """
         pass
 

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/__init__.py

@@ -32,11 +32,11 @@ from pydantic import BaseModel, Field
 
 from ...backends.sqla.filters import BaseFilter, BaseOprFilter
 from ...backends.sqla.interface import SQLAInterface
+from ...bases import DBQueryParams
 from ...const import AVAILABLE_ROUTES
 from ...dependencies import current_permissions
 from ...exceptions import HTTPWithValidationException, raise_exception
 from ...lang.lazy_text import translate
-from ...bases import DBQueryParams
 from ...schemas import (
     BaseResponseMany,
     BaseResponseSingle,
@@ -59,13 +59,7 @@ from ._edit_mixin import EditMixin
 from ._file_mixin import FileMixin
 from ._info_mixin import InfoMixin
 from ._list_mixin import ListMixin
-from ._upload_mixin import UploadMixin
 from ._params import (
-    PARAM_BODY_SESSION,
-    PARAM_ID_SESSION,
-    PARAM_ID_SESSION_ITEM,
-    PARAM_IDS_Q_SESSION_ITEMS,
-    PARAM_Q,
     P_BODY,
     P_ID,
     P_IDS,
@@ -73,9 +67,15 @@ from ._params import (
     P_ITEMS,
     P_Q,
     P_SESSION,
+    PARAM_BODY_SESSION,
+    PARAM_ID_SESSION,
+    PARAM_ID_SESSION_ITEM,
+    PARAM_IDS_Q_SESSION_ITEMS,
+    PARAM_Q,
     Params,
 )
 from ._show_mixin import ShowMixin
+from ._upload_mixin import UploadMixin
 
 __all__ = ["ModelRestApi"]
 
@@ -100,9 +100,9 @@ class ModelRestApi(
     """
     Base API class for FastAPI with built-in RESTful endpoints for common data operations.
 
-    This class automatically delivers standard routes for CRUD (Create, Read, Update, Delete),
+    Delivers standard routes for CRUD (Create, Read, Update, Delete),
     file and image management, data download, bulk operations, filtering, and pagination.
-    Each route is extensible with corresponding pre- and post-processing methods, allowing for custom logic
+    Each route is extensible with pre- and post-processing methods for custom logic
     before and after the main operation.
 
     Usage:
@@ -170,11 +170,11 @@ class ModelRestApi(
         ]
     )
     """
-    The list of routes to expose. available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
+    The list of routes to expose. Available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
     """
     exclude_routes: typing.List[AVAILABLE_ROUTES] = lazy(lambda: [])
     """
-    The list of routes to exclude. available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
+    The list of routes to exclude. Available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
     """
     protected_routes: typing.List[AVAILABLE_ROUTES] = lazy(
         lambda self: [x for x in self.routes if x not in self.exclude_protected_routes]
@@ -208,7 +208,9 @@ class ModelRestApi(
     base_order = ("name", "asc")
     ```
     """
-    base_filters: typing.List[typing.Tuple[str, typing.Type[BaseFilter], typing.Any]] | None = None
+    base_filters: (
+        typing.List[typing.Tuple[str, typing.Type[BaseFilter], typing.Any]] | None
+    ) = None
     """
     The default filters to apply for the following endpoints: `download`, `list`, `show`, `add`, and `edit`. Defaults to None.
 
@@ -219,7 +221,9 @@ class ModelRestApi(
     ]
     ```
     """
-    base_opr_filters: typing.List[typing.Tuple[typing.Type[BaseOprFilter], typing.Any]] | None = None
+    base_opr_filters: (
+        typing.List[typing.Tuple[typing.Type[BaseOprFilter], typing.Any]] | None
+    ) = None
     """
     The default opr filters to apply for the following endpoints: `download`, `list`, `show`, `add`, and `edit`. Defaults to None.
 
@@ -471,7 +475,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the list endpoint. If not provided, Defaults to "List {ModelName}".
+    The title for the list endpoint. If not provided, defaults to "List {ModelName}".
     """
     show_title = lazy(
         lambda self: translate(
@@ -480,7 +484,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the show endpoint. If not provided, Defaults to "Show {ModelName}".
+    The title for the show endpoint. If not provided, defaults to "Show {ModelName}".
     """
     add_title = lazy(
         lambda self: translate(
@@ -489,7 +493,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the add endpoint. If not provided, Defaults to "Add {ModelName}".
+    The title for the add endpoint. If not provided, defaults to "Add {ModelName}".
     """
     edit_title = lazy(
         lambda self: translate(
@@ -498,7 +502,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the edit endpoint. If not provided, Defaults to "Edit {ModelName}".
+    The title for the edit endpoint. If not provided, defaults to "Edit {ModelName}".
     """
 
     """
@@ -613,7 +617,7 @@ class ModelRestApi(
 
     extra_list_fetch_columns = lazy(lambda: list[str]())
     """
-    The list of columns to be fetch from the database alongside the `list_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
+    The list of columns to be fetched from the database alongside the `list_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
     """
     list_select_columns = lazy(
         lambda self: self.list_columns + self.extra_list_fetch_columns
@@ -625,7 +629,7 @@ class ModelRestApi(
     """
     extra_show_fetch_columns = lazy(lambda: list[str]())
     """
-    The list of columns to be fetch from the database alongside the `show_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
+    The list of columns to be fetched from the database alongside the `show_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
     """
     show_select_columns = lazy(
         lambda self: self.show_columns + self.extra_show_fetch_columns
@@ -659,7 +663,8 @@ class ModelRestApi(
         | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool]
         | dict[
             str,
-            bool | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool],
+            bool
+            | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool],
         ]
     ) = lazy(lambda: lambda info: len(info.values) > 100)
     """
@@ -700,7 +705,8 @@ class ModelRestApi(
         | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool]
         | dict[
             str,
-            bool | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool],
+            bool
+            | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool],
         ]
     ) = lazy(lambda: lambda info: len(info.values) > 100)
     """
@@ -1172,7 +1178,7 @@ class ModelRestApi(
             filter_classes=self.base_filters,
             opr_filters=q.opr_filters,
             opr_filter_classes=self.base_opr_filters,
-            global_filter=(self.list_columns, q.global_filter)
+            global_filter=(q.columns or self.list_columns, q.global_filter)
             if q.global_filter
             else None,
         )

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_add_mixin.py

@@ -134,8 +134,7 @@ class AddMixin:
         self, item: Model, params: PARAM_BODY_SESSION
     ) -> None | Model | typing.Any:
         """
-        Post-process the item after adding it to the database.
-        But before sending the response.
+        Post-process the item after adding it to the database, before sending the response.
 
         - When a `Model` is returned, it will replace the current `item`.
         - When any other value is returned, it is assumed to be a response to be returned directly.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_bulk_mixin.py

@@ -79,8 +79,7 @@ class BulkMixin:
         session: SQLASession,
     ) -> Response:
         """
-        Bulk handler for the API.
-        To be implemented by the subclass.
+        Bulk handler for the API, to be implemented by the subclass.
 
         Example:
         ```python

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_columns.py

@@ -94,7 +94,9 @@ class ColumnsMixin:
         return re.sub("[._]", " ", name).title()
 
     def _init_filters(
-        self, datamodel: SQLAInterface, filters: typing.List[typing.Tuple[str, typing.Type[BaseFilter], typing.Any]]
+        self,
+        datamodel: SQLAInterface,
+        filters: typing.List[typing.Tuple[str, typing.Type[BaseFilter], typing.Any]],
     ):
         """
         Initialize the filter for the API.
@@ -125,7 +127,7 @@ class ColumnsMixin:
     ):
         """
         Handle the schema extra fields for the API.
-        This will transform the fields into a dictionary with the field name as the key and the field type as the value if the field is not a tuple.
+        Transforms non-tuple fields into a dictionary mapping field name to field type.
 
         Args:
             schema_extra_fields (dict[str, type | tuple[type, pydantic.fields.FieldInfo]]): The schema extra fields to handle.
@@ -181,7 +183,7 @@ class ColumnsMixin:
         name: str | None = None,
     ):
         """
-        Create a request schema based on the provided `schema` parameter. Useful for creating request schemas for add and edit endpoints, as it will transform the relation columns into the appropriate schema.
+        Create a request schema from `schema` for add and edit endpoints, transforming relation columns into the appropriate schema.
 
         Args:
             schema (typing.Type[BaseModel]): The base schema to create the request schema from.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_delete_mixin.py

@@ -61,7 +61,6 @@ class DeleteMixin:
 
         Args:
             id (str): The id of the item.
-            query (QueryManager): The query manager object.
             session (SQLASession): A database scoped session.
 
         Returns:

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_download_mixin.py

@@ -73,7 +73,7 @@ class DownloadMixin:
         Downloads a file in a headless mode.
 
         Args:
-            body (QueryBody): The query body.
+            q (QuerySchema): The query schema.
             session (SQLASession): A database scoped session.
             export_mode (ExportMode): The export mode. Can be "simplified" or "detailed". Defaults to "simplified".
             delimiter (str): The delimiter for the CSV file. Defaults to ",".
@@ -193,11 +193,10 @@ class DownloadMixin:
         quotechar: str = '"',
     ):
         """
-        Import data from CSV format. This will parse the CSV data and resolve any relationships.
+        Import data from CSV format, parsing it and resolving any relationships.
 
         Args:
             data (str | bytes): The CSV data to import.
-            query (QueryManager): The query manager object.
             session (SQLASession): The session object for the database connection.
             delimiter (str, optional): Delimiter for the CSV file. Defaults to ",".
             quotechar (str): Quote character for the CSV file. Defaults to '"'.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_edit_mixin.py

@@ -68,7 +68,7 @@ class EditMixin:
         session: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Updates an item in a headless mode.
+        Updates an item in headless mode.
 
         Args:
             id (str): The id of the item.
@@ -76,7 +76,7 @@ class EditMixin:
             session (SQLASession): A database scoped session.
 
         Returns:
-            add_return_schema: The add return schema.
+            edit_return_schema: The edit return schema.
 
         ### Note:
             If you are overriding this method, make sure to copy all the decorators too.
@@ -159,7 +159,7 @@ class EditMixin:
         Args:
             item (Model): The item that will be updated in the database.
             data (dict[str, typing.Any]): The data to merge with the item.
-            params (PARAM_BODY_QUERY_SESSION): Additional data passed to the handler.
+            params (PARAM_BODY_SESSION): Additional data passed to the handler.
         """
         pass
 
@@ -182,8 +182,7 @@ class EditMixin:
         self, item: Model, params: PARAM_BODY_SESSION
     ) -> None | Model | typing.Any:
         """
-        Post-process the item after updating it in the database.
-        But before sending the response.
+        Post-process the item after updating it in the database, before sending the response.
 
         - When a `Model` is returned, it will replace the current `item`.
         - When any other value is returned, it is assumed to be a response to be returned directly.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_file_mixin.py

@@ -27,9 +27,9 @@ class FileMixin:
 
     def image(self):
         """
-        Image endpoint for the API. Used to retrieve the image from the application.
+        Image endpoint for the API.
 
-        This endpoint is only available if the model has image columns.
+        Only available if the model has image columns.
         """
         if not self.datamodel.get_image_column_list():
             return
@@ -50,9 +50,9 @@ class FileMixin:
 
     def file(self):
         """
-        File endpoint for the API. Used to retrieve the file from the application.
+        File endpoint for the API.
 
-        This endpoint is only available if the model has file columns.
+        Only available if the model has file columns.
         """
         if not self.datamodel.get_file_column_list():
             return
@@ -73,7 +73,7 @@ class FileMixin:
 
     async def image_headless(self, filename: str):
         """
-        Retrieves an image based on the filename.
+        Retrieves an image by filename.
         """
         async with AsyncTaskRunner():
             pre_image = await smart_run(self.pre_image, filename)
@@ -91,7 +91,7 @@ class FileMixin:
 
     async def file_headless(self, filename: str):
         """
-        Retrieves a file based on the filename.
+        Retrieves a file by filename.
         """
         async with AsyncTaskRunner():
             pre_file = await smart_run(self.pre_file, filename)

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_info_mixin.py

@@ -48,9 +48,7 @@ class InfoMixin:
         add_obj_schema: typing.Type[BaseModel]
         add_jsonforms_use_enum: (
             bool
-            | typing.Callable[
-                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool
-            ]
+            | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool]
             | dict[
                 str,
                 bool
@@ -64,9 +62,7 @@ class InfoMixin:
         edit_obj_schema: typing.Type[BaseModel]
         edit_jsonforms_use_enum: (
             bool
-            | typing.Callable[
-                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool
-            ]
+            | typing.Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool]
             | dict[
                 str,
                 bool
@@ -104,7 +100,7 @@ class InfoMixin:
         session_count: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Retrieves information in a headless mode.
+        Retrieves information in headless mode.
 
         Args:
             permissions (typing.List[str]): A list of permissions.
@@ -155,7 +151,7 @@ class InfoMixin:
         session_count: SQLASession,
     ):
         """
-        Generates the information schema for the API based on the given permissions and database session.
+        Generates the information schema for the API.
 
         Args:
             permissions (typing.List[str]): The list of permissions for the API.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_list_mixin.py

@@ -54,7 +54,7 @@ class ListMixin:
         ] = SelfDepends().get_q_and_session_count_factory,
     ):
         """
-        Retrieves all items in a headless mode.
+        Retrieves all items in headless mode.
 
         Args:
             session (SQLASession): A database scoped session.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_show_mixin.py

@@ -61,7 +61,7 @@ class ShowMixin:
         session: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Retrieves a single item in a headless mode.
+        Retrieves a single item in headless mode.
 
         Args:
             id (str): The id of the item.

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_upload_mixin.py

@@ -2,9 +2,9 @@
 Upload route mixin for ``ModelRestApi``.
 
 The ``upload`` registration and ``upload_headless`` implementation are
-disabled (commented out) until further notice. The mixin is wired into
-``ModelRestApi`` so the route can be re-enabled by uncommenting the
-blocks below without further plumbing.
+disabled (commented out) until further notice. The mixin stays wired into
+``ModelRestApi`` so the route can be re-enabled by uncommenting the blocks
+below.
 """
 
 

{fastapi_rtk-2.1.3 → fastapi_rtk-2.1.5}/fastapi_rtk/apis/license.py

@@ -16,7 +16,7 @@ from ..utils import lazy, prettify_dict
 
 
 class LicenseParserError(Exception):
-    """Custom exception for license parser errors."""
+    """Raised on license parsing failures."""
 
     def __init__(
         self, data: typing.Any, message: str = "Error processing license data"