panther 4.1.2__py3-none-any.whl → 4.2.0__py3-none-any.whl

panther/__init__.py

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

panther/app.py

@@ -60,6 +60,10 @@ class API:
         async def wrapper(request: Request) -> Response:
             self.request = request
 
+            # 0. Preflight
+            if self.request.method == 'OPTIONS':
+                return self.options()
+
             # 1. Check Method
             if self.methods and self.request.method not in self.methods:
                 raise MethodNotAllowedAPIError
@@ -141,6 +145,14 @@ class API:
         if self.input_model:
             self.request.validated_data = self.validate_input(model=self.input_model, request=self.request)
 
+    @classmethod
+    def options(cls):
+        headers = {
+            'Access-Control-Allow-Methods': 'DELETE, GET, PATCH, POST, PUT, OPTIONS',
+            'Access-Control-Allow-Headers': 'Accept, Authorization, User-Agent, Content-Type',
+        }
+        return Response(headers=headers)
+
     @classmethod
     def validate_input(cls, model, request: Request):
         if isinstance(request.data, bytes):
@@ -151,15 +163,15 @@ class API:
             # `request` will be ignored in regular `BaseModel`
             return model(**request.data, request=request)
         except ValidationError as validation_error:
-            error = {'.'.join(loc for loc in e['loc']): e['msg'] for e in validation_error.errors()}
+            error = {'.'.join(str(loc) for loc in e['loc']): e['msg'] for e in validation_error.errors()}
             raise BadRequestAPIError(detail=error)
         except JSONDecodeError:
             raise JSONDecodeAPIError
 
 
 class GenericAPI:
-    input_model: type[ModelSerializer] | type[BaseModel] = None
-    output_model: type[ModelSerializer] | type[BaseModel] = None
+    input_model: type[ModelSerializer] | type[BaseModel] | None = None
+    output_model: type[ModelSerializer] | type[BaseModel] | None = None
     auth: bool = False
     permissions: list | None = None
     throttling: Throttling | None = None
@@ -181,6 +193,12 @@ class GenericAPI:
     async def delete(self, *args, **kwargs):
         raise MethodNotAllowedAPIError
 
+    async def get_input_model(self, request: Request) -> type[ModelSerializer] | type[BaseModel] | None:
+        return None
+
+    async def get_output_model(self, request: Request) -> type[ModelSerializer] | type[BaseModel] | None:
+        return None
+
     async def call_method(self, request: Request):
         match request.method:
             case 'GET':
@@ -193,12 +211,14 @@ class GenericAPI:
                 func = self.patch
             case 'DELETE':
                 func = self.delete
+            case 'OPTIONS':
+                func = API.options
             case _:
                 raise MethodNotAllowedAPIError
 
         return await API(
-            input_model=self.input_model,
-            output_model=self.output_model,
+            input_model=self.input_model or await self.get_input_model(request=request),
+            output_model=self.output_model or await self.get_output_model(request=request),
             auth=self.auth,
             permissions=self.permissions,
             throttling=self.throttling,

panther/base_request.py

@@ -1,5 +1,6 @@
 from collections import namedtuple
 from collections.abc import Callable
+from urllib.parse import parse_qsl
 
 from panther.db import Model
 from panther.exceptions import InvalidPathVariableAPIError
@@ -74,11 +75,7 @@ class BaseRequest:
     @property
     def query_params(self) -> dict:
         if self._params is None:
-            self._params = {}
-            if (query_string := self.scope['query_string']) != b'':
-                for param in query_string.decode('utf-8').split('&'):
-                    k, *_, v = param.split('=')
-                    self._params[k] = v
+            self._params = {k: v for k, v in parse_qsl(self.scope['query_string'].decode('utf-8'))}
         return self._params
 
     @property

panther/cli/create_command.py

@@ -61,7 +61,7 @@ class CreateProject:
             },
             {
                 'field': 'database',
-                'message': '    0: PantherDB (File-Base, No Requirements)\n    1: MongoDB (Required `pymongo`)\n    2: No Database\nChoose Your Database (default is 0)',
+                'message': '    0: PantherDB (File-Base, No Requirements)\n    1: MongoDB (Required `motor`)\n    2: No Database\nChoose Your Database (default is 0)',
                 'validation_func': lambda x: x in ['0', '1', '2'],
                 'error_message': "Invalid Choice, '{}' not in ['0', '1', '2']",
             },

panther/cli/template.py

@@ -140,6 +140,7 @@ InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
 
 TIMEZONE = 'UTC'
 
+
 @API()
 async def hello_world_api():
     return {'detail': 'Hello World'}

panther/db/models.py

@@ -21,7 +21,7 @@ def validate_object_id(value, handler):
         else:
             try:
                 return bson.ObjectId(value)
-            except bson.objectid.InvalidId as e:
+            except Exception as e:
                 msg = 'Invalid ObjectId'
                 raise ValueError(msg) from e
     return str(value)

panther/db/queries/mongodb_queries.py

@@ -61,7 +61,7 @@ class BaseMongoDBQuery(BaseQuery):
 
     @classmethod
     async def aggregate(cls, pipeline: Sequence[dict]) -> Iterable[dict]:
-        return await db.session[cls.__name__].aggregate(pipeline)
+        return await db.session[cls.__name__].aggregate(pipeline).to_list(None)
 
     # # # # # Count # # # # #
     @classmethod
@@ -102,21 +102,36 @@ class BaseMongoDBQuery(BaseQuery):
 
     # # # # # Update # # # # #
     async def update(self, _update: dict | None = None, /, **kwargs) -> None:
-        document = self._merge(_update, kwargs)
-        document.pop('_id', None)
-        self._validate_data(data=document, is_updating=True)
+        merged_update_query = self._merge(_update, kwargs)
+        merged_update_query.pop('_id', None)
 
-        for field, value in document.items():
-            setattr(self, field, value)
-        update_fields = {'$set': document}
-        await db.session[self.__class__.__name__].update_one({'_id': self._id}, update_fields)
+        self._validate_data(data=merged_update_query, is_updating=True)
+
+        update_query = {}
+        for field, value in merged_update_query.items():
+            if field.startswith('$'):
+                update_query[field] = value
+            else:
+                update_query['$set'] = update_query.get('$set', {})
+                update_query['$set'][field] = value
+                setattr(self, field, value)
+
+        await db.session[self.__class__.__name__].update_one({'_id': self._id}, update_query)
 
     @classmethod
     async def update_one(cls, _filter: dict, _update: dict | None = None, /, **kwargs) -> bool:
         prepare_id_for_query(_filter, is_mongo=True)
-        update_fields = {'$set': cls._merge(_update, kwargs)}
+        merged_update_query = cls._merge(_update, kwargs)
+
+        update_query = {}
+        for field, value in merged_update_query.items():
+            if field.startswith('$'):
+                update_query[field] = value
+            else:
+                update_query['$set'] = update_query.get('$set', {})
+                update_query['$set'][field] = value
 
-        result = await db.session[cls.__name__].update_one(_filter, update_fields)
+        result = await db.session[cls.__name__].update_one(_filter, update_query)
         return bool(result.matched_count)
 
     @classmethod

panther/db/queries/queries.py

@@ -364,8 +364,6 @@ class Query(BaseQuery):
 
         raise NotFoundAPIError(detail=f'{cls.__name__} Does Not Exist')
 
-    @check_connection
-    @log_query
     async def save(self) -> None:
         """
         Save the document
@@ -384,8 +382,14 @@ class Query(BaseQuery):
             >>> user = User(name='Ali')
             >>> await user.save()
         """
-        document = self.model_dump(exclude=['_id'])
+        document = {field: getattr(self, field) for field in self.model_fields_set if field != 'request'}
+
         if self.id:
             await self.update(document)
         else:
             await self.insert_one(document)
+
+    async def reload(self) -> Self:
+        new_obj = await self.find_one(id=self.id)
+        [setattr(self, f, getattr(new_obj, f)) for f in new_obj.model_fields]
+        return self

panther/db/utils.py

@@ -54,5 +54,5 @@ def _convert_to_object_id(_id):
     try:
         return bson.ObjectId(_id)
     except bson.objectid.InvalidId:
-        msg = f'id={_id} is invalid bson.ObjectId'
-        raise bson.errors.InvalidId(msg)
+        logger.warning(f'id={_id} is not a valid bson.ObjectId')
+        return None

panther/file_handler.py

@@ -1,7 +1,7 @@
 from functools import cached_property
 
 from panther import status
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, field_validator, model_serializer
 
 from panther.exceptions import APIError
 
@@ -15,6 +15,23 @@ class File(BaseModel):
     def size(self):
         return len(self.file)
 
+    def save(self) -> str:
+        if hasattr(self, '_file_name'):
+            return self._file_name
+
+        self._file_name = self.file_name
+        # TODO: check for duplication
+        with open(self._file_name, 'wb') as file:
+            file.write(self.file)
+
+        return self.file_name
+
+    @model_serializer(mode='wrap')
+    def _serialize(self, handler):
+        result = handler(self)
+        result['path'] = self.save()
+        return result
+
     def __repr__(self) -> str:
         return f'{self.__repr_name__()}(file_name={self.file_name}, content_type={self.content_type})'
 

panther/generics.py

@@ -23,7 +23,7 @@ logger = logging.getLogger('panther')
 
 class ObjectRequired:
     def _check_object(self, instance):
-        if issubclass(type(instance), Model) is False:
+        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
 
@@ -129,9 +129,11 @@ class CreateAPI(GenericAPI):
     input_model: type[ModelSerializer]
 
     async def post(self, request: Request, **kwargs):
-        instance = await request.validated_data.create(
-            validated_data=request.validated_data.model_dump()
-        )
+        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'
+        })
         return Response(data=instance, status_code=status.HTTP_201_CREATED)
 
 
@@ -160,13 +162,30 @@ class UpdateAPI(GenericAPI, ObjectRequired):
 
 
 class DeleteAPI(GenericAPI, ObjectRequired):
+    async def pre_delete(self, instance, request: Request, **kwargs):
+        pass
+
+    async def post_delete(self, instance, request: Request, **kwargs):
+        pass
+
     async def delete(self, request: Request, **kwargs):
         instance = await self.object(request=request, **kwargs)
         self._check_object(instance)
 
+        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/serializer.py

@@ -65,8 +65,8 @@ class MetaModelSerializer:
 
         # Check `model` type
         try:
-            if not issubclass(model, Model):
-                msg = f'`{cls_name}.Config.model` is not subclass of `panther.db.Model`.'
+            if not issubclass(model, (Model, BaseModel)):
+                msg = f'`{cls_name}.Config.model` is not subclass of `panther.db.Model` or `pydantic.BaseModel`.'
                 raise AttributeError(msg) from None
         except TypeError:
             msg = f'`{cls_name}.Config.model` is not subclass of `panther.db.Model`.'

{panther-4.1.2.dist-info → panther-4.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.1.2
+Version: 4.2.0
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad

{panther-4.1.2.dist-info → panther-4.2.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
-panther/__init__.py,sha256=jygFzW2zuio44KfIpTdDG3C8iAGBD_vxBn8GVGODSDk,110
+panther/__init__.py,sha256=sduiFCRbp6Nv6i1LB-sOh5Eb8lOJMR-Plz6Th79QwCs,110
 panther/_load_configs.py,sha256=AVkoixkUFkBQiTmrLrwCmg0eiPW2U_Uw2EGNEGQRfnI,9281
 panther/_utils.py,sha256=j0rwIxTf0rtcZAAD-1nGE-_bWpvinyKtnwt3uO0hMmY,4330
-panther/app.py,sha256=vb4j8CKidFHD5HIfK1t96fr8URMYxkroW8dQH9SVj14,7385
+panther/app.py,sha256=e2eb4sXIaBje5vpcm4pbvvEO_sj83pLfBHCIZJFFX38,8222
 panther/authentications.py,sha256=gf7BVyQ8vXKhiumJAtD0aAK7uIHWx_snbOKYAKrYuVw,5677
 panther/background_tasks.py,sha256=HBYubDIiO_673cl_5fqCUP9zzimzRgRkDSkag9Msnbs,7656
-panther/base_request.py,sha256=Fwwpm-9bjAZdpzSdakmSas5BD3gh1nrc6iGcBxwa_94,4001
+panther/base_request.py,sha256=XD2v1gLWcCKHePowRxT6_fYnS4tdKFxTLINMX0HQu8M,3880
 panther/base_websocket.py,sha256=iJUIbrfnh3ZLXlmKxTswMw158eNvtBFi8RZ-aBBmc8w,10643
 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=SIK1Wqpfb_jKKt4xJPbYIhMY0QhtbhOXS68dIW4Y0bU,6671
+panther/file_handler.py,sha256=I94tpbtTVniBnnUMkFr3Eis6kPDt8sLzS5u8TzFrR5I,1323
+panther/generics.py,sha256=D2ia7M4ML15kMZiuCIMpL7ZfQhMmKpqE4wCmuRE-q4Y,7233
 panther/logging.py,sha256=k__vzvSrPpr1IsA4OLrBt1JHuRUBXr7ekPlBW0-9rbM,2209
 panther/main.py,sha256=UbIxwaojvY_vH9nYfBpkulRBqVEj4Lbl81Er4XW_KCY,9334
 panther/monitoring.py,sha256=y1F3c8FJlnmooM-m1nSyOTa9eWq0v1nHnmw9zz-4Kls,1314
@@ -20,38 +20,38 @@ panther/permissions.py,sha256=9-J5vzvEKa_PITwEVQbZZv8PG2FOu05YBlD5yMrKcfc,348
 panther/request.py,sha256=F9ZiAWSse7_6moAzqdoFInUN4zTKlzijh9AdU9w3Jfw,1673
 panther/response.py,sha256=Njp4zJozNic8J4ucG8Sgh-xeBZOgtoz2cfdDkJlGOWU,7582
 panther/routings.py,sha256=1eqbjubLnUUEQRlz8mIF464ImvCMjyasiekHBtxEQoQ,6218
-panther/serializer.py,sha256=MBT43UG8YBjp-UGaqe5-SPqQHIcDEjLAdBjHAVKyMJo,9059
+panther/serializer.py,sha256=UX-cVS-11KnxijUhPXsBs_Pb-Sm3EVzUQFTf9bFQT0A,9096
 panther/status.py,sha256=Gc_PnYrHfInTsZpGbqiCfDB-py1C7Rh8KMdb6Lq9Exs,3346
 panther/test.py,sha256=RsQtP5IURLWR__BihOjruWoX3NscmGDqDqj1CfAb3bI,7037
 panther/throttling.py,sha256=mVa_mGv6w_Ad7LLtV4eG5QpDwwNsk4QjFFi0mIHQBnE,231
 panther/utils.py,sha256=Iq5q1suIgBBQGO5UctwR4HXs8E6zclXNh5lYc8k1Vjg,3409
 panther/websocket.py,sha256=5WLw--Oa-6kGYbeRvO79hjbd0ARFcTTF40-hO_bdjmQ,1206
 panther/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-panther/cli/create_command.py,sha256=cVhz0VQOvEbpufFsevH9T1rYZ8T_Wsa89cpTiIVKTC0,10294
+panther/cli/create_command.py,sha256=mT5GFzsTYZbzqShNHlw_UIkMcWLw9btm2mTwcg7TlfI,10292
 panther/cli/main.py,sha256=pCqnOTazgMhTvFHTugutIsiFXueU5kx2VmGngwAl54Q,1679
 panther/cli/monitor_command.py,sha256=7N1-4W0Lu7yl5maehJowe04WH4nxZ1DumGDRATh82SQ,3139
 panther/cli/run_command.py,sha256=yWcDoWC-c4ph4M5EDj0jvR9xSjh-apG5r6-NpDdArUo,2195
-panther/cli/template.py,sha256=rsyKOQ0l2v3kdwmLiZxt5ecIhDzmFprCCv0uVAv7eQI,5319
+panther/cli/template.py,sha256=hVkY1A3HZDVGEZzRkMtYte6FagKGTAxoFeG0wot7Zn4,5320
 panther/cli/utils.py,sha256=Jd4YQ9H6lapVktl7ZmiORt30WVmKI85xcwsY-fMRq3c,5289
 panther/db/__init__.py,sha256=w9lEL0vRqb18Qx_iUJipUR_fi5GQ5uVX0DWycx14x08,50
 panther/db/connections.py,sha256=rps48Ic2r3SV2HD3df1OU7C4Pv8j98PVXU1O_FqF9Ak,4210
 panther/db/cursor.py,sha256=jJ6bhz_Zljt3-AoeVdi563e2q3MSDJPP33WVbQk-goE,1287
-panther/db/models.py,sha256=4g6Jm2TBTViC2ttpENzuRJyvPbvXYzEqHIZLiWekRUk,2575
-panther/db/utils.py,sha256=Uxh7UebkBv4thMCfooYW1pkuorFgocsbnBZJi-hHtdY,1582
+panther/db/models.py,sha256=GRbKXJiwnxQJ_SjuPfXPzA5miH_djZNTPPyqiRp5DI8,2561
+panther/db/utils.py,sha256=frSekBisjeHUHTiucgeiJNOGdrNcf3mjodupyeZjyKk,1575
 panther/db/queries/__init__.py,sha256=uF4gvBjLBJ-Yl3WLqoZEVNtHCVhFRKW3_Vi44pJxDNI,45
 panther/db/queries/base_queries.py,sha256=8HhdlsSW-lgz3-IrZYfOtHNC3TBWbCNErDR4XE718AY,3764
-panther/db/queries/mongodb_queries.py,sha256=GZkkmfFTSjLVNTH3jSl3VM7MVHnXE0Fg6ob77yEYRPQ,5034
+panther/db/queries/mongodb_queries.py,sha256=4CQRdmgmKFIpnv6xijS0BMJO-Sf5beyuzmw8Z9jLtnA,5599
 panther/db/queries/pantherdb_queries.py,sha256=_dA4gXk1IA5jzIy6_6o1zgdZeeka6SPihvQeSkj7h68,4481
-panther/db/queries/queries.py,sha256=IK7NmSodftRbmWXrW4ddxyOHWU4L3WyuMbY0uG1WeGE,11462
+panther/db/queries/queries.py,sha256=d6V4whHEYjtufoeqIC5lBNa_FGDW8_7AYeps48ilHDk,11665
 panther/middlewares/__init__.py,sha256=ydo0bSadGqa2v7Xy1oCTkF2uXrImedXjiyx2vPTwPhE,66
 panther/middlewares/base.py,sha256=tX0MBvDBkbsAB_DilRIYvcggSAqCzazRTb9MegZNdlA,843
 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.1.2.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
-panther-4.1.2.dist-info/METADATA,sha256=c0gW17fnBtGxqL-u4mM6gVckd4r3nrZRsbEKeh7MAOY,6376
-panther-4.1.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-panther-4.1.2.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
-panther-4.1.2.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
-panther-4.1.2.dist-info/RECORD,,
+panther-4.2.0.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
+panther-4.2.0.dist-info/METADATA,sha256=N0SkpG2_UqpwuGhnGC8zOUdmnMYKNaaJG4sJaYl0UEk,6376
+panther-4.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+panther-4.2.0.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
+panther-4.2.0.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
+panther-4.2.0.dist-info/RECORD,,