fix interfaces, upgrade example

Author: mahenzon

docs/data_layer.rst

@@ -9,10 +9,6 @@ Data layer
 |
 | FastAPI-JSONAPI has a full-featured data layer that uses the popular ORM `SQLAlchemy <https://www.sqlalchemy.org/>`_.
 
-.. note::
-
-    The default data layer used by a resource manager is the SQLAlchemy one. So if that's what you want to use, you don't have to specify the class of the data layer in the resource manager
-
 To configure the data layer you have to set its required parameters in the resource manager.
 
 Example:

docs/python_snippets/data_layer/custom_data_layer.py

@@ -2,13 +2,23 @@
 
 from fastapi_jsonapi import RoutersJSONAPI
 from fastapi_jsonapi.data_layers.base import BaseDataLayer
+from fastapi_jsonapi.data_layers.sqla_orm import SqlalchemyDataLayer
 from fastapi_jsonapi.views.detail_view import DetailViewBase
 from fastapi_jsonapi.views.list_view import ListViewBase
 
 
 class MyCustomDataLayer(BaseDataLayer):
     """Overload abstract methods here"""
 
+    ...
+
+
+class MyCustomSqlaDataLayer(SqlalchemyDataLayer):
+    """Overload any methods here"""
+
+    async def before_delete_objects(self, objects: list, view_kwargs: dict):
+        raise Exception("not allowed to delete objects")
+
 
 class UserDetailView(DetailViewBase):
     data_layer_cls = MyCustomDataLayer

fastapi_jsonapi/data_layers/base.py

@@ -5,7 +5,7 @@
 """
 
 import types
-from typing import Optional, Tuple, Type
+from typing import List, Optional, Tuple, Type
 
 from fastapi_jsonapi.data_typing import TypeModel, TypeSchema
 from fastapi_jsonapi.querystring import QueryStringManager
@@ -242,7 +242,7 @@ def query(self, view_kwargs):
         """
         raise NotImplementedError
 
-    def before_create_object(self, data, view_kwargs):
+    async def before_create_object(self, data, view_kwargs):
         """
         Provide additional data before object creation
 
@@ -251,7 +251,7 @@ def before_create_object(self, data, view_kwargs):
         """
         raise NotImplementedError
 
-    def after_create_object(self, obj, data, view_kwargs):
+    async def after_create_object(self, obj, data, view_kwargs):
         """
         Provide additional data after object creation
 
@@ -307,7 +307,7 @@ async def before_update_object(self, obj, data, view_kwargs):
         """
         raise NotImplementedError
 
-    def after_update_object(self, obj, data, view_kwargs):
+    async def after_update_object(self, obj: TypeModel, data, view_kwargs):
         """
         Make work after update object
 
@@ -317,7 +317,7 @@ def after_update_object(self, obj, data, view_kwargs):
         """
         raise NotImplementedError
 
-    def before_delete_object(self, obj, view_kwargs):
+    async def before_delete_object(self, obj: TypeModel, view_kwargs):
         """
         Make checks before delete object
 
@@ -326,7 +326,7 @@ def before_delete_object(self, obj, view_kwargs):
         """
         raise NotImplementedError
 
-    def after_delete_object(self, obj, view_kwargs):
+    async def after_delete_object(self, obj: TypeModel, view_kwargs):
         """
         Make work after delete object
 
@@ -335,11 +335,29 @@ def after_delete_object(self, obj, view_kwargs):
         """
         raise NotImplementedError
 
-    def delete_objects(self, objects, view_kwargs):
+    async def delete_objects(self, objects: List[TypeModel], view_kwargs):
         # TODO: doc
         raise NotImplementedError
 
-    def before_create_relationship(
+    async def before_delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
+        """
+        Make checks before deleting objects.
+
+        :param objects: an object from data layer.
+        :param view_kwargs: kwargs from the resource view.
+        """
+        pass
+
+    async def after_delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
+        """
+        Any action after deleting objects.
+
+        :param objects: an object from data layer.
+        :param view_kwargs: kwargs from the resource view.
+        """
+        pass
+
+    async def before_create_relationship(
         self,
         json_data,
         relationship_field,
@@ -357,7 +375,7 @@ def before_create_relationship(
         """
         raise NotImplementedError
 
-    def after_create_relationship(
+    async def after_create_relationship(
         self,
         obj,
         updated,
@@ -419,7 +437,7 @@ async def after_get_relationship(
         """
         raise NotImplementedError
 
-    def before_update_relationship(
+    async def before_update_relationship(
         self,
         json_data,
         relationship_field,
@@ -437,7 +455,7 @@ def before_update_relationship(
         """
         raise NotImplementedError
 
-    def after_update_relationship(
+    async def after_update_relationship(
         self,
         obj,
         updated,
@@ -459,7 +477,7 @@ def after_update_relationship(
         """
         raise NotImplementedError
 
-    def before_delete_relationship(
+    async def before_delete_relationship(
         self,
         json_data,
         relationship_field,
@@ -476,7 +494,7 @@ def before_delete_relationship(
         """
         raise NotImplementedError
 
-    def after_delete_relationship(
+    async def after_delete_relationship(
         self,
         obj,
         updated,

fastapi_jsonapi/data_layers/sqla_orm.py

@@ -353,6 +353,7 @@ async def delete_object(self, obj: TypeModel, view_kwargs: dict):
         :param obj: an item from sqlalchemy.
         :param view_kwargs: kwargs from the resource view.
         """
+        await self.before_delete_object(obj, view_kwargs)
         try:
             await self.session.delete(obj)
             await self.session.commit()
@@ -367,7 +368,10 @@ async def delete_object(self, obj: TypeModel, view_kwargs: dict):
                 pointer="/data",
             )
 
+        await self.after_delete_object(obj, view_kwargs)
+
     async def delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
+        await self.before_delete_objects(objects, view_kwargs)
         query = delete(self.model).filter(self.model.id.in_((obj.id for obj in objects)))
 
         try:
@@ -379,6 +383,8 @@ async def delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
                 detail=f"Got an error {e.__class__.__name__} during delete data from DB: {e!s}",
             )
 
+        await self.after_delete_objects(objects, view_kwargs)
+
     async def create_relationship(
         self,
         json_data: dict,
@@ -729,7 +735,7 @@ async def after_update_object(self, obj: Any, model_kwargs: dict, view_kwargs: d
         """
         pass
 
-    def before_delete_object(self, obj: Any, view_kwargs: dict):
+    async def before_delete_object(self, obj: TypeModel, view_kwargs: dict):
         """
         Make checks before delete object.
 
@@ -738,7 +744,7 @@ def before_delete_object(self, obj: Any, view_kwargs: dict):
         """
         pass
 
-    def after_delete_object(self, obj: Any, view_kwargs: dict):
+    async def after_delete_object(self, obj: TypeModel, view_kwargs: dict):
         """
         Make work after delete object.
 
@@ -747,7 +753,25 @@ def after_delete_object(self, obj: Any, view_kwargs: dict):
         """
         pass
 
-    def before_create_relationship(
+    async def before_delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
+        """
+        Make checks before deleting objects.
+
+        :param objects: an object from data layer.
+        :param view_kwargs: kwargs from the resource view.
+        """
+        pass
+
+    async def after_delete_objects(self, objects: List[TypeModel], view_kwargs: dict):
+        """
+        Any actions after deleting objects.
+
+        :param objects: an object from data layer.
+        :param view_kwargs: kwargs from the resource view.
+        """
+        pass
+
+    async def before_create_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -765,7 +789,7 @@ def before_create_relationship(
         """
         pass
 
-    def after_create_relationship(
+    async def after_create_relationship(
         self,
         obj: Any,
         updated: bool,
@@ -827,7 +851,7 @@ async def after_get_relationship(
         """
         pass
 
-    def before_update_relationship(
+    async def before_update_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -845,7 +869,7 @@ def before_update_relationship(
         """
         pass
 
-    def after_update_relationship(
+    async def after_update_relationship(
         self,
         obj: Any,
         updated: bool,
@@ -867,7 +891,7 @@ def after_update_relationship(
         """
         pass
 
-    def before_delete_relationship(
+    async def before_delete_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -884,7 +908,7 @@ def before_delete_relationship(
         """
         pass
 
-    def after_delete_relationship(
+    async def after_delete_relationship(
         self,
         obj: Any,
         updated: bool,

fastapi_jsonapi/data_layers/tortoise_orm.py

@@ -1,6 +1,6 @@
 """This module is a CRUD interface between resource managers and the Tortoise ORM"""
 
-from typing import Any, Iterable, List, Optional, Tuple, Type
+from typing import Any, Iterable, Optional, Tuple, Type
 
 from tortoise.queryset import QuerySet
 
@@ -124,7 +124,7 @@ async def update_object(
         :return: True if object have changed else False.
         """
 
-    async def delete_object(self, objects: List[TypeModel], view_kwargs: dict):
+    async def delete_object(self, obj: TypeModel, view_kwargs: dict):
         """
         Delete an object through Tortoise.
 
@@ -263,15 +263,15 @@ def query(self, view_kwargs: dict) -> QuerySet:
         """
         return self.query_
 
-    def before_create_object(self, data: dict, view_kwargs: dict):
+    async def before_create_object(self, data: dict, view_kwargs: dict):
         """
         Provide additional data before object creation.
 
         :param data: the data validated by pydantic.
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def after_create_object(self, obj: Any, data: dict, view_kwargs: dict):
+    async def after_create_object(self, obj: Any, data: dict, view_kwargs: dict):
         """
         Provide additional data after object creation.
 
@@ -322,7 +322,7 @@ async def before_update_object(self, obj: Any, data: dict, view_kwargs: dict):
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def after_update_object(self, obj: Any, data: dict, view_kwargs: dict):
+    async def after_update_object(self, obj: Any, data: dict, view_kwargs: dict):
         """
         Make work after update object.
 
@@ -331,23 +331,23 @@ def after_update_object(self, obj: Any, data: dict, view_kwargs: dict):
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def before_delete_object(self, obj: Any, view_kwargs: dict):
+    async def before_delete_object(self, obj: Any, view_kwargs: dict):
         """
         Make checks before delete object.
 
         :param obj: an object from data layer.
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def after_delete_object(self, obj: Any, view_kwargs: dict):
+    async def after_delete_object(self, obj: Any, view_kwargs: dict):
         """
         Make work after delete object.
 
         :param obj: an object from data layer.
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def before_create_relationship(
+    async def before_create_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -364,7 +364,7 @@ def before_create_relationship(
         :return boolean: True if relationship have changed else False.
         """
 
-    def after_create_relationship(
+    async def after_create_relationship(
         self,
         obj: Any,
         updated: bool,
@@ -423,7 +423,7 @@ async def after_get_relationship(
         :return tuple: the object and related object(s).
         """
 
-    def before_update_relationship(
+    async def before_update_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -440,7 +440,7 @@ def before_update_relationship(
         :return boolean: True if relationship have changed else False.
         """
 
-    def after_update_relationship(
+    async def after_update_relationship(
         self,
         obj: Any,
         updated: bool,
@@ -461,7 +461,7 @@ def after_update_relationship(
         :return boolean: True if relationship have changed else False.
         """
 
-    def before_delete_relationship(
+    async def before_delete_relationship(
         self,
         json_data: dict,
         relationship_field: str,
@@ -477,7 +477,7 @@ def before_delete_relationship(
         :param view_kwargs: kwargs from the resource view.
         """
 
-    def after_delete_relationship(
+    async def after_delete_relationship(
         self,
         obj: Any,
         updated: bool,