panther 1.7.8__tar.gz → 1.7.10__tar.gz

{panther-1.7.8 → panther-1.7.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 1.7.8
+Version: 1.7.10
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -8,8 +8,10 @@ Author-email: alirn76@yahoo.com
 License: MIT
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Provides-Extra: full
 License-File: LICENSE
@@ -18,7 +20,7 @@ License-File: LICENSE
 <b>Is A Fast &  Friendly Web Framework For Building Async APIs With Python 3.11+</b> 
 
 <p align="center">
-<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo.png" alt="logo" style="width: 200px">
+<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="logo" style="width: 450px">
 </p>
 
 >_Full Documentation_ -> [https://pantherpy.github.io](https://pantherpy.github.io)
@@ -27,7 +29,7 @@ License-File: LICENSE
 
 ---
 
-### Why Use Panther ?
+### Why Use Panther?
 - Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
 - Caching for APIs (In Memory, In Redis)

{panther-1.7.8 → panther-1.7.10}/README.md

@@ -2,7 +2,7 @@
 <b>Is A Fast &  Friendly Web Framework For Building Async APIs With Python 3.11+</b> 
 
 <p align="center">
-<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo.png" alt="logo" style="width: 200px">
+<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="logo" style="width: 450px">
 </p>
 
 >_Full Documentation_ -> [https://pantherpy.github.io](https://pantherpy.github.io)
@@ -11,7 +11,7 @@
 
 ---
 
-### Why Use Panther ?
+### Why Use Panther?
 - Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
 - Caching for APIs (In Memory, In Redis)

{panther-1.7.8 → panther-1.7.10}/panther/__init__.py

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

{panther-1.7.8 → panther-1.7.10}/panther/_utils.py

@@ -102,13 +102,3 @@ def read_multipart_form_data(content_type: str, body: str) -> dict:
             # fields[field_name] = data
             logger.error("We Don't Handle Files In Multipart Request Yet.")
     return fields
-
-
-def collect_path_variables(request_path: str, found_path: str) -> dict:
-    found_path = found_path.removesuffix('/').removeprefix('/')
-    request_path = request_path.removesuffix('/').removeprefix('/')
-    path_variables = dict()
-    for f_path, r_path in zip(found_path.split('/'), request_path.split('/')):
-        if f_path.startswith('<'):
-            path_variables[f_path[1:-1]] = r_path
-    return path_variables

{panther-1.7.8 → panther-1.7.10}/panther/app.py

@@ -137,7 +137,7 @@ class API:
     def serialize_with_output_model(self, data: any):
         # Dict
         if isinstance(data, dict):
-            return self.output_model(**data).dict()
+            return self.output_model(**data).model_dump()
 
         # Iterable
         elif isinstance(data, IterableDataTypes):

{panther-1.7.8 → panther-1.7.10}/panther/authentications.py

@@ -1,3 +1,4 @@
+from abc import abstractmethod
 from datetime import datetime
 from panther.logger import logger
 from panther.configs import config
@@ -12,7 +13,22 @@ except ImportError:
     exit()
 
 
-class JWTAuthentication:
+class BaseAuthentication:
+    @classmethod
+    @abstractmethod
+    def authentication(cls, request: Request):
+        """
+        Return User Instance
+        """
+        raise cls.exception(f'{cls.__name__}.authentication() is not implemented.')
+
+    @staticmethod
+    def exception(message: str, /):
+        logger.error(f'Authentication Error: "{message}"')
+        return AuthenticationException
+
+
+class JWTAuthentication(BaseAuthentication):
     model = BaseUser
     keyword = 'Bearer'
     algorithm = 'HS256'

{panther-1.7.8 → panther-1.7.10}/panther/caching.py

@@ -12,7 +12,7 @@ from panther.response import Response, ResponseDataTypes
 
 
 caches = dict()
-Cached = namedtuple('Cached', ['data', 'status_code'])
+CachedResponse = namedtuple('Cached', ['data', 'status_code'])
 
 
 def cache_key(request: Request, /):
@@ -20,7 +20,7 @@ def cache_key(request: Request, /):
     return f'{client}-{request.path}-{request.data}'
 
 
-def get_cached_response_data(*, request: Request) -> Cached | None:
+def get_cached_response_data(*, request: Request) -> CachedResponse | None:
     """
     If redis.is_connected:
         Get Cached Data From Redis
@@ -31,14 +31,14 @@ def get_cached_response_data(*, request: Request) -> Cached | None:
     if redis.is_connected:  # NOQA: Unresolved References
         data = (redis.get(key) or b'{}').decode()
         if cached := json.loads(data):
-            return Cached(*cached)
+            return CachedResponse(*cached)
         else:
             return None
 
     else:
         global caches
         if cached := caches.get(key):
-            return Cached(*cached)
+            return CachedResponse(*cached)
         else:
             return None
 

{panther-1.7.8 → panther-1.7.10}/panther/configs.py

@@ -2,7 +2,7 @@ from pathlib import Path
 from typing import TypedDict
 from datetime import timedelta
 from dataclasses import dataclass
-from pydantic.main import ModelMetaclass
+from pydantic._internal._model_construction import ModelMetaclass
 
 from panther.throttling import Throttling
 
@@ -18,32 +18,32 @@ class Config(TypedDict):
     base_dir: Path
     monitoring: bool
     log_queries: bool
-    urls: dict
-    middlewares: list
-    reversed_middlewares: list
-    db_engine: str
     default_cache_exp: timedelta | None
+    throttling: Throttling | None
     secret_key: bytes | None
+    middlewares: list
+    reversed_middlewares: list
+    user_model: ModelMetaclass | None
     authentication: ModelMetaclass | None
     jwt_config: JWTConfig | None
-    user_model: ModelMetaclass | None
-    throttling: Throttling | None
     models: list[dict]
+    urls: dict
+    db_engine: str
 
 
 config: Config = {
     'base_dir': Path(),
     'monitoring': False,
     'log_queries': False,
+    'default_cache_exp': None,
+    'throttling': None,
     'secret_key': None,
-    'urls': {},
     'middlewares': [],
     'reversed_middlewares': [],
-    'db_engine': '',
-    'default_cache_exp': None,
-    'jwt_config': None,
-    'authentication': None,
     'user_model': None,
-    'throttling': None,
+    'authentication': None,
+    'jwt_config': None,
     'models': [],
+    'urls': {},
+    'db_engine': '',  # TODO: Should we set default db_engine=pantherdb ?
 }

panther-1.7.10/panther/db/models.py

@@ -0,0 +1,38 @@
+import bson
+from pydantic import field_validator, Field, BaseModel as PydanticBaseModel
+
+from panther.configs import config
+from panther.db.queries import Query
+
+
+if config['db_engine'] == 'pantherdb':
+    IDType = int
+else:
+    IDType = str
+
+
+class Model(PydanticBaseModel, Query):
+    id: IDType | None = Field(validation_alias='_id')
+
+    @field_validator('id', mode='before')
+    def validate_id(cls, value):
+        if isinstance(value, str):
+            try:
+                bson.ObjectId(value)
+            except Exception:
+                raise ValueError('Invalid ObjectId')
+        elif not isinstance(value, bson.ObjectId):
+            raise ValueError('ObjectId required')
+        return str(value)
+
+    @property
+    def _id(self):
+        if IDType is int:
+            return self.id
+        else:
+            return bson.ObjectId(self.id) if self.id else None
+
+
+class BaseUser(Model):
+    first_name: str | None
+    last_name: str | None

{panther-1.7.8 → panther-1.7.10}/panther/db/queries/mongodb_queries.py

@@ -1,10 +1,17 @@
-from typing import Self
+import sys
 
 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
 
 
+if sys.version_info.minor >= 11:
+    from typing import Self
+else:
+    from typing import TypeVar
+    Self = TypeVar("Self", bound="BaseMongoDBQuery")
+
+
 class BaseMongoDBQuery:
 
     @classmethod
@@ -65,16 +72,16 @@ class BaseMongoDBQuery:
     @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 {})
+        _update = {'$set': cls._merge(_data, kwargs)}
 
-        result = eval(f'db.session.{cls.__name__}.update_one(_filter, _data | _update)')
+        result = eval(f'db.session.{cls.__name__}.update_one(_filter, _update)')
         return bool(result.updated_count)
 
     @classmethod
     def update_many(cls, _filter, _data: dict = None, /, **kwargs) -> int:
+        clean_object_id_in_dicts(_filter)
         _update = {'$set': cls._merge(_data, kwargs)}
+
         result = eval(f'db.session.{cls.__name__}.update_many(_filter, _update)')
         return result.updated_count
 

{panther-1.7.8 → panther-1.7.10}/panther/db/queries/pantherdb_queries.py

@@ -1,10 +1,17 @@
-from typing import Self
+import sys
 
 from panther.db.connection import db
-from panther.db.utils import merge_dicts
+from panther.db.utils import merge_dicts, clean_object_id_in_dicts
 from panther.exceptions import DBException
 
 
+if sys.version_info.minor >= 11:
+    from typing import Self
+else:
+    from typing import TypeVar
+    Self = TypeVar("Self", bound="BasePantherDBQuery")
+
+
 class BasePantherDBQuery:
 
     @classmethod
@@ -53,10 +60,12 @@ class BasePantherDBQuery:
 
     @classmethod
     def update_one(cls, _filter, _data: dict = None, /, **kwargs) -> bool:
+        clean_object_id_in_dicts(_filter)
         return db.session.collection(cls.__name__).update_one(_filter, **cls._merge(_data, kwargs))
 
     @classmethod
     def update_many(cls, _filter, _data: dict = None, /, **kwargs) -> int:
+        clean_object_id_in_dicts(_filter)
         return db.session.collection(cls.__name__).update_many(_filter, **cls._merge(_data, kwargs))
 
     # # # # # Other # # # # #

{panther-1.7.8 → panther-1.7.10}/panther/db/queries/queries.py

@@ -1,4 +1,5 @@
-from typing import Self, NoReturn
+import sys
+from typing import NoReturn
 
 from pydantic import ValidationError
 
@@ -18,6 +19,13 @@ __all__ = (
 )
 
 
+if sys.version_info.minor >= 11:
+    from typing import Self
+else:
+    from typing import TypeVar
+    Self = TypeVar("Self", bound="Query")
+
+
 class Query(BaseQuery):
 
     @classmethod
@@ -43,7 +51,7 @@ class Query(BaseQuery):
         """
         example:
             >>> from example.app.models import User
-            >>> User.find(id=1)
+            >>> User.find_one(id=1)
         """
         return super().find_one(_data, **kwargs)
 
@@ -71,7 +79,7 @@ class Query(BaseQuery):
 
     @classmethod
     @log_query
-    def insert_many(cls, _data: dict = None, **kwargs):
+    def insert_many(cls, _data: dict = None, /, **kwargs):
         return super().insert_many(_data, **kwargs)
 
     # # # # # Delete # # # # #
@@ -87,23 +95,23 @@ class Query(BaseQuery):
 
     @classmethod
     @log_query
-    def delete_one(cls, **kwargs) -> bool:
+    def delete_one(cls, _data: dict = None, /, **kwargs) -> bool:
         """
         example:
             >>> from example.app.models import User
             >>> User.delete_one(id=1)
         """
-        return super().delete_one(**kwargs)
+        return super().delete_one(_data, **kwargs)
 
     @classmethod
     @log_query
-    def delete_many(cls, **kwargs) -> int:
+    def delete_many(cls, _data: dict = None, /, **kwargs) -> int:
         """
         example:
             >>> from example.app.models import User
             >>> User.delete_many(last_name='Rn')
         """
-        return super().delete_many(**kwargs)
+        return super().delete_many(_data, **kwargs)
 
     # # # # # Update # # # # #
     @log_query
@@ -171,3 +179,14 @@ class Query(BaseQuery):
             return False, obj
         else:
             return True, cls.insert_one(**kwargs)
+
+    @log_query
+    def save(self, **kwargs) -> None:
+        """
+        example:
+            >>> from example.app.models import User
+            >>> user = User.find_one(name='Ali')
+            >>> user.name = 'Saba'
+            >>> user.save()
+        """
+        raise DBException('save() is not supported yes')

{panther-1.7.8 → panther-1.7.10}/panther/logger.py

@@ -7,8 +7,6 @@ from logging.config import dictConfig
 
 
 LOGS_DIR = config['base_dir'] / 'logs'
-if not os.path.exists(LOGS_DIR):
-    os.makedirs(LOGS_DIR)
 
 
 class LogConfig(BaseModel):
@@ -20,10 +18,10 @@ class LogConfig(BaseModel):
     LOG_LEVEL: str = 'DEBUG'
     MAX_FILE_SIZE: int = 1024 * 1024 * 100  # 100 MB
 
-    version = 1
-    disable_existing_loggers = False
+    version: int = 1
+    disable_existing_loggers: bool = False
 
-    formatters = {
+    formatters: dict = {
         'default': {
             '()': 'uvicorn.logging.DefaultFormatter',
             'fmt': DEFAULT_LOG_FORMAT,
@@ -35,7 +33,7 @@ class LogConfig(BaseModel):
             'datefmt': '%Y-%m-%d %H:%M:%S',
         },
     }
-    handlers = {
+    handlers: dict = {
         'monitoring_file': {
             'formatter': 'file_formatter',
             'filename': LOGS_DIR / 'monitoring.log',
@@ -63,7 +61,7 @@ class LogConfig(BaseModel):
             'stream': 'ext://sys.stderr',
         },
     }
-    loggers = {
+    loggers: dict = {
         'panther': {
             'handlers': ['default', 'file'],
             'level': LOG_LEVEL,
@@ -79,7 +77,14 @@ class LogConfig(BaseModel):
     }
 
 
-dictConfig(LogConfig().dict())
+try:
+    dictConfig(LogConfig().model_dump())
+except ValueError:
+    LOGS_DIR = config['base_dir'] / 'logs'
+    if not os.path.exists(LOGS_DIR):
+        os.makedirs(LOGS_DIR)
+
+
 logger = logging.getLogger('panther')
 query_logger = logging.getLogger('query')
 monitoring_logger = logging.getLogger('monitoring')

{panther-1.7.8 → panther-1.7.10}/panther/main.py

@@ -1,9 +1,10 @@
 import os
 import ast
+import sys
 import asyncio
 from pathlib import Path
 from runpy import run_path
-from pydantic.main import ModelMetaclass
+from pydantic._internal._model_construction import ModelMetaclass
 
 from panther import status
 from panther.request import Request
@@ -12,8 +13,8 @@ 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.routings import find_endpoint, check_urls, collect_urls, finalize_urls
-from panther._utils import http_response, import_class, read_body, collect_path_variables
+from panther.routings import find_endpoint, check_and_load_urls, finalize_urls, flatten_urls, collect_path_variables
+from panther._utils import http_response, import_class, read_body
 
 """ We can't import logger on the top cause it needs config['base_dir'] ans its fill in __init__ """
 
@@ -21,9 +22,12 @@ from panther._utils import http_response, import_class, read_body, collect_path_
 class Panther:
 
     def __init__(self, name):
+        from panther.logger import logger
         os.system('clear')
         config['base_dir'] = Path(name).resolve().parent
         self.panther_dir = Path(__file__).parent
+        if sys.version_info.minor < 11:
+            logger.warning('Use Python Version 3.11+ For Better Performance.')
         self.load_configs()
 
     def load_configs(self) -> None:
@@ -48,7 +52,7 @@ class Panther:
         config['jwt_config'] = self._get_jwt_config()
 
         # Find Database Models
-        self.collect_models_for_panel()
+        self._collect_models()
 
         # Check & Collect URLs
         #   check_urls should be the last call in load_configs,
@@ -63,11 +67,6 @@ class Panther:
         if config['monitoring']:
             logger.info('Run "panther monitor" in another session for Monitoring.')
 
-    def _load_urls(self) -> dict:
-        urls = check_urls(self.settings.get('URLs')) or {}
-        collect_urls('', urls, collected_urls := dict())
-        return finalize_urls(collected_urls)
-
     def _check_configs(self):
         from panther.logger import logger
         """Read the config file and put it as dict in self.settings"""
@@ -76,6 +75,7 @@ class Panther:
             self.settings = run_path(str(configs_path))
         except FileNotFoundError:
             logger.critical('core/configs.py Not Found.')
+            # TODO: Exit() Here
 
     def _get_secret_key(self) -> bytes | None:
         if secret_key := self.settings.get('SECRET_KEY'):
@@ -99,19 +99,21 @@ class Panther:
             middlewares.append(Middleware(**data))  # NOQA: Py Argument List
         return middlewares
 
-    def _get_authentication_class(self) -> ModelMetaclass | None:
-        return self.settings.get('AUTHENTICATION') and import_class(self.settings['AUTHENTICATION'])
-
     def _get_user_model(self) -> ModelMetaclass:
         return import_class(self.settings.get('USER_MODEL', 'panther.db.models.BaseUser'))
 
+    def _get_authentication_class(self) -> ModelMetaclass | None:
+        return self.settings.get('AUTHENTICATION') and import_class(self.settings['AUTHENTICATION'])
+
     def _get_jwt_config(self) -> JWTConfig:
         """Only Collect JWT Config If Authentication Is JWTAuthentication"""
         if getattr(config['authentication'], '__name__', None) == 'JWTAuthentication':
             user_config = self.settings.get('JWTConfig')
             return JWTConfig(**user_config) if user_config else JWTConfig(key=config['secret_key'].decode())
 
-    def collect_models_for_panel(self):
+    @classmethod
+    def _collect_models(cls):
+        """Collecting models for panel APIs"""
         from panther.db.models import Model
 
         for root, _, files in os.walk(config['base_dir']):
@@ -145,9 +147,14 @@ class Panther:
                                                 'app': class_path.split('.'),
                                             })
 
+    def _load_urls(self) -> dict:
+        urls = check_and_load_urls(self.settings.get('URLs')) or {}
+        collected_urls = flatten_urls(urls)
+        return finalize_urls(collected_urls)
+
     async def __call__(self, scope, receive, send) -> None:
         """
-        We Used Python3.11 For asyncio.TaskGroup()
+        We Used Python3.11+ For asyncio.TaskGroup()
         1.
             async with asyncio.TaskGroup() as tg:
                 tg.create_task(self.run(scope, receive, send))
@@ -161,8 +168,11 @@ class Panther:
             with ProcessPoolExecutor() as e:
                 e.submit(self.run, scope, receive, send)
         """
-        async with asyncio.TaskGroup() as tg:
-            tg.create_task(self.run(scope, receive, send))
+        if sys.version_info.minor >= 11:
+            async with asyncio.TaskGroup() as tg:
+                tg.create_task(self.run(scope, receive, send))
+        else:
+            await self.run(scope, receive, send)
 
     async def run(self, scope, receive, send):
         from panther.logger import logger

{panther-1.7.8 → panther-1.7.10}/panther/permissions.py

@@ -2,15 +2,13 @@ from panther.request import Request
 
 
 class BasePermission:
-    """
-    Just for demonstration
-    """
+
     @classmethod
     def authorization(cls, request: Request) -> bool:
         return True
 
 
-class AdminPermission:
+class AdminPermission(BasePermission):
 
     @classmethod
     def authorization(cls, request: Request) -> bool:

{panther-1.7.8 → panther-1.7.10}/panther/response.py

@@ -1,6 +1,6 @@
 import orjson as json
 from types import NoneType
-from pydantic.main import BaseModel as PydanticBaseModel
+from pydantic import BaseModel as PydanticBaseModel
 
 ResponseDataTypes = int | dict | list | tuple | set | str | bool | NoneType
 IterableDataTypes = list | tuple | set
@@ -43,7 +43,7 @@ class Response:
         Make sure the response data is only ResponseDataTypes or Iterable of ResponseDataTypes
         """
         if issubclass(type(data), PydanticBaseModel):
-            return data.dict()
+            return data.model_dump()
 
         elif isinstance(data, IterableDataTypes):
             return [cls.clean_data_type(d) for d in data]