panther 5.0.0b4__py3-none-any.whl → 5.0.0b5__py3-none-any.whl

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/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/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/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/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/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/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/generics.py

@@ -1,5 +1,6 @@
 import contextlib
 import logging
+from abc import abstractmethod
 
 from pantherdb import Cursor as PantherDBCursor
 
@@ -7,7 +8,9 @@ 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
@@ -21,56 +24,42 @@ with contextlib.suppress(ImportError):
 logger = logging.getLogger('panther')
 
 
-class ObjectRequired:
-    def _check_object(self, instance):
-        if instance and issubclass(type(instance), Model) is False:
-            logger.critical(f'`{self.__class__.__name__}.object()` should return instance of a Model --> `find_one()`')
-            raise APIError
-
-    async def object(self, request: Request, **kwargs):
+class RetrieveAPI(GenericAPI):
+    @abstractmethod
+    async def get_instance(self, request: Request, **kwargs) -> Model:
         """
-        Used in `RetrieveAPI`, `UpdateAPI`, `DeleteAPI`
+        Should return an instance of Model, e.g. `await User.find_one()`
         """
-        logger.error(f'`object()` method is not implemented in {self.__class__} .')
+        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 CursorRequired:
-    def _check_cursor(self, cursor):
-        if isinstance(cursor, (Cursor, PantherDBCursor)) is False:
-            logger.critical(f'`{self.__class__.__name__}.cursor()` should return a Cursor --> `find()`')
-            raise APIError
+class ListAPI(GenericAPI):
+    sort_fields: list[str] = []
+    search_fields: list[str] = []
+    filter_fields: list[str] = []
+    pagination: type[Pagination] | None = None
 
-    async def cursor(self, request: Request, **kwargs) -> Cursor | PantherDBCursor:
+    async def get_query(self, request: Request, **kwargs) -> Cursor | PantherDBCursor:
         """
-        Used in `ListAPI`
-        Should return `.find()`
+        Should return a Cursor, e.g. `await User.find()`
         """
-        logger.error(f'`cursor()` method is not implemented in {self.__class__} .')
+        logger.error(f'`get_query()` method is not implemented in {self.__class__} .')
         raise APIError(status_code=status.HTTP_501_NOT_IMPLEMENTED)
 
-
-class RetrieveAPI(GenericAPI, ObjectRequired):
-    async def get(self, request: Request, **kwargs):
-        instance = await self.object(request=request, **kwargs)
-        self._check_object(instance)
-
-        return Response(data=instance, status_code=status.HTTP_200_OK)
-
-
-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, 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)
+        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)
@@ -89,106 +78,88 @@ class ListAPI(GenericAPI, CursorRequired):
 
     def process_filters(self, query_params: dict, cursor: Cursor | PantherDBCursor) -> dict:
         _filter = {}
-        if hasattr(self, 'filter_fields'):
-            for field in self.filter_fields:
-                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
-                    _filter[field] = query_params[field]
+        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:
-        if hasattr(self, 'search_fields') and 'search' in query_params:
-            value = query_params['search']
-            if config.DATABASE.__class__.__name__ == 'MongoDBConnection':
-                if search := [{field: {'$regex': value}} for field in self.search_fields]:
-                    return {'$or': search}
-            else:
-                logger.warning(f'`?search={value} does not work well while using `PantherDB` as Database')
-                return {field: value for field in self.search_fields}
-        return {}
+        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:
-        if hasattr(self, 'sort_fields') and 'sort' in query_params:
-            return [
-                (field, -1 if param[0] == '-' else 1)
-                for field in self.sort_fields
-                for param in query_params['sort'].split(',')
-                if field == param.removeprefix('-')
-            ]
+        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 hasattr(self, 'pagination'):
+        if self.pagination:
             return self.pagination(query_params=query_params, cursor=cursor)
 
 
 class CreateAPI(GenericAPI):
-    input_model: type[ModelSerializer]
+    input_model: type[ModelSerializer] | None = None
 
     async def post(self, request: Request, **kwargs):
-        instance = await request.validated_data.create(
-            validated_data={
-                field: getattr(request.validated_data, field)
-                for field in request.validated_data.model_fields_set
-                if field != 'request'
-            },
-        )
+        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, ObjectRequired):
-    input_model: type[ModelSerializer]
+class UpdateAPI(GenericAPI):
+    input_model: type[ModelSerializer] | None = None
 
-    async def put(self, request: Request, **kwargs):
-        instance = await self.object(request=request, **kwargs)
-        self._check_object(instance)
+    @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)
 
-        await request.validated_data.update(
-            instance=instance,
-            validated_data=request.validated_data.model_dump(by_alias=True),
-        )
+    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.object(request=request, **kwargs)
-        self._check_object(instance)
-
-        await request.validated_data.partial_update(
-            instance=instance,
-            validated_data=request.validated_data.model_dump(exclude_none=True, by_alias=True),
-        )
+        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, ObjectRequired):
+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.object(request=request, **kwargs)
-        self._check_object(instance)
-
+        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)
-
-
-class ListCreateAPI(CreateAPI, ListAPI):
-    pass
-
-
-class UpdateDeleteAPI(UpdateAPI, DeleteAPI):
-    pass
-
-
-class RetrieveUpdateDeleteAPI(RetrieveAPI, UpdateAPI, DeleteAPI):
-    pass

panther/response.py

@@ -82,16 +82,15 @@ class Response:
         :param headers: should be dict of headers
         :param pagination: an instance of Pagination or None
             The `pagination.template()` method will be used
-        :param set_cookies: single cookie or list of cookies you want to set on the client
-            Set the `max_age` to `0` if you want to delete a cookie
+        :param set_cookies: single cookie or list of cookies you want to set on the client.
+            Set the `max-age` to `0` if you want to delete a cookie.
         """
+        if isinstance(data, (Cursor, PantherDBCursor)):
+            data = list(data)
+        self.data = data
+        self.status_code = status_code
         self.headers = {'Content-Type': self.content_type} | (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)
         self.cookies = None
         if set_cookies:
             c = cookies.SimpleCookie()
@@ -109,13 +108,25 @@ class Response:
                     c[cookie.key]['max-age'] = cookie.max_age
             self.cookies = [(b'Set-Cookie', cookie.OutputString().encode()) for cookie in c.values()]
 
+    def __str__(self):
+        if len(data := str(self.data)) > 30:
+            data = f'{data:.27}...'
+        return f'Response(status_code={self.status_code}, data={data})'
+
+    __repr__ = __str__
+
     @property
     def body(self) -> bytes:
+        def default(obj: Any):
+            if isinstance(obj, BaseModel):
+                return obj.model_dump()
+            raise TypeError(f'Type {type(obj)} not serializable')
+
         if isinstance(self.data, bytes):
             return self.data
         if self.data is None:
             return b''
-        return json.dumps(self.data)
+        return json.dumps(self.data, default=default)
 
     @property
     def bytes_headers(self) -> list[tuple[bytes, bytes]]:
@@ -125,42 +136,34 @@ class Response:
             result += self.cookies
         return result
 
-    @classmethod
-    def prepare_data(cls, 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
-
-        elif isinstance(data, dict):
-            return {key: cls.prepare_data(value) for key, value in data.items()}
-
-        elif issubclass(type(data), BaseModel):
-            return data.model_dump()
-
-        elif isinstance(data, IterableDataTypes):
-            return [cls.prepare_data(d) for d in data]
-
-        else:
-            msg = f'Invalid Response Type: {type(data)}'
-            raise TypeError(msg)
-
-    @classmethod
-    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
-
     async def send(self, send, receive):
         await send({'type': 'http.response.start', 'status': self.status_code, 'headers': self.bytes_headers})
         await send({'type': 'http.response.body', 'body': self.body, 'more_body': False})
 
-    def __str__(self):
-        if len(data := str(self.data)) > 30:
-            data = f'{data:.27}...'
-        return f'Response(status_code={self.status_code}, data={data})'
-
-    __repr__ = __str__
+    async def serialize_output(self, output_model: type[BaseModel]):
+        """Serializes response data using the given output_model."""
+
+        async def handle_output(obj):
+            output = output_model(**obj) if isinstance(obj, dict) else output_model(**obj.model_dump())
+            if hasattr(output_model, 'to_response'):
+                return await output.to_response(instance=obj, data=output.model_dump())
+            return output.model_dump()
+
+        if isinstance(self.data, dict) or isinstance(self.data, BaseModel):
+            return await handle_output(self.data)
+
+        if isinstance(self.data, IterableDataTypes):
+            results = []
+            for d in self.data:
+                if isinstance(d, dict) or isinstance(d, BaseModel):
+                    results.append(await handle_output(d))
+                else:
+                    msg = 'Type of Response data is not match with `output_model`.\n*hint: You may want to remove `output_model`'
+                    raise TypeError(msg)
+            return results
+
+        msg = 'Type of Response data is not match with `output_model`.\n*hint: You may want to remove `output_model`'
+        raise TypeError(msg)
 
 
 class StreamingResponse(Response):
@@ -175,14 +178,6 @@ class StreamingResponse(Response):
         if message['type'] == 'http.disconnect':
             self.connection_closed = True
 
-    def prepare_data(self, data: any) -> AsyncGenerator:
-        if isinstance(data, AsyncGenerator):
-            return data
-        elif isinstance(data, Generator):
-            return to_async_generator(data)
-        msg = f'Invalid Response Type: {type(data)}'
-        raise TypeError(msg)
-
     @property
     def bytes_headers(self) -> list[tuple[bytes, bytes]]:
         result = [(k.encode(), str(v).encode()) for k, v in self.headers.items()]
@@ -192,6 +187,12 @@ class StreamingResponse(Response):
 
     @property
     async def body(self) -> AsyncGenerator:
+        if not isinstance(self.data, (Generator, AsyncGenerator)):
+            raise TypeError(f'Type {type(self.data)} is not streamable, should be `Generator` or `AsyncGenerator`.')
+
+        if isinstance(self.data, Generator):
+            self.data = to_async_generator(self.data)
+
         async for chunk in self.data:
             if isinstance(chunk, bytes):
                 yield chunk

panther/serializer.py

@@ -204,27 +204,5 @@ class ModelSerializer(metaclass=MetaModelSerializer):
     model: type[BaseModel]
     request: Request
 
-    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):
-        """
-        instance = UpdateAPI.object()
-        validated_data = ModelSerializer.model_dump()
-        """
-        await instance.update(validated_data)
-        return instance
-
-    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:
+    async def to_response(self, instance: Any, data: dict) -> dict:
         return data

panther-5.0.0b5.dist-info/METADATA

@@ -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.0b4.dist-info → panther-5.0.0b5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-panther/__init__.py,sha256=X4CUQB2xphMKSsHepAZPm5n5K0uNc-zhZt9i3Hs_jN8,115
+panther/__init__.py,sha256=ytLbZ9XWNWjCIG-7DU0bpP1TRmk2oBs5u8RKm2A8uTA,115
 panther/_load_configs.py,sha256=9SMiJm4N5wOZYYpM5BfchvHuTg7PZOmvfIkiloUQLDk,11283
 panther/_utils.py,sha256=5UN0DBNTEqHejK6EOnG9IYyH1gK9OvGXYlNp5G0iFuU,4720
-panther/app.py,sha256=1WsVwzWZBxA5lO6v18Renq9oYqySY0gRFFT42cPkbFY,11409
+panther/app.py,sha256=H_tMo64KIFi79WIacEI_d8IcWxtvv9fUxNjQzTMwdqg,11449
 panther/authentications.py,sha256=JdCeXKvo6iHmxeXsZEmFvXQsLkI149g1dIR_md6blV8,7844
 panther/background_tasks.py,sha256=A__lY4IijGbRD9GKtbUK_c8cChtFW0jPaxoQHJ25bsk,7539
 panther/base_request.py,sha256=MkzTv_Si4scJFZgHRaZurwjN6KthrKf1aqIN8u811z0,4950
@@ -11,15 +11,15 @@ panther/configs.py,sha256=Hg-4B9mD4QL5aALEd7NJ8bTMikJWS1dhVtKe0n42Buc,3834
 panther/events.py,sha256=-AFsJwZe9RpQ9xQQArUfqCPjv4ZRaFZ0shzTuO5WmWc,1576
 panther/exceptions.py,sha256=QubEyGPnKlo4e7dR_SU2JbRB20vZ42LcUH3JvmOK5Xg,2231
 panther/file_handler.py,sha256=6zXe36eaCyqtZFX2bMT9xl8tjimoHMcD7csLoPx_8EA,1323
-panther/generics.py,sha256=v66yp6-jNdXh7EW5U-1g_f0zrp8_KaGr6OcbXsYbuzM,7318
+panther/generics.py,sha256=O0XHXNKwRy3KbbE4UNJ5m-Tzn2qtNQZuu0OSf1ES03A,6806
 panther/logging.py,sha256=g-RUuyCveqdMrEQXWIjIPZi2jYCJmOmZV8TvD_uMrEU,2075
 panther/main.py,sha256=0i5HoJ4IGY2bF25lK1V6x7_f-boxceVz6zLj6Q6vTi8,7557
 panther/pagination.py,sha256=bQEpf-FMil6zOwGuGD6VEowht2_13sT5jl-Cflwo_-E,1644
 panther/permissions.py,sha256=UdPHVZYLWIYaf94OauE1QdVlj66_iE8B3rb336MBBcU,400
 panther/request.py,sha256=IVuDdLdceCzo2vmICnWwoD2ag1eNc09C5XHZnULQxUw,1888
-panther/response.py,sha256=k8ZQ6BIKuLc3vRRfSunm7twGixD6145ByWloSAqOrQQ,10495
+panther/response.py,sha256=WSWKlwb8l804W5SzmtKAQIavhmrdi3LHsG3xjBaMaos,10854
 panther/routings.py,sha256=QwE7EyQD1wdgXS8JK80tV36tIrrBR7fRZ1OkhpA8m7s,6482
-panther/serializer.py,sha256=SrVROW9HyZS2QZDwlcrs_5npByIk-4bijm6_vAj2M24,9064
+panther/serializer.py,sha256=e6iM09Uh6y6JrVGEzDlOfbB8vMTtSECW0Dy9_D6pn0A,8338
 panther/status.py,sha256=Gc_PnYrHfInTsZpGbqiCfDB-py1C7Rh8KMdb6Lq9Exs,3346
 panther/test.py,sha256=EReFLKhDtOoGQVTPSdtI31xi-u4SfwirA179G9_rIAE,7374
 panther/throttling.py,sha256=EnU9PtulAwNTxsheun-s-kjJ1YL3jgj0bpxe8jGowlQ,2630
@@ -33,13 +33,13 @@ panther/cli/run_command.py,sha256=ZInQQGV-QaLS7XUEUPqP_3iR2Nrto9unaOvYAs3mF9M,35
 panther/cli/template.py,sha256=C3jb6m_NQRzur-_DNtEKiptMYtxTvd5MNM1qIgpFMNA,5331
 panther/cli/utils.py,sha256=SjqggWpgGVH_JiMNQFnXPWzoMYxIHI2p9WO3-c59wU4,5542
 panther/db/__init__.py,sha256=w9lEL0vRqb18Qx_iUJipUR_fi5GQ5uVX0DWycx14x08,50
-panther/db/connections.py,sha256=AJpl7qgPuUTqDvuGW6VkLPRhNwrgTVoIDak3i7uI4GY,3982
-panther/db/cursor.py,sha256=glFyfVriOmluajlq77u7cKF2Gnmo6iF5qLqT63yeigg,1783
-panther/db/models.py,sha256=6WvWb9NkxZz7Srw0YCdZeIDNZt68nSEkuOoazh-Efm0,3250
+panther/db/connections.py,sha256=RMcnArf1eurxjySpSg5afNmyUCxo_ifxhG1I8mr9L7M,4191
+panther/db/cursor.py,sha256=TnbMUvEDpXGUuL42gDWT9QKFu5ymo0kLLo-Socgw7rM,1836
+panther/db/models.py,sha256=E9y0ibCp1nPAKejMBtAQrkngmp3fXdFkgHfsXtfCBYM,3206
 panther/db/utils.py,sha256=GiRQ4t9csEFKmGViej7dyfZaaiWMdTAQeWzdoCWTJac,1574
 panther/db/queries/__init__.py,sha256=uF4gvBjLBJ-Yl3WLqoZEVNtHCVhFRKW3_Vi44pJxDNI,45
-panther/db/queries/base_queries.py,sha256=GFPEvSV7SGAVpJFHiIkhfKBf0xkLsyXvmW7bRI88HOU,3738
-panther/db/queries/mongodb_queries.py,sha256=FTWcJc5vDy163Pn-_vyeeRlljs8SOKlARQ_gi3AvBtc,13389
+panther/db/queries/base_queries.py,sha256=0c1IxRl79C93JyEn5uno8WDBvyKTql_kyNND2ep5zqI,3817
+panther/db/queries/mongodb_queries.py,sha256=rN0vKUQHtimQ0ogNacwuz5c2irkPHkn8ydjF9dU7aJQ,13468
 panther/db/queries/pantherdb_queries.py,sha256=GlRRFvbaeVR3x2dYqlQIvsWxAWUcPflZ2u6kuJYvSIM,4620
 panther/db/queries/queries.py,sha256=nhjrFk02O-rLUZ5slS3jHZ9wnxPrFLmiAZLaeVePKiA,12408
 panther/middlewares/__init__.py,sha256=8VXd-K3L0a5ZkGb-NUipn3K8wxWAVIiOM7fQrcm_dTM,87
@@ -67,9 +67,9 @@ panther/panel/templates/login.html,sha256=W6V1rgHAno7yTbP6Il38ZvJp4LdlJ8BjM4UuyP
 panther/panel/templates/sidebar.html,sha256=XikovZsJrth0nvKogvZoh3Eb2Bq7xdeGTlsdlyud450,618
 panther/panel/templates/table.html,sha256=fWdaIHEHAuwuPaAfOtXkD-3yvSocyDmtys00_D2yRh8,2176
 panther/panel/templates/table.js,sha256=MTdf77571Gtmg4l8HkY-5fM-utIL3lc0O8hv6vLBCYk,10414
-panther-5.0.0b4.dist-info/licenses/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
-panther-5.0.0b4.dist-info/METADATA,sha256=2NiQy6W9FrVHUevwkWiTVcoJGUy7Z5dT_iKPKjZN7bI,7026
-panther-5.0.0b4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-panther-5.0.0b4.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
-panther-5.0.0b4.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
-panther-5.0.0b4.dist-info/RECORD,,
+panther-5.0.0b5.dist-info/licenses/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
+panther-5.0.0b5.dist-info/METADATA,sha256=pBsRQN6g2DoB1-aXY0DAAZt0A_HBwnpgdXuisbqbxoU,6269
+panther-5.0.0b5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+panther-5.0.0b5.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
+panther-5.0.0b5.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
+panther-5.0.0b5.dist-info/RECORD,,

panther-5.0.0b4.dist-info/METADATA

@@ -1,223 +0,0 @@
-Metadata-Version: 2.4
-Name: panther
-Version: 5.0.0b4
-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.2.3
-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)
-
-
-## Panther 
-<b>Is A Fast &  Friendly Web Framework For Building Async APIs With Python 3.10+</b> 
-
-<p align="center">
-  <img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="logo" style="width: 450px">
-</p>
-
-**_📚 Full Documentation:_** [PantherPy.GitHub.io](https://pantherpy.github.io)
-
----
-
-### Why Use Panther ?
-- Include Simple **File-Base** Database ([PantherDB](https://pypi.org/project/pantherdb/))
-- Built-in Document-oriented Databases **ODM** (**MongoDB**, PantherDB)
-- Built-in **Websocket** Support
-- Built-in API **Caching** System (In Memory, **Redis**)
-- Built-in **Authentication** Classes
-- Built-in **Permission** Classes
-- Built-in Visual API **Monitoring** (In Terminal)
-- Support Custom **Background Tasks**
-- Support Custom **Middlewares**
-- Support Custom **Throttling**
-- Support **Function-Base** and **Class-Base** APIs
-- It's One Of The **Fastest Python Framework** ([Benchmark](https://www.techempower.com/benchmarks/#section=test&runid=d3364379-1bf7-465f-bcb1-e9c65b4840f9&hw=ph&test=fortune&l=zik0zj-6bi))
----
-
-### Supported by
-<center>
-    <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>
-</center>
-
----
-
-### Installation
-```shell
-$ pip install panther
-```
-
-### Usage
-
-- #### Create Project
-
-    ```shell
-    $ panther create
-    ```
-
-- #### Run Project
-    
-    ```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_
-
-- #### Monitoring Requests
-
-    ```shell
-    $ panther monitor 
-    ```
-
-- #### Python Shell
-
-    ```shell
-    $ panther shell
-    ```
-  
----
-
-### API Example
-  - Create `main.py`
-
-    ```python
-    from datetime import datetime, timedelta
-    
-    from panther import status, Panther
-    from panther.app import GenericAPI
-    from panther.response import Response
-    
-    
-    class FirstAPI(GenericAPI):
-        # Cache Response For 10 Seconds
-        cache = True
-        cache_exp_time = timedelta(seconds=10)
-        
-        def get(self):
-            date_time = datetime.now().isoformat()
-            data = {'detail': f'Hello World | {date_time}'}
-            return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
-    
-    
-    url_routing = {'': FirstAPI}
-    app = Panther(__name__, configs=__name__, urls=url_routing)
-    ```
-
-  - Run the project:
-    - `$ panther run --reload` 
-  
-  - Checkout the [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
-
-### WebSocket Echo Example 
-  - Create `main.py`
-
-    ```python
-    from panther import Panther
-    from panther.app import GenericAPI
-    from panther.response import HTMLResponse
-    from panther.websocket import GenericWebsocket
-    
-    
-    class FirstWebsocket(GenericWebsocket):
-        async def connect(self, **kwargs):
-            await self.accept()
-    
-        async def receive(self, data: str | bytes):
-            await self.send(data)
-    
-    
-    class MainPage(GenericAPI):
-        def get(self):
-            template = """
-            <input type="text" id="messageInput">
-            <button id="sendButton">Send Message</button>
-            <ul id="messages"></ul>
-            <script>
-                var socket = new WebSocket('ws://127.0.0.1:8000/ws');
-                socket.addEventListener('message', function (event) {
-                    var li = document.createElement('li');
-                    document.getElementById('messages').appendChild(li).textContent = 'Server: ' + event.data;
-                });
-                function sendMessage() {
-                    socket.send(document.getElementById('messageInput').value);
-                }
-                document.getElementById('sendButton').addEventListener('click', sendMessage);
-            </script>
-            """
-            return HTMLResponse(template)
-    
-    url_routing = {
-        '': MainPage,
-        'ws': FirstWebsocket,
-    }
-    app = Panther(__name__, configs=__name__, urls=url_routing)
-
-    ```
-
-  - Run the project:
-    - `$ panther run --reload` 
-  - Go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) and work with your `websocket`
-
-
-
-> **Next Step: [First CRUD](https://pantherpy.github.io/function_first_crud)**
-
----
-
-### How Panther Works!
-
-![diagram](https://raw.githubusercontent.com/AliRn76/panther/master/docs/docs/images/diagram.png)
-
----
-
-### Roadmap
-
-![roadmap](https://raw.githubusercontent.com/AliRn76/panther/master/docs/docs/images/roadmap.jpg)
-
----
-
-**If you find this project useful, please give it a star ⭐️.**