panther 4.1.2__tar.gz → 4.2.0__tar.gz

{panther-4.1.2 → panther-4.2.0}/PKG-INFO

@@ -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 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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-4.1.2 → panther-4.2.0}/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 → panther-4.2.0}/panther.egg-info/PKG-INFO

@@ -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 → panther-4.2.0}/tests/test_database.py

@@ -227,6 +227,21 @@ class _BaseDatabaseTestCase:
         for book in books:
             assert isinstance(book, Book)
 
+    async def test_aggregation(self):
+        # Insert Many
+        insert_count = await self._insert_many()
+
+        # Find All with aggregate
+        books = await Book.aggregate([])
+        _len = sum(1 for _ in books)
+
+        assert isinstance(books, list)
+
+        assert _len == insert_count
+        for book in books:
+            assert isinstance(book, dict)
+            assert {*book.keys()} == {'_id', 'name', 'author', 'pages_count'}
+
     # # # Count
     async def test_count_all(self):
         # Insert Many
@@ -502,6 +517,9 @@ class TestPantherDB(_BaseDatabaseTestCase, IsolatedAsyncioTestCase):
     def tearDown(self) -> None:
         Path(self.DB_PATH).unlink()
 
+    async def test_aggregation(self):
+        pass
+
 
 @pytest.mark.mongodb
 class TestMongoDB(_BaseDatabaseTestCase, IsolatedAsyncioTestCase):