panther 4.0.1__py3-none-any.whl → 4.1.1__py3-none-any.whl

panther/__init__.py

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

panther/app.py

@@ -95,7 +95,9 @@ 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)
+            if response.pagination:
+                response.data = await response.pagination.template(response.data)
 
             # 10. Set New Response To Cache
             if self.cache and self.request.method == 'GET':

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/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, 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.cursor(request=request, **kwargs)
+        self._check_cursor(cursor)
 
         query = {}
         query |= self.process_filters(query_params=request.query_params, cursor=cursor)
@@ -79,9 +83,9 @@ class ListAPI(GenericAPI, ObjectsRequired):
             cursor = cursor.sort(sort)
 
         if pagination := self.process_pagination(query_params=request.query_params, cursor=cursor):
-            cursor = await pagination.paginate()
+            cursor = pagination.paginate()
 
-        return Response(data=cursor, status_code=status.HTTP_200_OK)
+        return cursor, pagination
 
     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/pagination.py

@@ -36,7 +36,10 @@ class Pagination:
         previous_skip = max(self.skip - self.limit, 0)
         return f'?limit={self.limit}&skip={previous_skip}'
 
-    async def paginate(self):
+    def paginate(self):
+        return self.cursor.skip(skip=self.skip).limit(limit=self.limit)
+
+    async def template(self, response: list):
         count = await self.cursor.cls.count(self.cursor.filter)
         has_next = not bool(self.limit + self.skip >= count)
 
@@ -44,5 +47,5 @@ class Pagination:
             'count': count,
             'next': self.build_next_params() if has_next else None,
             'previous': self.build_previous_params() if self.skip else None,
-            'results': self.cursor.skip(skip=self.skip).limit(limit=self.limit)
+            'results': response
         }

panther/response.py

@@ -1,18 +1,18 @@
 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
 from panther.db.cursor import Cursor
 from pantherdb import Cursor as PantherDBCursor
 from panther.monitoring import Monitoring
+from panther.pagination import Pagination
 
-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
 
@@ -25,13 +25,20 @@ class Response:
         data: ResponseDataTypes = None,
         headers: dict | None = None,
         status_code: int = status.HTTP_200_OK,
+        pagination: Pagination | None = None,
     ):
         """
         :param data: should be an instance of ResponseDataTypes
         :param headers: should be dict of headers
         :param status_code: should be int
+        :param pagination: instance of Pagination or None
+            Its template() method will be used
         """
         self.headers = headers or {}
+        self.pagination: Pagination | None = pagination
+        if isinstance(data, Cursor):
+            data = list(data)
+        self.initial_data = data
         self.data = self.prepare_data(data=data)
         self.status_code = self.check_status_code(status_code=status_code)
 
@@ -60,7 +67,7 @@ class Response:
     def headers(self, headers: dict):
         self._headers = headers
 
-    def prepare_data(self, data: any):
+    def prepare_data(self, data: Any):
         """Make sure the response data is only ResponseDataTypes or Iterable of ResponseDataTypes"""
         if isinstance(data, (int | float | str | bool | bytes | NoneType)):
             return data
@@ -68,7 +75,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 +86,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/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.1.dist-info → panther-4.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.0.1
+Version: 4.1.1
 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.1.dist-info → panther-4.1.1.dist-info}/RECORD

@@ -1,26 +1,26 @@
-panther/__init__.py,sha256=5Kdy8QK5KIDYGPfC-2xwNeQosFAlIMtIBeSSQbwt_u8,110
+panther/__init__.py,sha256=37OBLxeY8rais9kzGaOXnI_uUmSu-VS2X5mzPiPGZa4,110
 panther/_load_configs.py,sha256=AVkoixkUFkBQiTmrLrwCmg0eiPW2U_Uw2EGNEGQRfnI,9281
 panther/_utils.py,sha256=xeVR0yHvczhXv2XXrpoa6SHpGTDTFxNxiemXTdbsqjM,4279
-panther/app.py,sha256=X4vmpj5QuEt10iSVso89hGfyw75vemWtHPtdrXX4nD4,7276
+panther/app.py,sha256=vb4j8CKidFHD5HIfK1t96fr8URMYxkroW8dQH9SVj14,7385
 panther/authentications.py,sha256=gf7BVyQ8vXKhiumJAtD0aAK7uIHWx_snbOKYAKrYuVw,5677
 panther/background_tasks.py,sha256=HBYubDIiO_673cl_5fqCUP9zzimzRgRkDSkag9Msnbs,7656
-panther/base_request.py,sha256=w48-1gQzJi5m9AUZzspdugffUS73lZ8Lw0N9AND_XDM,4064
+panther/base_request.py,sha256=Fwwpm-9bjAZdpzSdakmSas5BD3gh1nrc6iGcBxwa_94,4001
 panther/base_websocket.py,sha256=hJN_ItUGLpk0QMWrExlDHQahiu7hYgc_jVvHWxqqpq4,10547
 panther/caching.py,sha256=ltuJYdjNiAaKIs3jpO5EBpL8Y6CF1vAIQqh8J_Np10g,4098
 panther/configs.py,sha256=EaLApT6nYcguBoNXBG_8n6DU6HTNxsulI2943j8UAkE,3174
 panther/events.py,sha256=bxDqrfiNNBlvD03vEk2LDK4xbMzTMFVcgAjx2ein7mI,1158
 panther/exceptions.py,sha256=7rHdJIES2__kqOStIqbHl3Uxask2lzKgLQlkZvvDwFA,1591
 panther/file_handler.py,sha256=XnomEigCUYOaXjkH4kD1kzpUbL2i9lLnR5kerruF6BA,846
-panther/generics.py,sha256=eR97UgsH2WdqWTR5aw94niIJwIAlhgAz2wNVz_N3vIk,6311
+panther/generics.py,sha256=SIK1Wqpfb_jKKt4xJPbYIhMY0QhtbhOXS68dIW4Y0bU,6671
 panther/logging.py,sha256=t0nQXsSIwIxShqFnjRGp6lhO4Ybf1SnwJraDSTqMHFM,2211
 panther/main.py,sha256=UbIxwaojvY_vH9nYfBpkulRBqVEj4Lbl81Er4XW_KCY,9334
 panther/monitoring.py,sha256=y1F3c8FJlnmooM-m1nSyOTa9eWq0v1nHnmw9zz-4Kls,1314
-panther/pagination.py,sha256=efpsWMgLBaTWXhnhMAf6fyIrGTmVOFbmHpX03GgEJh0,1574
+panther/pagination.py,sha256=ANJrEF0q1nVAfD33I4nZfUUxFcETzJb01gIhbZX3HEw,1639
 panther/permissions.py,sha256=9-J5vzvEKa_PITwEVQbZZv8PG2FOu05YBlD5yMrKcfc,348
 panther/request.py,sha256=F9ZiAWSse7_6moAzqdoFInUN4zTKlzijh9AdU9w3Jfw,1673
-panther/response.py,sha256=OvuxKueM5FJ7gg9icsR5NjVxkU9_4dsgShcOJFMcdaY,6458
+panther/response.py,sha256=Njp4zJozNic8J4ucG8Sgh-xeBZOgtoz2cfdDkJlGOWU,7582
 panther/routings.py,sha256=1eqbjubLnUUEQRlz8mIF464ImvCMjyasiekHBtxEQoQ,6218
-panther/serializer.py,sha256=dvPbDf6qICMuhTtX1ZXW0G5_BCHcLwughGOb1w3umXo,9002
+panther/serializer.py,sha256=MBT43UG8YBjp-UGaqe5-SPqQHIcDEjLAdBjHAVKyMJo,9059
 panther/status.py,sha256=Gc_PnYrHfInTsZpGbqiCfDB-py1C7Rh8KMdb6Lq9Exs,3346
 panther/test.py,sha256=RsQtP5IURLWR__BihOjruWoX3NscmGDqDqj1CfAb3bI,7037
 panther/throttling.py,sha256=mVa_mGv6w_Ad7LLtV4eG5QpDwwNsk4QjFFi0mIHQBnE,231
@@ -49,9 +49,9 @@ panther/panel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 panther/panel/apis.py,sha256=COsbwKZyTgyHvHYbpDfusifAH9ojMS3z1KhZCt9M-Ms,2428
 panther/panel/urls.py,sha256=JiV-H4dWE-m_bfaTTVxzOxTvJmOWhyLOvcbM7xU3Bn4,240
 panther/panel/utils.py,sha256=0Rv79oR5IEqalqwpRKQHMn1p5duVY5mxMqDKiA5mWx4,437
-panther-4.0.1.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
-panther-4.0.1.dist-info/METADATA,sha256=FX3DcJ0oTxuuJFxZNcl2y6XGPJe_nTSFHfn8_Dty64Q,6968
-panther-4.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-panther-4.0.1.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
-panther-4.0.1.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
-panther-4.0.1.dist-info/RECORD,,
+panther-4.1.1.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
+panther-4.1.1.dist-info/METADATA,sha256=pFsxiCf8SXniQAHMq7DmwsuAa8EQmBlVFbjkLhfs4wQ,6376
+panther-4.1.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+panther-4.1.1.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
+panther-4.1.1.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
+panther-4.1.1.dist-info/RECORD,,