panther 1.4.0__tar.gz → 1.5.0__tar.gz

{panther-1.4.0 → panther-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 1.4.0
+Version: 1.5.0
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -25,7 +25,7 @@ License-File: LICENSE
 ---
 
 ### Features
-- Document-oriented Databases ORM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
+- Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
 - Cache APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)

{panther-1.4.0 → panther-1.5.0}/README.md

@@ -9,7 +9,7 @@
 ---
 
 ### Features
-- Document-oriented Databases ORM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
+- Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
 - Cache APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)

{panther-1.4.0 → panther-1.5.0}/panther/__init__.py

@@ -1,6 +1,6 @@
 from .main import Panther
 
-__version__ = '1.4.0'
+__version__ = '1.5.0'
 
 
 def version():

{panther-1.4.0 → panther-1.5.0}/panther/db/connection.py

@@ -1,6 +1,7 @@
 from redis import Redis
 from pantherdb import PantherDB
 from panther.configs import config
+from panther.cli.utils import error
 
 
 class Singleton(object):
@@ -19,9 +20,8 @@ class DBSession(Singleton):
         if db_url:
             self._db_name = db_url[:db_url.find(':')]
             match self._db_name:
-                # case 'mongodb':
-                #     # TODO: Check pymongo installed or not
-                #     self._create_mongodb_session(db_url)
+                case 'mongodb':
+                    self._create_mongodb_session(db_url)
                 case 'pantherdb':
                     self._create_pantherdb_session(db_url[12:])
                 case _:
@@ -37,8 +37,12 @@ class DBSession(Singleton):
         return self._db_name
 
     def _create_mongodb_session(self, db_url: str) -> None:
-        from pymongo import MongoClient
-        from pymongo.database import Database
+        try:
+            from pymongo import MongoClient
+            from pymongo.database import Database
+        except ImportError:
+            error('No module named "pymongo"\n\nHint: Try to install with "pip install pymongo"')
+            raise ImportError(error)
         self._client: MongoClient = MongoClient(db_url)
         self._session: Database = self._client.get_database()
 
@@ -56,7 +60,6 @@ class RedisConnection(Singleton, Redis):
     is_connected: bool = False
 
     def __init__(self, host: str | None = None, port: int | None = None, **kwargs):
-        # TODO: Check redis installed or not
         if host and port:
             super().__init__(host=host, port=port, **kwargs)
             self.is_connected = True

panther-1.5.0/panther/db/queries/mongodb_queries.py

@@ -0,0 +1,85 @@
+from typing import Self
+
+from panther.db.connection import db  # NOQA: F401
+from panther.exceptions import DBException
+from panther.db.utils import clean_object_id_in_dicts, merge_dicts
+
+
+class BaseMongoDBQuery:
+
+    @classmethod
+    def _merge(cls, *args) -> dict:
+        clean_object_id_in_dicts(*args)
+        # TODO: Convert "id" to "_id"
+        return merge_dicts(*args)
+
+    # # # # # Find # # # # #
+    @classmethod
+    def find_one(cls, _data: dict = None, /, **kwargs) -> Self | None:
+        _query = cls._merge(_data, kwargs)
+        if document := eval(f'db.session.{cls.__name__}.find_one(_query)'):
+            return cls(**document)
+
+    @classmethod
+    def find(cls, _data: dict = None, /, **kwargs) -> list[Self]:
+        _query = cls._merge(_data, kwargs)
+        documents = eval(f'db.session.{cls.__name__}.find(_query)')
+        return [cls(**document) for document in documents]
+
+    # # # # # Insert # # # # #
+    @classmethod
+    def insert_one(cls, _data: dict = None, **kwargs) -> Self:
+        document = cls._merge(_data, kwargs)
+        document['id'] = eval(f'db.session.{cls.__name__}.insert_one(document)').inserted_id
+        return cls(**document)
+
+    @classmethod
+    def insert_many(cls, _data: dict = None, **kwargs) -> Self:
+        raise DBException('insert_many() is not supported while using MongoDB.')
+
+    # # # # # Delete # # # # #
+    def delete(self) -> None:
+        _filter = {'_id': self._id}
+        eval(f'db.session.{self.__class__.__name__}.delete_one(_filter)')
+
+    @classmethod
+    def delete_one(cls, _data: dict = None, /, **kwargs) -> bool:
+        _query = cls._merge(_data, kwargs)
+        result = eval(f'db.session.{cls.__name__}.delete_one(_query)')
+        return bool(result.deleted_count)
+
+    @classmethod
+    def delete_many(cls, _data: dict = None, /, **kwargs) -> int:
+        _query = cls._merge(_data, kwargs)
+        result = eval(f'db.session.{cls.__name__}.delete_many(_query)')
+        return result.deleted_count
+
+    # # # # # Update # # # # #
+    def update(self, **kwargs) -> None:
+        for field, value in kwargs.items():
+            setattr(self, field, value)
+        _filter = {'_id': self._id}
+        _update = {'$set': kwargs}
+        eval(f'db.session.{self.__class__.__name__}.update_one(_filter, _update)')
+
+    @classmethod
+    def update_one(cls, _filter, _data: dict = None, /, **kwargs) -> bool:
+        clean_object_id_in_dicts(_filter)
+        _update = {'$set': kwargs | {}}
+        if isinstance(_data, dict):
+            _data['$set'] = _data.get('$set', {}) | (kwargs or {})
+
+        result = eval(f'db.session.{cls.__name__}.update_one(_filter, _data | _update)')
+        return bool(result.updated_count)
+
+    @classmethod
+    def update_many(cls, _filter, _data: dict = None, /, **kwargs) -> int:
+        _update = {'$set': cls._merge(_data, kwargs)}
+        result = eval(f'db.session.{cls.__name__}.update_many(_filter, _update)')
+        return result.updated_count
+
+    # # # # # Other # # # # #
+    @classmethod
+    def count(cls, _data: dict = None, /, **kwargs) -> int:
+        _query = cls._merge(_data, kwargs)
+        return eval(f'db.session.{cls.__name__}.count_documents(_query)')

{panther-1.4.0 → panther-1.5.0}/panther/db/queries/pantherdb_queries.py

@@ -1,5 +1,4 @@
 from typing import Self
-from pydantic import ValidationError
 
 from panther.db.connection import db
 from panther.db.utils import merge_dicts
@@ -8,26 +7,6 @@ from panther.exceptions import DBException
 
 class BasePantherDBQuery:
 
-    @classmethod
-    def validate_data(cls, data: dict, is_updating: bool = False) -> Self | None:
-        """
-        *. Validate the input of user with its class
-        *. If is_updating is True & exception happens but the message was empty
-                Then return nothing (we don't need the obj on update())
-                & we don't have access to the obj after exception ...
-        """
-        try:
-            obj = cls(**data)
-        except ValidationError as validation_error:
-            error = ', '.join(
-                '{field}="{error}"'.format(field=e['loc'][0], error=e['msg'])
-                for e in validation_error.errors() if not is_updating or e['type'] != 'value_error.missing')
-            if error:
-                message = f'{cls.__name__}({error})'
-                raise DBException(message)
-        else:
-            return obj
-
     @classmethod
     def _merge(cls, *args) -> dict:
         # TODO: Convert "id" to "_id"
@@ -36,7 +15,7 @@ class BasePantherDBQuery:
     # # # # # Find # # # # #
     @classmethod
     def find_one(cls, _data: dict = None, /, **kwargs) -> Self | None:
-        if document := db.session.collection(cls.__name__).first(**cls._merge(_data, kwargs)):
+        if document := db.session.collection(cls.__name__).find_one(**cls._merge(_data, kwargs)):
             return cls(**document)
 
     @classmethod
@@ -47,13 +26,12 @@ class BasePantherDBQuery:
     # # # # # Insert # # # # #
     @classmethod
     def insert_one(cls, _data: dict = None, **kwargs) -> Self:
-        obj = cls.validate_data(kwargs)
-        obj.id = db.session.collection(cls.__name__).insert_one(**cls._merge(_data, kwargs))['_id']
-        return obj
+        document = db.session.collection(cls.__name__).insert_one(**cls._merge(_data, kwargs))
+        return cls(**document)
 
     @classmethod
     def insert_many(cls, _data: dict = None, /, **kwargs):
-        raise DBException('increment() is not supported while using SlarkDB.')
+        raise DBException('insert_many() is not supported while using PantherDB.')
 
     # # # # # Delete # # # # #
     def delete(self) -> None:
@@ -69,7 +47,8 @@ class BasePantherDBQuery:
 
     # # # # # Update # # # # #
     def update(self, **kwargs) -> None:
-        self.validate_data(kwargs, is_updating=True)
+        for field, value in kwargs.items():
+            setattr(self, field, value)
         db.session.collection(self.__class__.__name__).update_one({'_id': self.id}, **kwargs)
 
     @classmethod
@@ -81,16 +60,6 @@ class BasePantherDBQuery:
         return db.session.collection(cls.__name__).update_many(_filter, **cls._merge(_data, kwargs))
 
     # # # # # Other # # # # #
-    @classmethod
-    def first(cls, _data: dict = None, /, **kwargs) -> Self | None:
-        if document := db.session.collection(cls.__name__).first(**cls._merge(_data, kwargs)):
-            return cls(**document)
-
-    @classmethod
-    def last(cls, _data: dict = None, /, **kwargs) -> Self | None:
-        if document := db.session.collection(cls.__name__).last(**cls._merge(_data, kwargs)):
-            return cls(**document)
-
     @classmethod
     def count(cls, _data: dict = None, /, **kwargs) -> int:
         return db.session.collection(cls.__name__).count(**cls._merge(_data, kwargs))

{panther-1.4.0 → panther-1.5.0}/panther/db/queries/queries.py

@@ -1,9 +1,12 @@
 from typing import Self
 
+from pydantic import ValidationError
+
 from panther.configs import config
 from panther.db.utils import log_query
 from panther.db.queries.mongodb_queries import BaseMongoDBQuery
 from panther.db.queries.pantherdb_queries import BasePantherDBQuery
+from panther.exceptions import DBException
 
 if config['db_engine'] == 'pantherdb':
     BaseQuery = BasePantherDBQuery
@@ -17,6 +20,22 @@ __all__ = (
 
 class Query(BaseQuery):
 
+    @classmethod
+    def validate_data(cls, data: dict, is_updating: bool = False) -> Self | None:
+        """
+        *. Validate the input of user with its class
+        *. If is_updating is True & exception happens but the message was empty
+        """
+        try:
+            cls(**data)
+        except ValidationError as validation_error:
+            error = ', '.join(
+                '{field}="{error}"'.format(field=e['loc'][0], error=e['msg'])
+                for e in validation_error.errors() if not is_updating or e['type'] != 'value_error.missing')
+            if error:
+                message = f'{cls.__name__}({error})'
+                raise DBException(message)
+
     # # # # # Find # # # # #
     @classmethod
     @log_query
@@ -47,6 +66,7 @@ class Query(BaseQuery):
             >>> from example.app.models import User
             >>> User.insert_one(name='Ali', age=24, ...)
         """
+        cls.validate_data(kwargs)
         return super().insert_one(_data, **kwargs)
 
     @classmethod
@@ -94,6 +114,7 @@ class Query(BaseQuery):
             >>> user = User.find_one(name='Ali')
             >>> user.update(name='Saba')
         """
+        self.validate_data(kwargs, is_updating=True)
         return super().update(**kwargs)
 
     @classmethod
@@ -120,31 +141,33 @@ class Query(BaseQuery):
     # # # # # Other # # # # #
     @classmethod
     @log_query
-    def first(cls, _data: dict = None, /, **kwargs) -> Self | None:
+    def last(cls, _data: dict = None, /, **kwargs) -> Self | None:
         """
-        It works same as find_one()
         example:
             >>> from example.app.models import User
-            >>> User.first(name='Ali')
+            >>> user = User.last(name='Ali')
         """
-        return super().first(_data, **kwargs)
+        return super().last(_data, **kwargs)
 
     @classmethod
     @log_query
-    def last(cls, _data: dict = None, /, **kwargs) -> Self | None:
+    def count(cls, _data: dict = None, /, **kwargs) -> int:
         """
         example:
             >>> from example.app.models import User
-            >>> User.last(name='Ali')
+            >>> User.count(name='Ali')
         """
-        return super().last(_data, **kwargs)
+        return super().count(_data, **kwargs)
 
     @classmethod
     @log_query
-    def count(cls, _data: dict = None, /, **kwargs) -> int:
+    def find_or_insert(cls, **kwargs) -> tuple[bool, any]:
         """
         example:
             >>> from example.app.models import User
-            >>> User.count(name='Ali')
+            >>> user = User.find_or_insert(name='Ali')
         """
-        return super().count(_data, **kwargs)
+        if obj := cls.find_one(**kwargs):
+            return False, obj
+        else:
+            return True, cls.insert_one(**kwargs)

{panther-1.4.0 → panther-1.5.0}/panther.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 1.4.0
+Version: 1.5.0
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -25,7 +25,7 @@ License-File: LICENSE
 ---
 
 ### Features
-- Document-oriented Databases ORM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
+- Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
 - Cache APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)

{panther-1.4.0 → panther-1.5.0}/panther.egg-info/requires.txt

@@ -1,6 +1,7 @@
 pantherdb>=1.2.0
 pydantic>=1.10.5
-uvicorn==0.20.0
+watchfiles>=0.18.1
+uvicorn[standard]
 bpython>=0.24
 bson>=0.5.10
 redis>=4.0.2

{panther-1.4.0 → panther-1.5.0}/setup.py

@@ -45,7 +45,8 @@ setup(
     install_requires=[
         'pantherdb>=1.2.0',
         'pydantic>=1.10.5',
-        'uvicorn==0.20.0',
+        'watchfiles>=0.18.1',
+        'uvicorn[standard]',
         'bpython>=0.24',
         'bson>=0.5.10',
         'redis>=4.0.2',

panther-1.4.0/panther/db/queries/mongodb_queries.py

@@ -1,90 +0,0 @@
-from typing import TypeVar
-
-import bson
-
-from panther.db.connection import db  # NOQA: F401
-from panther.db.utils import clean_object_id_in_dicts, merge_dicts, log_query
-
-# TODO: Not sure about this bounding
-T = TypeVar('T', bound='BaseMongoDBQuery')
-
-
-class BaseMongoDBQuery:
-
-    @classmethod
-    def get_one(cls: type[T], _data: dict = None, /, **kwargs) -> T:
-        clean_object_id_in_dicts(_data, kwargs)
-        _query = merge_dicts(_data, kwargs)
-        obj = eval(f'db.session.{cls.__name__}.find_one(_query)')
-        return cls(**obj) if obj else None
-
-    @classmethod
-    def count(cls, _data: dict = None, /, **kwargs) -> int:
-        clean_object_id_in_dicts(_data, kwargs)
-        _query = merge_dicts(_data, kwargs)
-        return eval(f'db.session.{cls.__name__}.count_documents(_query)')
-
-    @classmethod
-    def list(cls, _data: dict = None, /, **kwargs):
-        clean_object_id_in_dicts(_data, kwargs)
-        _query = merge_dicts(_data, kwargs)
-        result = eval(f'db.session.{cls.__name__}.find(_query)')
-        return [cls(**obj) for obj in result]
-
-    @classmethod
-    def create(cls, _data: dict = None, **kwargs) -> bson.objectid.ObjectId:
-        _query = merge_dicts(_data, kwargs)
-        return eval(f'db.session.{cls.__name__}.insert_one(_query)').inserted_id
-
-    def delete(self) -> bool:
-        _filter = {'_id': self._id}
-        result = eval(f'db.session.{self.__class__.__name__}.delete_one(_filter)')
-        return bool(result.deleted_count)
-
-    @classmethod
-    def delete_one(cls, **kwargs) -> bool:
-        clean_object_id_in_dicts(kwargs)
-        result = eval(f'db.session.{cls.__name__}.delete_one(kwargs)')
-        return bool(result.deleted_count)
-
-    @classmethod
-    def delete_many(cls, **kwargs) -> int:
-        clean_object_id_in_dicts(kwargs)
-        result = eval(f'db.session.{cls.__name__}.delete_many(kwargs)')
-        return result.deleted_count
-
-    def update(self, _data: dict = None, **kwargs) -> dict:
-        for field, value in (_data or kwargs).items():
-            if hasattr(self, field):
-                setattr(self, field, value)
-        _filter = {'_id': self._id}
-        _update = {'$set': kwargs}
-        return eval(f'db.session.{self.__class__.__name__}.update_one(_filter, _update)')
-
-    @classmethod
-    def update_one(cls, _filter, _data: dict = None, /, **kwargs) -> dict:
-        clean_object_id_in_dicts(_filter)
-
-        _update = {'$set': kwargs | {}}
-        if isinstance(_data, dict):
-            _data['$set'] = _data.get('$set', {}) | (kwargs or {})
-
-        return eval(f'db.session.{cls.__name__}.update_one(_filter, _data | _update)')
-
-    @classmethod
-    def update_many(cls, _filter, **kwargs) -> dict:
-        _update = {'$set': kwargs}
-        return eval(f'db.session.{cls.__name__}.update_many(_filter, _update)')
-
-    @classmethod
-    def increment(cls, _filter, **kwargs):
-        _update = {'$inc': kwargs}
-        return eval(f'db.session.{cls.__name__}.update_many({_filter}, {_update})')
-
-    @classmethod
-    def get_or_create(cls, **kwargs) -> tuple[bool, any]:
-        obj = cls.get_one(**kwargs)
-        if obj:
-            return False, obj
-        else:
-            return True, cls.create(**kwargs)

{panther-1.4.0 → panther-1.5.0}/panther/main.py

@@ -4,12 +4,12 @@ from runpy import run_path
 from pydantic.main import ModelMetaclass
 
 from panther import status
-from panther.configs import JWTConfig, config
+from panther.request import Request
+from panther.response import Response
 from panther.exceptions import APIException
+from panther.configs import JWTConfig, config
 from panther.middlewares.base import BaseMiddleware
 from panther.middlewares.monitoring import Middleware as MonitoringMiddleware
-from panther.request import Request
-from panther.response import Response
 from panther.routings import find_endpoint, check_urls, collect_urls, finalize_urls
 from panther._utils import http_response, import_class, read_body, collect_path_variables