panther 5.0.0b4__tar.gz → 5.0.0b5__tar.gz

panther-5.0.0b5/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: panther
+Version: 5.0.0b5
+Summary: Fast & Friendly, Web Framework For Building Async APIs
+Home-page: https://github.com/alirn76/panther
+Author: Ali RajabNezhad
+Author-email: alirn76@yahoo.com
+License: BSD-3-Clause license
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pantherdb~=2.3.0
+Requires-Dist: orjson~=3.9.15
+Requires-Dist: pydantic~=2.10.6
+Requires-Dist: rich~=13.9.4
+Requires-Dist: uvicorn~=0.34.0
+Requires-Dist: pytz~=2025.2
+Requires-Dist: Jinja2~=3.1
+Requires-Dist: simple-ulid~=1.0.0
+Requires-Dist: httptools~=0.6.4
+Provides-Extra: full
+Requires-Dist: redis==5.2.1; extra == "full"
+Requires-Dist: motor~=3.7.0; extra == "full"
+Requires-Dist: ipython~=9.0.2; extra == "full"
+Requires-Dist: python-jose~=3.4.0; extra == "full"
+Requires-Dist: ruff~=0.11.2; extra == "full"
+Requires-Dist: websockets~=15.0.1; extra == "full"
+Requires-Dist: cryptography~=44.0.2; extra == "full"
+Requires-Dist: watchfiles~=1.0.4; extra == "full"
+Provides-Extra: dev
+Requires-Dist: ruff~=0.11.2; extra == "dev"
+Requires-Dist: pytest~=8.3.5; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+[![PyPI](https://img.shields.io/pypi/v/panther?label=PyPI)](https://pypi.org/project/panther/) [![PyVersion](https://img.shields.io/pypi/pyversions/panther.svg)](https://pypi.org/project/panther/) [![codecov](https://codecov.io/github/AliRn76/panther/graph/badge.svg?token=YWFQA43GSP)](https://codecov.io/github/AliRn76/panther) [![Downloads](https://static.pepy.tech/badge/panther/month)](https://pepy.tech/project/panther) [![license](https://img.shields.io/github/license/alirn76/panther.svg)](https://github.com/alirn76/panther/blob/main/LICENSE)
+
+<div align="center">
+  <img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="Panther Logo" width="450">
+  
+  # Panther 
+  
+  **A Fast & Friendly Web Framework for Building Async APIs with Python 3.10+**
+  
+  [📚 Documentation](https://pantherpy.github.io)
+</div>
+
+---
+
+## 🐾 Why Choose Panther?
+
+Panther is designed to be **fast**, **simple**, and **powerful**. Here's what makes it special:
+
+- **One of the fastest Python frameworks** available ([Benchmark](https://www.techempower.com/benchmarks/#section=data-r23&l=zijzen-pa7&c=4))
+- **File-based database** ([PantherDB](https://pypi.org/project/pantherdb/)) - No external database setup required
+- **Document-oriented ODM** - Supports MongoDB & PantherDB with familiar syntax
+- **API caching system** - In-memory and Redis support
+- **OpenAPI/Swagger** - Auto-generated API documentation
+- **WebSocket support** - Real-time communication out of the box
+- **Authentication & Permissions** - Built-in security features
+- **Background tasks** - Handle long-running operations
+- **Middleware & Throttling** - Extensible and configurable
+
+---
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install panther
+```
+
+- Create a `main.py` file with one of the examples below.
+
+### Your First API
+
+Here's a simple REST API endpoint that returns a "Hello World" message:
+
+```python
+from datetime import datetime, timedelta
+from panther import status, Panther
+from panther.app import GenericAPI
+from panther.openapi.urls import url_routing as openapi_url_routing
+from panther.response import Response
+
+class HelloAPI(GenericAPI):
+    # Cache responses for 10 seconds
+    cache = timedelta(seconds=10)
+    
+    def get(self):
+        current_time = datetime.now().isoformat()
+        return Response(
+            data={'message': f'Hello from Panther! 🐾 | {current_time}'},
+            status_code=status.HTTP_200_OK
+        )
+
+# URL routing configuration
+url_routing = {
+    '/': HelloAPI,
+    'swagger/': openapi_url_routing,  # Auto-generated API docs
+}
+
+# Create your Panther app
+app = Panther(__name__, configs=__name__, urls=url_routing)
+```
+
+### WebSocket Echo Server
+
+Here's a simple WebSocket echo server that sends back any message it receives:
+
+```python
+from panther import Panther
+from panther.app import GenericAPI
+from panther.response import HTMLResponse
+from panther.websocket import GenericWebsocket
+
+class EchoWebsocket(GenericWebsocket):
+    async def connect(self, **kwargs):
+        await self.accept()
+        await self.send("Connected to Panther WebSocket!")
+    
+    async def receive(self, data: str | bytes):
+        # Echo back the received message
+        await self.send(f"Echo: {data}")
+
+class WebSocketPage(GenericAPI):
+    def get(self):
+        template = """
+        <h2>🐾 Panther WebSocket Echo Server</h2>
+        <input id="msg"><button onclick="s.send(msg.value)">Send</button>
+        <ul id="log"></ul>
+        <script>
+            const s = new WebSocket('ws://127.0.0.1:8000/ws');
+            s.onmessage = e => log.innerHTML += `<li><- ${msg.value}</li><li>-> ${e.data}</li>`;
+        </script>
+        """
+        return HTMLResponse(template)
+
+url_routing = {
+    '': WebSocketPage,
+    'ws': EchoWebsocket,
+}
+app = Panther(__name__, configs=__name__, urls=url_routing)
+```
+
+### Run Your Application
+
+1. **Start the development server**
+   ```shell
+   $ panther run main:app
+   ```
+   
+2. **Test your application**
+    - For the _API_ example: Visit [http://127.0.0.1:8000/](http://127.0.0.1:8000/) to see the "Hello World" response
+    - For the _WebSocket_ example: Visit [http://127.0.0.1:8000/](http://127.0.0.1:8000/) and send a message.
+
+---
+
+## 🙏 Acknowledgments
+
+<div align="center">
+  <p>Supported by</p>
+  <a href="https://drive.google.com/file/d/17xe1hicIiRF7SQ-clg9SETdc19SktCbV/view?usp=sharing">
+    <img alt="JetBrains" src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/jb_beam_50x50.png">
+  </a>
+</div>
+
+---
+
+<div align="center">
+  <p>⭐️ If you find Panther useful, please give it a star!</p>
+</div>

panther-5.0.0b5/README.md

@@ -0,0 +1,138 @@
+[![PyPI](https://img.shields.io/pypi/v/panther?label=PyPI)](https://pypi.org/project/panther/) [![PyVersion](https://img.shields.io/pypi/pyversions/panther.svg)](https://pypi.org/project/panther/) [![codecov](https://codecov.io/github/AliRn76/panther/graph/badge.svg?token=YWFQA43GSP)](https://codecov.io/github/AliRn76/panther) [![Downloads](https://static.pepy.tech/badge/panther/month)](https://pepy.tech/project/panther) [![license](https://img.shields.io/github/license/alirn76/panther.svg)](https://github.com/alirn76/panther/blob/main/LICENSE)
+
+<div align="center">
+  <img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="Panther Logo" width="450">
+  
+  # Panther 
+  
+  **A Fast & Friendly Web Framework for Building Async APIs with Python 3.10+**
+  
+  [📚 Documentation](https://pantherpy.github.io)
+</div>
+
+---
+
+## 🐾 Why Choose Panther?
+
+Panther is designed to be **fast**, **simple**, and **powerful**. Here's what makes it special:
+
+- **One of the fastest Python frameworks** available ([Benchmark](https://www.techempower.com/benchmarks/#section=data-r23&l=zijzen-pa7&c=4))
+- **File-based database** ([PantherDB](https://pypi.org/project/pantherdb/)) - No external database setup required
+- **Document-oriented ODM** - Supports MongoDB & PantherDB with familiar syntax
+- **API caching system** - In-memory and Redis support
+- **OpenAPI/Swagger** - Auto-generated API documentation
+- **WebSocket support** - Real-time communication out of the box
+- **Authentication & Permissions** - Built-in security features
+- **Background tasks** - Handle long-running operations
+- **Middleware & Throttling** - Extensible and configurable
+
+---
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install panther
+```
+
+- Create a `main.py` file with one of the examples below.
+
+### Your First API
+
+Here's a simple REST API endpoint that returns a "Hello World" message:
+
+```python
+from datetime import datetime, timedelta
+from panther import status, Panther
+from panther.app import GenericAPI
+from panther.openapi.urls import url_routing as openapi_url_routing
+from panther.response import Response
+
+class HelloAPI(GenericAPI):
+    # Cache responses for 10 seconds
+    cache = timedelta(seconds=10)
+    
+    def get(self):
+        current_time = datetime.now().isoformat()
+        return Response(
+            data={'message': f'Hello from Panther! 🐾 | {current_time}'},
+            status_code=status.HTTP_200_OK
+        )
+
+# URL routing configuration
+url_routing = {
+    '/': HelloAPI,
+    'swagger/': openapi_url_routing,  # Auto-generated API docs
+}
+
+# Create your Panther app
+app = Panther(__name__, configs=__name__, urls=url_routing)
+```
+
+### WebSocket Echo Server
+
+Here's a simple WebSocket echo server that sends back any message it receives:
+
+```python
+from panther import Panther
+from panther.app import GenericAPI
+from panther.response import HTMLResponse
+from panther.websocket import GenericWebsocket
+
+class EchoWebsocket(GenericWebsocket):
+    async def connect(self, **kwargs):
+        await self.accept()
+        await self.send("Connected to Panther WebSocket!")
+    
+    async def receive(self, data: str | bytes):
+        # Echo back the received message
+        await self.send(f"Echo: {data}")
+
+class WebSocketPage(GenericAPI):
+    def get(self):
+        template = """
+        <h2>🐾 Panther WebSocket Echo Server</h2>
+        <input id="msg"><button onclick="s.send(msg.value)">Send</button>
+        <ul id="log"></ul>
+        <script>
+            const s = new WebSocket('ws://127.0.0.1:8000/ws');
+            s.onmessage = e => log.innerHTML += `<li><- ${msg.value}</li><li>-> ${e.data}</li>`;
+        </script>
+        """
+        return HTMLResponse(template)
+
+url_routing = {
+    '': WebSocketPage,
+    'ws': EchoWebsocket,
+}
+app = Panther(__name__, configs=__name__, urls=url_routing)
+```
+
+### Run Your Application
+
+1. **Start the development server**
+   ```shell
+   $ panther run main:app
+   ```
+   
+2. **Test your application**
+    - For the _API_ example: Visit [http://127.0.0.1:8000/](http://127.0.0.1:8000/) to see the "Hello World" response
+    - For the _WebSocket_ example: Visit [http://127.0.0.1:8000/](http://127.0.0.1:8000/) and send a message.
+
+---
+
+## 🙏 Acknowledgments
+
+<div align="center">
+  <p>Supported by</p>
+  <a href="https://drive.google.com/file/d/17xe1hicIiRF7SQ-clg9SETdc19SktCbV/view?usp=sharing">
+    <img alt="JetBrains" src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/jb_beam_50x50.png">
+  </a>
+</div>
+
+---
+
+<div align="center">
+  <p>⭐️ If you find Panther useful, please give it a star!</p>
+</div>

{panther-5.0.0b4 → panther-5.0.0b5}/panther/__init__.py

@@ -1,6 +1,6 @@
 from panther.main import Panther  # noqa: F401
 
-__version__ = '5.0.0beta4'
+__version__ = '5.0.0beta5'
 
 
 def version():

{panther-5.0.0b4 → panther-5.0.0b5}/panther/app.py

@@ -42,6 +42,7 @@ class API:
     methods: Specify the allowed methods.
     input_model: The `request.data` will be validated with this attribute, It will raise an
         `panther.exceptions.BadRequestAPIError` or put the validated data in the `request.validated_data`.
+    output_model: The `response.data` will be passed through this class to filter its attributes.
     output_schema: This attribute only used in creation of OpenAPI scheme which is available in `panther.openapi.urls`
         You may want to add its `url` to your urls.
     auth: It will authenticate the user with header of its request or raise an
@@ -59,6 +60,7 @@ class API:
         *,
         methods: list[Literal['GET', 'POST', 'PUT', 'PATCH', 'DELETE']] | None = None,
         input_model: type[ModelSerializer] | type[BaseModel] | None = None,
+        output_model: type[ModelSerializer] | type[BaseModel] | None = None,
         output_schema: OutputSchema | None = None,
         auth: bool = False,
         permissions: list[type[BasePermission]] | None = None,
@@ -69,21 +71,14 @@ class API:
     ):
         self.methods = {m.upper() for m in methods} if methods else {'GET', 'POST', 'PUT', 'PATCH', 'DELETE'}
         self.input_model = input_model
+        self.output_model = output_model
         self.output_schema = output_schema
         self.auth = auth
         self.permissions = permissions or []
         self.throttling = throttling
         self.cache = cache
-        self.middlewares: list[[HTTPMiddleware]] | None = middlewares
+        self.middlewares = middlewares
         self.request: Request | None = None
-        if kwargs.pop('output_model', None):
-            deprecation_message = (
-                traceback.format_stack(limit=2)[0]
-                + '\nThe `output_model` argument has been removed in Panther v5 and is no longer available.'
-                '\nPlease update your code to use the new approach. More info: '
-                'https://pantherpy.github.io/open_api/'
-            )
-            raise PantherError(deprecation_message)
         if kwargs.pop('cache_exp_time', None):
             deprecation_message = (
                 traceback.format_stack(limit=2)[0]
@@ -182,6 +177,8 @@ class API:
         # 9. Clean Response
         if not isinstance(response, Response):
             response = Response(data=response)
+        if self.output_model and response.data:
+            response.data = await response.serialize_output(output_model=self.output_model)
         if response.pagination:
             response.data = await response.pagination.template(response.data)
 
@@ -228,6 +225,7 @@ class GenericAPI(metaclass=MetaGenericAPI):
     """
 
     input_model: type[ModelSerializer] | type[BaseModel] | None = None
+    output_model: type[ModelSerializer] | type[BaseModel] | None = None
     output_schema: OutputSchema | None = None
     auth: bool = False
     permissions: list[type[BasePermission]] | None = None
@@ -239,6 +237,7 @@ class GenericAPI(metaclass=MetaGenericAPI):
         # Creating API instance to validate the attributes.
         API(
             input_model=cls.input_model,
+            output_model=cls.output_model,
             output_schema=cls.output_schema,
             auth=cls.auth,
             permissions=cls.permissions,
@@ -279,6 +278,7 @@ class GenericAPI(metaclass=MetaGenericAPI):
 
         return await API(
             input_model=self.input_model,
+            output_model=self.output_model,
             output_schema=self.output_schema,
             auth=self.auth,
             permissions=self.permissions,

{panther-5.0.0b4 → panther-5.0.0b5}/panther/db/connections.py

@@ -73,6 +73,10 @@ class MongoDBConnection(BaseDatabaseConnection):
     def session(self):
         return self._database
 
+    @property
+    def client(self):
+        return self._client
+
 
 class PantherDBConnection(BaseDatabaseConnection):
     def init(self, path: str | None = None, encryption: bool = False):
@@ -90,12 +94,20 @@ class PantherDBConnection(BaseDatabaseConnection):
     def session(self):
         return self._connection
 
+    @property
+    def client(self):
+        return self._connection
+
 
 class DatabaseConnection(Singleton):
     @property
     def session(self):
         return config.DATABASE.session
 
+    @property
+    def client(self):
+        return config.DATABASE.client
+
 
 class RedisConnection(Singleton, _Redis):
     is_connected: bool = False

{panther-5.0.0b4 → panther-5.0.0b5}/panther/db/cursor.py

@@ -36,6 +36,9 @@ class Cursor(_Cursor):
     def __aiter__(self) -> Self:
         return self
 
+    def __iter__(self) -> Self:
+        return self
+
     async def next(self) -> Self:
         return await self.cls._create_model_instance(document=super().next())
 

{panther-5.0.0b4 → panther-5.0.0b5}/panther/db/models.py

@@ -37,7 +37,7 @@ def validate_object_id(value, handler):
         raise ValueError(msg) from e
 
 
-ID = Annotated[str, WrapValidator(validate_object_id), PlainSerializer(lambda x: str(x), return_type=str)]
+ID = Annotated[str, WrapValidator(validate_object_id), PlainSerializer(lambda x: str(x), return_type=str)] | None
 
 
 class Model(PydanticBaseModel, Query):
@@ -46,7 +46,7 @@ class Model(PydanticBaseModel, Query):
             return
         config.MODELS.append(cls)
 
-    id: ID | None = Field(None, validation_alias='_id', alias='_id')
+    id: ID = None
 
     @property
     def _id(self):

{panther-5.0.0b4 → panther-5.0.0b5}/panther/db/queries/base_queries.py

@@ -45,6 +45,8 @@ class BaseQuery:
     @classmethod
     async def _create_model_instance(cls, document: dict):
         """Prevent getting errors from document insertion"""
+        if '_id' in document:
+            document['id'] = document.pop('_id')
         try:
             return cls(**document)
         except ValidationError as validation_error:

{panther-5.0.0b4 → panther-5.0.0b5}/panther/db/queries/mongodb_queries.py

@@ -104,7 +104,7 @@ class BaseMongoDBQuery(BaseQuery):
     @classmethod
     async def _create_field(cls, model: type, field_name: str, value: Any) -> Any:
         # Handle primary key field directly
-        if field_name == '_id':
+        if field_name == 'id':
             return value
 
         if field_name not in model.model_fields:
@@ -155,6 +155,9 @@ class BaseMongoDBQuery(BaseQuery):
     @classmethod
     async def _create_model_instance(cls, document: dict) -> Self:
         """Prepares document and creates an instance of the model."""
+        if '_id' in document:
+            document['id'] = document.pop('_id')
+
         processed_document = {
             field_name: await cls._create_field(model=cls, field_name=field_name, value=field_value)
             for field_name, field_value in document.items()

panther-5.0.0b5/panther/generics.py

@@ -0,0 +1,165 @@
+import contextlib
+import logging
+from abc import abstractmethod
+
+from pantherdb import Cursor as PantherDBCursor
+
+from panther import status
+from panther.app import GenericAPI
+from panther.configs import config
+from panther.db import Model
+from panther.db.connections import MongoDBConnection
+from panther.db.cursor import Cursor
+from panther.db.models import ID
+from panther.exceptions import APIError
+from panther.pagination import Pagination
+from panther.request import Request
+from panther.response import Response
+from panther.serializer import ModelSerializer
+
+with contextlib.suppress(ImportError):
+    # Only required if user wants to use mongodb
+    import bson
+
+logger = logging.getLogger('panther')
+
+
+class RetrieveAPI(GenericAPI):
+    @abstractmethod
+    async def get_instance(self, request: Request, **kwargs) -> Model:
+        """
+        Should return an instance of Model, e.g. `await User.find_one()`
+        """
+        logger.error(f'`get_instance()` method is not implemented in {self.__class__} .')
+        raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
+
+    async def get(self, request: Request, **kwargs):
+        instance = await self.get_instance(request=request, **kwargs)
+        return Response(data=instance, status_code=status.HTTP_200_OK)
+
+
+class ListAPI(GenericAPI):
+    sort_fields: list[str] = []
+    search_fields: list[str] = []
+    filter_fields: list[str] = []
+    pagination: type[Pagination] | None = None
+
+    async def get_query(self, request: Request, **kwargs) -> Cursor | PantherDBCursor:
+        """
+        Should return a Cursor, e.g. `await User.find()`
+        """
+        logger.error(f'`get_query()` method is not implemented in {self.__class__} .')
+        raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
+
+    async def get(self, request: Request, **kwargs):
+        cursor, pagination = await self.prepare_cursor(request=request, **kwargs)
+        return Response(data=cursor, pagination=pagination, status_code=status.HTTP_200_OK)
+
+    async def prepare_cursor(self, request: Request, **kwargs) -> tuple[Cursor | PantherDBCursor, Pagination | None]:
+        cursor = await self.get_query(request=request, **kwargs)
+        if not isinstance(cursor, (Cursor, PantherDBCursor)):
+            logger.error(f'`{self.__class__.__name__}.get_query()` should return a Cursor, e.g. `await Model.find()`')
+            raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
+
+        query = {}
+        query |= self.process_filters(query_params=request.query_params, cursor=cursor)
+        query |= self.process_search(query_params=request.query_params)
+
+        if query:
+            cursor = await cursor.cls.find(cursor.filter | query)
+
+        if sort := self.process_sort(query_params=request.query_params):
+            cursor = cursor.sort(sort)
+
+        if pagination := self.process_pagination(query_params=request.query_params, cursor=cursor):
+            cursor = pagination.paginate()
+
+        return cursor, pagination
+
+    def process_filters(self, query_params: dict, cursor: Cursor | PantherDBCursor) -> dict:
+        _filter = {}
+        for field in self.filter_fields:
+            if field in query_params:
+                _filter[field] = query_params[field]
+                if isinstance(config.DATABASE, MongoDBConnection) and cursor.cls.model_fields[field].annotation == ID:
+                    _filter[field] = bson.ObjectId(_filter[field])
+        return _filter
+
+    def process_search(self, query_params: dict) -> dict:
+        search_param = query_params.get('search')
+        if not self.search_fields or not search_param:
+            return {}
+        if isinstance(config.DATABASE, MongoDBConnection):
+            if search := [{field: {'$regex': search_param}} for field in self.search_fields]:
+                return {'$or': search}
+        return {field: search_param for field in self.search_fields}
+
+    def process_sort(self, query_params: dict) -> list:
+        sort_param = query_params.get('sort')
+        if not self.sort_fields or not sort_param:
+            return []
+        return [
+            (field, -1 if param.startswith('-') else 1)
+            for param in sort_param.split(',')
+            for field in self.sort_fields
+            if field == param.removeprefix('-')
+        ]
+
+    def process_pagination(self, query_params: dict, cursor: Cursor | PantherDBCursor) -> Pagination | None:
+        if self.pagination:
+            return self.pagination(query_params=query_params, cursor=cursor)
+
+
+class CreateAPI(GenericAPI):
+    input_model: type[ModelSerializer] | None = None
+
+    async def post(self, request: Request, **kwargs):
+        instance = await request.validated_data.model.insert_one(request.validated_data.model_dump())
+        return Response(data=instance, status_code=status.HTTP_201_CREATED)
+
+
+class UpdateAPI(GenericAPI):
+    input_model: type[ModelSerializer] | None = None
+
+    @abstractmethod
+    async def get_instance(self, request: Request, **kwargs) -> Model:
+        """
+        Should return an instance of Model, e.g. `await User.find_one()`
+        """
+        logger.error(f'`get_instance()` method is not implemented in {self.__class__} .')
+        raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
+
+    async def put(self, request: Request, **kwargs):
+        instance = await self.get_instance(request=request, **kwargs)
+        await instance.update(request.validated_data.model_dump())
+        return Response(data=instance, status_code=status.HTTP_200_OK)
+
+    async def patch(self, request: Request, **kwargs):
+        instance = await self.get_instance(request=request, **kwargs)
+        await instance.update(request.validated_data.model_dump(exclude_none=True))
+        return Response(data=instance, status_code=status.HTTP_200_OK)
+
+
+class DeleteAPI(GenericAPI):
+    @abstractmethod
+    async def get_instance(self, request: Request, **kwargs) -> Model:
+        """
+        Should return an instance of Model, e.g. `await User.find_one()`
+        """
+        logger.error(f'`get_instance()` method is not implemented in {self.__class__} .')
+        raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
+
+    async def pre_delete(self, instance, request: Request, **kwargs):
+        """Hook for logic before deletion."""
+        pass
+
+    async def post_delete(self, instance, request: Request, **kwargs):
+        """Hook for logic after deletion."""
+        pass
+
+    async def delete(self, request: Request, **kwargs):
+        instance = await self.get_instance(request=request, **kwargs)
+        await self.pre_delete(instance, request=request, **kwargs)
+        await instance.delete()
+        await self.post_delete(instance, request=request, **kwargs)
+        return Response(status_code=status.HTTP_204_NO_CONTENT)