fastapi-rtk 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

fastapi_rtk/api/model_rest_api.py

@@ -206,6 +206,19 @@ class ModelRestApi(BaseApi):
     """
     The list of routes to exclude from protection. Defaults to `[]`.
     """
+    expose_params: dict[AVAILABLE_ROUTES, dict[str, Any]] = lazy(lambda: dict())
+    """
+    Additional parameters to pass to the `expose` decorator for each route. See `expose` decorator for more information.
+
+    Example:
+    ```python
+    expose_params = {
+        'image': {
+            'description': 'Custom description for image endpoint',
+        },
+    }
+    ```
+    """
     base_order: Tuple[str, Literal["asc", "desc"]] | None = None
     """
     The default order for the list endpoint. Set this to set the default order for the list endpoint.
@@ -1040,12 +1053,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/_image/{filename}",
             methods=["GET"],
-            name="Get Image",
-            description="Get an image from the application.",
-            response_class=FileResponse,
-            dependencies=[Depends(has_access_dependency(self, "image"))]
-            if "image" in self.protected_routes
-            else None,
+            **{
+                "name": "Get Image",
+                "description": f"Get an image associated with an existing {self.datamodel.obj.__name__} item.",
+                "response_class": FileResponse,
+                "dependencies": [Depends(has_access_dependency(self, "image"))]
+                if "image" in self.protected_routes
+                else None,
+                **self.expose_params.get("image", {}),
+            },
         )(self.image_headless)
 
     def file(self):
@@ -1062,12 +1078,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/_file/{filename}",
             methods=["GET"],
-            name="Get File",
-            description="Get a file from the application.",
-            response_class=FileResponse,
-            dependencies=[Depends(has_access_dependency(self, "file"))]
-            if "file" in self.protected_routes
-            else None,
+            **{
+                "name": "Get File",
+                "description": f"Get a file associated with an existing {self.datamodel.obj.__name__} item.",
+                "response_class": FileResponse,
+                "dependencies": [Depends(has_access_dependency(self, "file"))]
+                if "file" in self.protected_routes
+                else None,
+                **self.expose_params.get("file", {}),
+            },
         )(self.file_headless)
 
     def info(self):
@@ -1079,12 +1098,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/_info",
             methods=["GET"],
-            name="Get Info",
-            description="Get the info for this API's Model.",
-            response_model=self.info_return_schema | typing.Any,
-            dependencies=[Depends(has_access_dependency(self, "info"))]
-            if "info" in self.protected_routes
-            else None,
+            **{
+                "name": "Get Info",
+                "description": f"Get metadata information about the model {self.datamodel.obj.__name__}. such as add/edit columns, filter options, titles, and JSONForms schemas.",
+                "response_model": self.info_return_schema | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "info"))]
+                if "info" in self.protected_routes
+                else None,
+                **self.expose_params.get("info", {}),
+            },
         )(self.info_headless)
 
     def download(self):
@@ -1096,11 +1118,14 @@ class ModelRestApi(BaseApi):
         expose(
             "/download",
             methods=["GET"],
-            name="Download",
-            description="Download list of items in CSV format.",
-            dependencies=[Depends(has_access_dependency(self, "download"))]
-            if "download" in self.protected_routes
-            else None,
+            **{
+                "name": "Download",
+                "description": f"Download list of {self.datamodel.obj.__name__} items as a CSV file with support for filtering, ordering, and global search.",
+                "dependencies": [Depends(has_access_dependency(self, "download"))]
+                if "download" in self.protected_routes
+                else None,
+                **self.expose_params.get("download", {}),
+            },
         )(self.download_headless)
 
     #! Disabled until further notice
@@ -1127,11 +1152,14 @@ class ModelRestApi(BaseApi):
         expose(
             "/bulk/{handler}",
             methods=["POST"],
-            name="Bulk",
-            description="Handle bulk operations.",
-            dependencies=[Depends(has_access_dependency(self, "bulk"))]
-            if "bulk" in self.protected_routes
-            else None,
+            **{
+                "name": "Bulk",
+                "description": f"Handle bulk operations for the model {self.datamodel.obj.__name__} that are set in the API.",
+                "dependencies": [Depends(has_access_dependency(self, "bulk"))]
+                if "bulk" in self.protected_routes
+                else None,
+                **self.expose_params.get("bulk", {}),
+            },
         )(self.bulk_headless)
 
     def get_list(self):
@@ -1143,12 +1171,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/",
             methods=["GET"],
-            name="Get items",
-            description="Get a list of items.",
-            response_model=self.list_return_schema | typing.Any,
-            dependencies=[Depends(has_access_dependency(self, "get"))]
-            if "get_list" in self.protected_routes
-            else None,
+            **{
+                "name": "Get items",
+                "description": f"Get a list of {self.datamodel.obj.__name__} items with support for column selection, filtering, ordering, pagination, and global search.",
+                "response_model": self.list_return_schema | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "get"))]
+                if "get_list" in self.protected_routes
+                else None,
+                **self.expose_params.get("get_list", {}),
+            },
         )(self.get_list_headless)
 
     def get(self):
@@ -1160,12 +1191,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/{id}",
             methods=["GET"],
-            name="Get item",
-            description="Get a single item.",
-            response_model=self.show_return_schema | typing.Any,
-            dependencies=[Depends(has_access_dependency(self, "get"))]
-            if "get" in self.protected_routes
-            else None,
+            **{
+                "name": "Get item",
+                "description": f"Get a single {self.datamodel.obj.__name__} item.",
+                "response_model": self.show_return_schema | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "get"))]
+                if "get" in self.protected_routes
+                else None,
+                **self.expose_params.get("get", {}),
+            },
         )(self.get_headless)
 
     def post(self):
@@ -1177,12 +1211,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/",
             methods=["POST"],
-            name="Add item",
-            description="Add a new item.",
-            response_model=self.add_return_schema | typing.Any,
-            dependencies=[Depends(has_access_dependency(self, "post"))]
-            if "post" in self.protected_routes
-            else None,
+            **{
+                "name": "Add item",
+                "description": f"Add a new {self.datamodel.obj.__name__} item.",
+                "response_model": self.add_return_schema | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "post"))]
+                if "post" in self.protected_routes
+                else None,
+                **self.expose_params.get("post", {}),
+            },
         )(self.post_headless)
 
     def put(self):
@@ -1194,12 +1231,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/{id}",
             methods=["PUT"],
-            name="Update item",
-            description="Update an item.",
-            response_model=self.edit_return_schema | typing.Any,
-            dependencies=[Depends(has_access_dependency(self, "put"))]
-            if "put" in self.protected_routes
-            else None,
+            **{
+                "name": "Update item",
+                "description": f"Update an existing {self.datamodel.obj.__name__} item.",
+                "response_model": self.edit_return_schema | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "put"))]
+                if "put" in self.protected_routes
+                else None,
+                **self.expose_params.get("put", {}),
+            },
         )(self.put_headless)
 
     def delete(self):
@@ -1211,12 +1251,15 @@ class ModelRestApi(BaseApi):
         expose(
             "/{id}",
             methods=["DELETE"],
-            response_model=GeneralResponse | typing.Any,
-            name="Delete item",
-            description="Delete an item.",
-            dependencies=[Depends(has_access_dependency(self, "delete"))]
-            if "delete" in self.protected_routes
-            else None,
+            **{
+                "name": "Delete item",
+                "description": f"Delete an existing {self.datamodel.obj.__name__} item.",
+                "response_model": GeneralResponse | typing.Any,
+                "dependencies": [Depends(has_access_dependency(self, "delete"))]
+                if "delete" in self.protected_routes
+                else None,
+                **self.expose_params.get("delete", {}),
+            },
         )(self.delete_headless)
 
     """

fastapi_rtk/manager.py

@@ -500,6 +500,7 @@ class UserManager(IDParser, BaseUserManager[User, int]):
                 # Associate account
                 user = await self.get_by_email(account_email)
                 if not associate_by_email:
+                    await self.on_after_authenticate(user, False)
                     raise exceptions.UserAlreadyExists()
                 user = await self.user_db.add_oauth_account(user, oauth_account_dict)
             except exceptions.UserNotExists:
@@ -557,6 +558,7 @@ class UserManager(IDParser, BaseUserManager[User, int]):
             user = await self._handle_role_keys(
                 user, oauth_callback_params["user_dict"].pop("role_keys", None)
             )
+        await self.on_after_authenticate(user)
         return user
 
     @overload

{fastapi_rtk-1.0.0.dist-info → fastapi_rtk-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 1.0.0
+Version: 1.0.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-1.0.0.dist-info → fastapi_rtk-1.0.1.dist-info}/RECORD

@@ -9,7 +9,7 @@ fastapi_rtk/exceptions.py,sha256=P0qwd4VkeWFotgMVQHgmdT1NphFQaEznKLFIvJzW4Zs,259
 fastapi_rtk/fastapi_react_toolkit.py,sha256=gDqHq7Bk90LTZm6muOlqBbiFtOMR8xMOxa9edm8ad8w,31891
 fastapi_rtk/filters.py,sha256=weCH3suCxpGJQYmwhj9D1iAqMPiRnmbRiN7stK0rhoE,181
 fastapi_rtk/globals.py,sha256=TcoMHCueM7sFwZ8iYorUe4q-3KpVFfV04RAPuMTYFKY,8863
-fastapi_rtk/manager.py,sha256=qZmOgVNt8oGQnB36hgUFk4hSo_u685eAvwXUBT9j3Fg,33852
+fastapi_rtk/manager.py,sha256=J86sBByj6E1kZ3CRS0NayI0n5firrfMhAU2d58mz0JM,33965
 fastapi_rtk/middlewares.py,sha256=ycdaAdLIUaNEZ7KotczTHS6OOqy98Mn1_O7Hpe7Sma8,10325
 fastapi_rtk/mixins.py,sha256=78RqwrRJFOz6KAxf-GSNOmRdr7R3b-ws7OIENYlzRQQ,238
 fastapi_rtk/models.py,sha256=lQSqe-r0H7jWBVdqXjEi_bNL1cGQr0YWnyI1ToS_coc,178
@@ -20,7 +20,7 @@ fastapi_rtk/types.py,sha256=-LPnTIbHvqJW81__gab3EWrhjNmznHhptz0BtXkEAHQ,3612
 fastapi_rtk/version.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
 fastapi_rtk/api/__init__.py,sha256=MwFR7HHppnhbjZGg3sOdQ6nqy9uxnHHXvicpswNFMNA,245
 fastapi_rtk/api/base_api.py,sha256=42I9v3b25lqxNAMDGEtajA5-btIDSyUWF0xMDgGkA8c,8078
-fastapi_rtk/api/model_rest_api.py,sha256=y-X1VTuTQXc5sQUx6xdiUL2iqAnEcOHzMHtJyprh5Qg,102871
+fastapi_rtk/api/model_rest_api.py,sha256=Hp6ws1CjLG-2e-yHxniIudUUmnKff9js2VVZ4Q5JMoo,105111
 fastapi_rtk/auth/__init__.py,sha256=iX7O41NivBYDfdomEaqm4lUx9KD17wI4g3EFLF6kUTw,336
 fastapi_rtk/auth/auth.py,sha256=MZmuueioiMbSHjd_F3frKEqCA3yjtanRWyKOy6CnOd0,20994
 fastapi_rtk/auth/hashers/__init__.py,sha256=uBThFj2VPPSMSioxYTktNiM4-mVgtDAjTpKA3ZzWxxs,110
@@ -122,8 +122,8 @@ fastapi_rtk/utils/timezone.py,sha256=62S0pPWuDFFXxV1YTFCsc4uKiSP_Ba36Fv7S3gYjfhs
 fastapi_rtk/utils/update_signature.py,sha256=PIzZgNpGEwvDNgQ3G51Zi-QhVV3mbxvUvSwDwf_-yYs,2209
 fastapi_rtk/utils/use_default_when_none.py,sha256=H2HqhKy_8eYk3i1xijEjuaKak0oWkMIkrdz6T7DK9QU,469
 fastapi_rtk/utils/werkzeug.py,sha256=1Gv-oyqSmhVGrmNbB9fDqpqJzPpANOzWf4zMMrhW9UA,3245
-fastapi_rtk-1.0.0.dist-info/METADATA,sha256=grC-hA6CC_63TNYgS07mx9YlGdOow1jirtraHPFz30A,1270
-fastapi_rtk-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fastapi_rtk-1.0.0.dist-info/entry_points.txt,sha256=UuTkxSVIokSlVN28TMhoxzRRUaPxlVRSH3Gsx6yip60,53
-fastapi_rtk-1.0.0.dist-info/licenses/LICENSE,sha256=NDrWi4Qwcxal3u1r2lBWGA6TVh3OeW7yMan098mQz98,1073
-fastapi_rtk-1.0.0.dist-info/RECORD,,
+fastapi_rtk-1.0.1.dist-info/METADATA,sha256=Nar7z0i7UfidWgYcijllpGWUaKUxYAhFbIy0l0hCvyA,1270
+fastapi_rtk-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_rtk-1.0.1.dist-info/entry_points.txt,sha256=UuTkxSVIokSlVN28TMhoxzRRUaPxlVRSH3Gsx6yip60,53
+fastapi_rtk-1.0.1.dist-info/licenses/LICENSE,sha256=NDrWi4Qwcxal3u1r2lBWGA6TVh3OeW7yMan098mQz98,1073
+fastapi_rtk-1.0.1.dist-info/RECORD,,