panther 4.0.0__tar.gz → 4.1.0__tar.gz

{panther-4.0.0 → panther-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.0.0
+Version: 4.1.0
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -56,7 +56,7 @@ Requires-Dist: watchfiles~=0.21.0; extra == "full"
 - Support Custom **Middlewares**
 - Support Custom **Throttling**
 - Support **Function-Base** and **Class-Base** APIs
-- It's One Of The **Fastest Python Frameworks** 
+- It's One Of The **Fastest Python Framework** 
 ---
 
 ### Supported by
@@ -68,25 +68,6 @@ Requires-Dist: watchfiles~=0.21.0; extra == "full"
 
 ---
 
-### Benchmark
-
-| Framework  | Throughput (Request/Second) |
-|------------|-----------------------------|
-| Blacksheep | 5,339                       |
-| Muffin     | 5,320                       |
-| Panther    | 5,112                       |
-| Sanic      | 3,660                       |
-| FastAPI    | 3,260                       |
-| Tornado    | 2,081                       |
-| Bottle     | 2,045                       |
-| Django     | 821                         |
-| Flask      | 749                         |
-
-
-> **More Detail:** https://GitHub.com/PantherPy/frameworks-benchmark
-
----
-
 ### Installation
 ```shell
 $ pip install panther
@@ -105,7 +86,7 @@ $ pip install panther
     ```shell
     $ panther run --reload
     ```
-  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server too_
+  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server_
 
 - #### Monitoring Requests
 

{panther-4.0.0 → panther-4.1.0}/README.md

@@ -25,7 +25,7 @@
 - Support Custom **Middlewares**
 - Support Custom **Throttling**
 - Support **Function-Base** and **Class-Base** APIs
-- It's One Of The **Fastest Python Frameworks** 
+- It's One Of The **Fastest Python Framework** 
 ---
 
 ### Supported by
@@ -37,25 +37,6 @@
 
 ---
 
-### Benchmark
-
-| Framework  | Throughput (Request/Second) |
-|------------|-----------------------------|
-| Blacksheep | 5,339                       |
-| Muffin     | 5,320                       |
-| Panther    | 5,112                       |
-| Sanic      | 3,660                       |
-| FastAPI    | 3,260                       |
-| Tornado    | 2,081                       |
-| Bottle     | 2,045                       |
-| Django     | 821                         |
-| Flask      | 749                         |
-
-
-> **More Detail:** https://GitHub.com/PantherPy/frameworks-benchmark
-
----
-
 ### Installation
 ```shell
 $ pip install panther
@@ -74,7 +55,7 @@ $ pip install panther
     ```shell
     $ panther run --reload
     ```
-  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server too_
+  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server_
 
 - #### Monitoring Requests
 

{panther-4.0.0 → panther-4.1.0}/panther/__init__.py

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

{panther-4.0.0 → panther-4.1.0}/panther/app.py

@@ -95,7 +95,7 @@ class API:
             if not isinstance(response, Response):
                 response = Response(data=response)
             if self.output_model and response.data:
-                response.data = response.apply_output_model(response.data, output_model=self.output_model)
+                response.data = await response.apply_output_model(output_model=self.output_model)
 
             # 10. Set New Response To Cache
             if self.cache and self.request.method == 'GET':

{panther-4.0.0 → panther-4.1.0}/panther/base_request.py

@@ -27,9 +27,9 @@ class Headers:
     sec_websocket_version: str
     sec_websocket_key: str
 
-    def __init__(self, headers):
-        self.__headers = headers
-        self.__pythonic_headers = {k.lower().replace('-', '_'): v for k, v in headers.items()}
+    def __init__(self, headers: list):
+        self.__headers = {header[0].decode('utf-8'): header[1].decode('utf-8') for header in headers}
+        self.__pythonic_headers = {k.lower().replace('-', '_'): v for k, v in self.__headers.items()}
 
     def __getattr__(self, item: str):
         if result := self.__pythonic_headers.get(item):
@@ -68,8 +68,7 @@ class BaseRequest:
     @property
     def headers(self) -> Headers:
         if self._headers is None:
-            _headers = {header[0].decode('utf-8'): header[1].decode('utf-8') for header in self.scope['headers']}
-            self._headers = Headers(_headers)
+            self._headers = Headers(self.scope['headers'])
         return self._headers
 
     @property
@@ -77,8 +76,7 @@ class BaseRequest:
         if self._params is None:
             self._params = {}
             if (query_string := self.scope['query_string']) != b'':
-                query_string = query_string.decode('utf-8').split('&')
-                for param in query_string:
+                for param in query_string.decode('utf-8').split('&'):
                     k, *_, v = param.split('=')
                     self._params[k] = v
         return self._params

{panther-4.0.0 → panther-4.1.0}/panther/base_websocket.py

@@ -182,10 +182,9 @@ class WebsocketConnections(Singleton):
               but they have same Manager()
         """
 
-        if config.HAS_WS:
-            # Schedule the async function to run in the background,
-            #   We don't need to await for this task
-            asyncio.create_task(self())
+        # Schedule the async function to run in the background,
+        #   We don't need to await for this task
+        asyncio.create_task(self())
 
     @classmethod
     async def handle_authentication(cls, connection: Websocket):

{panther-4.0.0 → panther-4.1.0}/panther/generics.py

@@ -27,7 +27,7 @@ class ObjectRequired:
             logger.critical(f'`{self.__class__.__name__}.object()` should return instance of a Model --> `find_one()`')
             raise APIError
 
-    async def object(self, request: Request, **kwargs) -> Model:
+    async def object(self, request: Request, **kwargs):
         """
         Used in `RetrieveAPI`, `UpdateAPI`, `DeleteAPI`
         """
@@ -35,18 +35,18 @@ class ObjectRequired:
         raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
 
 
-class ObjectsRequired:
-    def _check_objects(self, cursor):
+class CursorRequired:
+    def _check_cursor(self, cursor):
         if isinstance(cursor, (Cursor, PantherDBCursor)) is False:
-            logger.critical(f'`{self.__class__.__name__}.objects()` should return a Cursor --> `find()`')
+            logger.critical(f'`{self.__class__.__name__}.cursor()` should return a Cursor --> `find()`')
             raise APIError
 
-    async def objects(self, request: Request, **kwargs) -> Cursor | PantherDBCursor:
+    async def cursor(self, request: Request, **kwargs) -> Cursor | PantherDBCursor:
         """
         Used in `ListAPI`
         Should return `.find()`
         """
-        logger.error(f'`objects()` method is not implemented in {self.__class__} .')
+        logger.error(f'`cursor()` method is not implemented in {self.__class__} .')
         raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
 
 
@@ -58,15 +58,19 @@ class RetrieveAPI(GenericAPI, ObjectRequired):
         return Response(data=instance, status_code=status.HTTP_200_OK)
 
 
-class ListAPI(GenericAPI, ObjectsRequired):
+class ListAPI(GenericAPI, CursorRequired):
     sort_fields: list[str]
     search_fields: list[str]
     filter_fields: list[str]
     pagination: type[Pagination]
 
     async def get(self, request: Request, **kwargs):
-        cursor = await self.objects(request=request, **kwargs)
-        self._check_objects(cursor)
+        cursor = await self.prepare_cursor(request=request, **kwargs)
+        return Response(data=cursor, status_code=status.HTTP_200_OK)
+
+    async def prepare_cursor(self, request: Request, **kwargs):
+        cursor = await self.cursor(request=request, **kwargs)
+        self._check_cursor(cursor)
 
         query = {}
         query |= self.process_filters(query_params=request.query_params, cursor=cursor)
@@ -81,7 +85,7 @@ class ListAPI(GenericAPI, ObjectsRequired):
         if pagination := self.process_pagination(query_params=request.query_params, cursor=cursor):
             cursor = await pagination.paginate()
 
-        return Response(data=cursor, status_code=status.HTTP_200_OK)
+        return cursor
 
     def process_filters(self, query_params: dict, cursor: Cursor | PantherDBCursor) -> dict:
         _filter = {}
@@ -90,6 +94,7 @@ class ListAPI(GenericAPI, ObjectsRequired):
                 if field in query_params:
                     if config.DATABASE.__class__.__name__ == 'MongoDBConnection':
                         with contextlib.suppress(Exception):
+                            # Change type of the value if it is ObjectId
                             if cursor.cls.model_fields[field].metadata[0].func.__name__ == 'validate_object_id':
                                 _filter[field] = bson.ObjectId(query_params[field])
                                 continue
@@ -161,3 +166,7 @@ class DeleteAPI(GenericAPI, ObjectRequired):
 
         await instance.delete()
         return Response(status_code=status.HTTP_204_NO_CONTENT)
+
+
+class ListCreateAPI(CreateAPI, ListAPI):
+    pass

{panther-4.0.0 → panther-4.1.0}/panther/main.py

@@ -70,7 +70,8 @@ class Panther:
         if scope['type'] == 'lifespan':
             message = await receive()
             if message["type"] == 'lifespan.startup':
-                await config.WEBSOCKET_CONNECTIONS.start()
+                if config.HAS_WS:
+                    await config.WEBSOCKET_CONNECTIONS.start()
                 await Event.run_startups()
             elif message["type"] == 'lifespan.shutdown':
                 # It's not happening :\, so handle the shutdowns in __del__ ...

{panther-4.0.0 → panther-4.1.0}/panther/response.py

@@ -1,10 +1,9 @@
 import asyncio
 from types import NoneType
-from typing import Generator, AsyncGenerator
+from typing import Generator, AsyncGenerator, Any, Type
 
 import orjson as json
-from pydantic import BaseModel as PydanticBaseModel
-from pydantic._internal._model_construction import ModelMetaclass
+from pydantic import BaseModel
 
 from panther import status
 from panther._utils import to_async_generator
@@ -12,7 +11,7 @@ from panther.db.cursor import Cursor
 from pantherdb import Cursor as PantherDBCursor
 from panther.monitoring import Monitoring
 
-ResponseDataTypes = list | tuple | set | Cursor | PantherDBCursor | dict | int | float | str | bool | bytes | NoneType | ModelMetaclass
+ResponseDataTypes = list | tuple | set | Cursor | PantherDBCursor | dict | int | float | str | bool | bytes | NoneType | Type[BaseModel]
 IterableDataTypes = list | tuple | set | Cursor | PantherDBCursor
 StreamingDataTypes = Generator | AsyncGenerator
 
@@ -32,6 +31,7 @@ class Response:
         :param status_code: should be int
         """
         self.headers = headers or {}
+        self.initial_data = data
         self.data = self.prepare_data(data=data)
         self.status_code = self.check_status_code(status_code=status_code)
 
@@ -68,7 +68,7 @@ class Response:
         elif isinstance(data, dict):
             return {key: self.prepare_data(value) for key, value in data.items()}
 
-        elif issubclass(type(data), PydanticBaseModel):
+        elif issubclass(type(data), BaseModel):
             return data.model_dump()
 
         elif isinstance(data, IterableDataTypes):
@@ -79,25 +79,42 @@ class Response:
             raise TypeError(msg)
 
     @classmethod
-    def check_status_code(cls, status_code: any):
+    def check_status_code(cls, status_code: Any):
         if not isinstance(status_code, int):
             error = f'Response `status_code` Should Be `int`. (`{status_code}` is {type(status_code)})'
             raise TypeError(error)
         return status_code
 
-    @classmethod
-    def apply_output_model(cls, data: any, /, output_model: ModelMetaclass):
+    async def apply_output_model(self, output_model: Type[BaseModel]):
         """This method is called in API.__call__"""
+
         # Dict
-        if isinstance(data, dict):
+        if isinstance(self.data, dict):
+            # Apply `validation_alias` (id -> _id)
             for field_name, field in output_model.model_fields.items():
-                if field.validation_alias and field_name in data:
-                    data[field.validation_alias] = data.pop(field_name)
-            return output_model(**data).model_dump()
+                if field.validation_alias and field_name in self.data:
+                    self.data[field.validation_alias] = self.data.pop(field_name)
+            output = output_model(**self.data)
+            if hasattr(output_model, 'prepare_response'):
+                return await output.prepare_response(instance=self.initial_data, data=output.model_dump())
+            return output.model_dump()
 
         # Iterable
-        if isinstance(data, IterableDataTypes):
-            return [cls.apply_output_model(d, output_model=output_model) for d in data]
+        results = []
+        if isinstance(self.data, IterableDataTypes):
+            for i, d in enumerate(self.data):
+                # Apply `validation_alias` (id -> _id)
+                for field_name, field in output_model.model_fields.items():
+                    if field.validation_alias and field_name in d:
+                        d[field.validation_alias] = d.pop(field_name)
+
+                output = output_model(**d)
+                if hasattr(output_model, 'prepare_response'):
+                    result = await output.prepare_response(instance=self.initial_data[i], data=output.model_dump())
+                else:
+                    result = output.model_dump()
+                results.append(result)
+            return results
 
         # Str | Bool | Bytes
         msg = 'Type of Response data is not match with `output_model`.\n*hint: You may want to remove `output_model`'

{panther-4.0.0 → panther-4.1.0}/panther/serializer.py

@@ -1,5 +1,5 @@
 import typing
-from typing import TypeVar, Type
+from typing import Any
 
 from pydantic import create_model, BaseModel, ConfigDict
 from pydantic.fields import FieldInfo, Field
@@ -205,13 +205,13 @@ class ModelSerializer(metaclass=MetaModelSerializer):
     model: type[BaseModel]
     request: Request
 
-    async def create(self, validated_data: dict) -> Model:
+    async def create(self, validated_data: dict):
         """
         validated_data = ModelSerializer.model_dump()
         """
         return await self.model.insert_one(validated_data)
 
-    async def update(self, instance: Model, validated_data: dict) -> Model:
+    async def update(self, instance: Model, validated_data: dict):
         """
         instance = UpdateAPI.object()
         validated_data = ModelSerializer.model_dump()
@@ -219,10 +219,13 @@ class ModelSerializer(metaclass=MetaModelSerializer):
         await instance.update(validated_data)
         return instance
 
-    async def partial_update(self, instance: Model, validated_data: dict) -> Model:
+    async def partial_update(self, instance: Model, validated_data: dict):
         """
         instance = UpdateAPI.object()
         validated_data = ModelSerializer.model_dump(exclude_none=True)
         """
         await instance.update(validated_data)
         return instance
+
+    async def prepare_response(self, instance: Any, data: dict) -> dict:
+        return data

{panther-4.0.0 → panther-4.1.0}/panther.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.0.0
+Version: 4.1.0
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -56,7 +56,7 @@ Requires-Dist: watchfiles~=0.21.0; extra == "full"
 - Support Custom **Middlewares**
 - Support Custom **Throttling**
 - Support **Function-Base** and **Class-Base** APIs
-- It's One Of The **Fastest Python Frameworks** 
+- It's One Of The **Fastest Python Framework** 
 ---
 
 ### Supported by
@@ -68,25 +68,6 @@ Requires-Dist: watchfiles~=0.21.0; extra == "full"
 
 ---
 
-### Benchmark
-
-| Framework  | Throughput (Request/Second) |
-|------------|-----------------------------|
-| Blacksheep | 5,339                       |
-| Muffin     | 5,320                       |
-| Panther    | 5,112                       |
-| Sanic      | 3,660                       |
-| FastAPI    | 3,260                       |
-| Tornado    | 2,081                       |
-| Bottle     | 2,045                       |
-| Django     | 821                         |
-| Flask      | 749                         |
-
-
-> **More Detail:** https://GitHub.com/PantherPy/frameworks-benchmark
-
----
-
 ### Installation
 ```shell
 $ pip install panther
@@ -105,7 +86,7 @@ $ pip install panther
     ```shell
     $ panther run --reload
     ```
-  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server too_
+  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server_
 
 - #### Monitoring Requests
 

{panther-4.0.0 → panther-4.1.0}/tests/test_generics.py

@@ -24,7 +24,7 @@ class RetrieveAPITest(RetrieveAPI):
 
 
 class ListAPITest(ListAPI):
-    async def objects(self, request: Request, **kwargs):
+    async def cursor(self, request: Request, **kwargs):
         return await User.find()
 
 
@@ -34,7 +34,7 @@ class FullListAPITest(ListAPI):
     filter_fields = ['name', 'age']
     pagination = Pagination
 
-    async def objects(self, request: Request, **kwargs):
+    async def cursor(self, request: Request, **kwargs):
         return await Person.find()