panther 3.1.3__tar.gz → 3.1.5__tar.gz

{panther-3.1.3 → panther-3.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 3.1.3
+Version: 3.1.5
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -18,7 +18,7 @@ Requires-Dist: bson~=0.5
 Requires-Dist: httptools~=0.6
 Requires-Dist: pantherdb~=1.3
 Requires-Dist: pydantic~=2.1
-Requires-Dist: redis~=5.0
+Requires-Dist: redis==5.0.1
 Requires-Dist: rich~=13.5
 Requires-Dist: uvicorn~=0.23
 Requires-Dist: watchfiles~=0.19

{panther-3.1.3 → panther-3.1.5}/panther/__init__.py

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

{panther-3.1.3 → panther-3.1.5}/panther/_load_configs.py

@@ -1,5 +1,4 @@
 import ast
-import os
 import platform
 import sys
 from datetime import timedelta
@@ -11,7 +10,6 @@ from pydantic._internal._model_construction import ModelMetaclass
 from panther._utils import import_class
 from panther.configs import JWTConfig, config
 from panther.exceptions import PantherException
-from panther.middlewares import BaseMiddleware
 from panther.routings import finalize_urls, flatten_urls
 from panther.throttling import Throttling
 
@@ -73,6 +71,8 @@ def load_default_cache_exp(configs: dict, /) -> timedelta | None:
 
 def load_middlewares(configs: dict, /) -> list:
     """Collect The Middlewares & Set db_engine If One Of Middlewares Was For DB"""
+    from panther.middlewares import BaseMiddleware
+
     middlewares = []
 
     for path, data in configs.get('MIDDLEWARES', []):
@@ -113,52 +113,73 @@ def collect_all_models() -> list[dict]:
     """Collecting all models for panel APIs"""
     from panther.db.models import Model
 
-    collected_models = []
-
-    for root, _, files in os.walk(config['base_dir']):
-        # Traverse through each directory
-        for f in files:
-            # Traverse through each file of directory
-            if f == 'models.py':
-                slash = '\\' if platform.system() == 'Windows' else '/'
-
-                # If the file was "models.py" read it
-                file_path = f'{root}{slash}models.py'
-                with Path(file_path).open() as file:
-                    # Parse the file with ast
-                    node = ast.parse(file.read())
-                    for n in node.body:
-                        # Find classes in each element of files' body
-                        if type(n) is ast.ClassDef and n.bases:
-                            class_path = (
-                                file_path.removesuffix(f'{slash}models.py')
-                                .removeprefix(f'{config["base_dir"]}{slash}')
-                                .replace(slash, '.')
-                            )
-                            # We don't need to import the package classes
-                            if class_path.find('site-packages') == -1:
-                                # Import the class to check his parents and siblings
-                                klass = import_class(f'{class_path}.models.{n.name}')
-
-                                collected_models.extend(
-                                    [
-                                        {
-                                            'name': n.name,
-                                            'path': file_path,
-                                            'class': klass,
-                                            'app': class_path.split('.'),
-                                        }
-                                        for parent in klass.__mro__
-                                        if parent is Model
-                                    ]
-                                )
-    return collected_models
-
-
-def load_urls(configs: dict, /, urls: dict | None) -> dict:
+    # Just load all the python files from 'base_dir',
+    #   so Model.__subclasses__ can find all the subclasses
+    slash = '\\' if platform.system() == 'Windows' else '/'
+    python_files = [
+        f for f in config['base_dir'].rglob('*.py')
+        if not f.name.startswith('_') and 'site-packages' not in f.parents._parts
+    ]
+    for file in python_files:
+        # Analyse the file
+        with Path(file).open() as f:
+            node = ast.parse(f.read())
+
+        model_imported = False
+        panther_imported = False
+        panther_called = False
+        for n in node.body:
+            match n:
+
+                # from panther.db import Model
+                case ast.ImportFrom(module='panther.db', names=[ast.alias(name='Model')]):
+                    model_imported = True
+
+                # from panther.db.models import ..., Model, ...
+                case ast.ImportFrom(module='panther.db.models', names=[*names]):
+                    try:
+                        next(v for v in names if v.name == 'Model')
+                        model_imported = True
+                    except StopIteration:
+                        pass
+
+                # from panther import Panther, ...
+                case ast.ImportFrom(module='panther', names=[ast.alias(name='Panther'), *_]):
+                    panther_imported = True
+
+                # from panther import ..., Panther
+                case ast.ImportFrom(module='panther', names=[*_, ast.alias(name='Panther')]):
+                    panther_imported = True
+
+                # ... = Panther(...)
+                case ast.Assign(value=ast.Call(func=ast.Name(id='Panther'))):
+                    panther_called = True
+
+        # Panther() should not be called in the file and Model() should be imported,
+        #   We check the import of the Panther to make sure he is calling the panther.Panther and not any Panther
+        if panther_imported and panther_called or not model_imported:
+            continue
+
+        # Load the module
+        dotted_f = str(file).removeprefix(f'{config["base_dir"]}{slash}').removesuffix('.py').replace(slash, '.')
+        import_module(dotted_f)
+
+    return [
+        {
+            'name': m.__name__,
+            'module': m.__module__,
+            'class': m
+        } for m in Model.__subclasses__() if m.__module__ != 'panther.db.models'
+    ]
+
+
+def load_urls(configs: dict, /, urls: dict | None) -> tuple[dict, dict]:
+    """
+    Return tuple of all urls (as a flat dict) and (as a nested dict)
+    """
     if isinstance(urls, dict):
         collected_urls = flatten_urls(urls)
-        return finalize_urls(collected_urls)
+        return collected_urls, finalize_urls(collected_urls)
 
     if (url_routing := configs.get('URLs')) is None:
         raise _exception_handler(field='URLs', error='is required.')
@@ -182,7 +203,7 @@ def load_urls(configs: dict, /, urls: dict | None) -> dict:
         raise _exception_handler(field='URLs', error='should point to a dict.')
 
     collected_urls = flatten_urls(imported_urls)
-    return finalize_urls(collected_urls)
+    return collected_urls, finalize_urls(collected_urls)
 
 
 def load_panel_urls() -> dict:

{panther-3.1.3 → panther-3.1.5}/panther/_utils.py

@@ -1,4 +1,5 @@
 import importlib
+import logging
 import re
 from collections.abc import Callable
 from traceback import TracebackException
@@ -8,7 +9,9 @@ import orjson as json
 
 from panther import status
 from panther.file_handler import File
-from panther.logger import logger
+
+
+logger = logging.getLogger('panther')
 
 
 async def _http_response_start(send: Callable, /, headers: dict, status_code: int) -> None:
@@ -42,8 +45,7 @@ async def http_response(
     elif status_code == status.HTTP_204_NO_CONTENT or body == b'null':
         body = None
 
-    if monitoring is not None:
-        await monitoring.after(status_code=status_code)
+    await monitoring.after(status_code)
 
     await _http_response_start(send, headers=headers, status_code=status_code)
     await _http_response_body(send, body=body)

{panther-3.1.3 → panther-3.1.5}/panther/app.py

@@ -1,6 +1,7 @@
 import functools
 from collections.abc import Callable
 from datetime import datetime, timedelta
+import logging
 from typing import Literal
 
 from orjson import JSONDecodeError
@@ -18,7 +19,6 @@ from panther.exceptions import (
     MethodNotAllowed,
     ThrottlingException,
 )
-from panther.logger import logger
 from panther.request import Request
 from panther.response import Response
 from panther.throttling import Throttling, throttling_storage
@@ -27,6 +27,9 @@ from panther.utils import round_datetime
 __all__ = ('API', 'GenericAPI')
 
 
+logger = logging.getLogger('panther')
+
+
 class API:
     def __init__(
             self,

{panther-3.1.3 → panther-3.1.5}/panther/authentications.py

@@ -1,5 +1,6 @@
 import time
 from abc import abstractmethod
+import logging
 from typing import Literal
 
 from jose import JWTError, jwt
@@ -7,10 +8,12 @@ from jose import JWTError, jwt
 from panther.configs import config
 from panther.db.models import BaseUser, IDType, Model
 from panther.exceptions import AuthenticationException
-from panther.logger import logger
 from panther.request import Request
 
 
+logger = logging.getLogger('panther')
+
+
 class BaseAuthentication:
     @classmethod
     @abstractmethod

{panther-3.1.3 → panther-3.1.5}/panther/background_tasks.py

@@ -1,12 +1,12 @@
 import asyncio
 import datetime
+import logging
 import sys
 import time
 from threading import Thread
 from typing import Callable, Literal
 
 from panther._utils import is_function_async
-from panther.logger import logger
 from panther.utils import Singleton
 
 
@@ -16,6 +16,9 @@ __all__ = (
 )
 
 
+logger = logging.getLogger('panther')
+
+
 if sys.version_info.minor >= 11:
     from typing import Self
 else:

{panther-3.1.3 → panther-3.1.5}/panther/base_request.py

@@ -2,8 +2,6 @@ from collections import namedtuple
 from collections.abc import Callable
 from dataclasses import dataclass
 
-from panther.db import Model
-
 
 @dataclass(frozen=True)
 class Headers:
@@ -86,8 +84,8 @@ class BaseRequest:
         return self.scope['scheme']
 
     @property
-    def user(self) -> Model:
+    def user(self):
         return self._user
 
-    def set_user(self, user: Model) -> None:
+    def set_user(self, user) -> None:
         self._user = user

{panther-3.1.3 → panther-3.1.5}/panther/base_websocket.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import asyncio
 import contextlib
+import logging
 from typing import TYPE_CHECKING
 
 import orjson as json
@@ -10,13 +11,15 @@ from panther import status
 from panther._utils import generate_ws_connection_id
 from panther.base_request import BaseRequest
 from panther.configs import config
-from panther.logger import logger
 from panther.utils import Singleton
 
 if TYPE_CHECKING:
     from redis import Redis
 
 
+logger = logging.getLogger('panther')
+
+
 class WebsocketConnections(Singleton):
     def __init__(self):
         self.connections = {}

{panther-3.1.3 → panther-3.1.5}/panther/caching.py

@@ -1,16 +1,19 @@
 from collections import namedtuple
 from datetime import timedelta
+import logging
 from types import NoneType
 
 import orjson as json
 
 from panther.configs import config
 from panther.db.connection import redis
-from panther.logger import logger
 from panther.request import Request
 from panther.response import Response, ResponseDataTypes
 from panther.utils import generate_hash_value_from_string
 
+
+logger = logging.getLogger('panther')
+
 caches = {}
 CachedResponse = namedtuple('Cached', ['data', 'status_code'])
 

{panther-3.1.3 → panther-3.1.5}/panther/cli/monitor_command.py

@@ -12,9 +12,12 @@ from rich.panel import Panel
 from rich.table import Table
 from watchfiles import watch
 
+from panther.cli.utils import cli_error
+from panther.configs import config
+
 
 def monitor() -> None:
-    monitoring_log_file = 'logs/monitoring.log'
+    monitoring_log_file = Path(config['base_dir'] / 'logs' / 'monitoring.log')
 
     def _generate_table(rows: deque) -> Panel:
         layout = Layout()
@@ -42,7 +45,10 @@ def monitor() -> None:
             border_style='bright_blue',
         )
 
-    with Path(monitoring_log_file).open() as f:
+    if not monitoring_log_file.exists():
+        return cli_error('Monitoring file not found. (You need at least one monitoring record for this action)')
+
+    with monitoring_log_file.open() as f:
         f.readlines()  # Set cursor at the end of file
 
         _, init_lines_count = os.get_terminal_size()

{panther-3.1.3 → panther-3.1.5}/panther/cli/utils.py

@@ -1,7 +1,10 @@
-from panther.db.connection import redis
-from panther.logger import logger
+import logging
 from rich import print as rprint
 
+
+logger = logging.getLogger('panther')
+
+
 logo = r"""│    ____                 __    __                         │
 │   /\  _`\              /\ \__/\ \                        │
 │   \ \ \L\ \ __      ___\ \ ,_\ \ \___      __   _ __     │
@@ -78,21 +81,26 @@ def print_uvicorn_help_message():
 def print_info(config: dict):
     mo = config['monitoring']
     lq = config['log_queries']
-    rc = redis.is_connected
     bt = config['background_tasks']
+    ws = config['has_ws']
     bd = '{0:<39}'.format(str(config['base_dir']))
     if len(bd) > 39:
         bd = f'{bd[:36]}...'
 
+    if config['monitoring']:
+        monitor = '│ * Run "panther monitor" in another session for Monitoring│'
+    else:
+        monitor = f'│{58 * " "}│'
+
     info_message = f"""
 ╭{58 * '─'}╮
 {logo}│{58 * ' '}│
-│                                                          │
 │   Monitoring: {mo}                                  \t   │
 │   Log Queries: {lq}                                 \t   │
-│   Redis Is Connected: {rc}                          \t   │
 │   Background Tasks: {bt}                            \t   │
+│   Websocket: {ws}                                   \t   │
 │   Base directory: {bd}│
+{monitor}
 ╰{58 * '─'}╯
 """
     rprint(info_message)

{panther-3.1.3 → panther-3.1.5}/panther/configs.py

@@ -41,10 +41,12 @@ class Config(TypedDict):
     authentication: ModelMetaclass | None
     jwt_config: JWTConfig | None
     models: list[dict]
+    flat_urls: dict
     urls: dict
     db_engine: str
     websocket_connections: any  # type: WebsocketConnections
     background_tasks: bool
+    has_ws: bool
 
 
 config: Config = {
@@ -60,8 +62,10 @@ config: Config = {
     'authentication': None,
     'jwt_config': None,
     'models': [],
+    'flat_urls': {},
     'urls': {},
     'db_engine': '',
     'websocket_connections': None,
     'background_tasks': False,
+    'has_ws': False,
 }

{panther-3.1.3 → panther-3.1.5}/panther/db/queries/queries.py

@@ -6,7 +6,7 @@ from panther import status
 from panther.configs import config
 from panther.db.queries.mongodb_queries import BaseMongoDBQuery
 from panther.db.queries.pantherdb_queries import BasePantherDBQuery
-from panther.db.utils import log_query
+from panther.db.utils import log_query, check_connection
 from panther.exceptions import APIException, DBException
 
 BaseQuery = BasePantherDBQuery if config['db_engine'] == 'pantherdb' else BaseMongoDBQuery
@@ -55,6 +55,7 @@ class Query(BaseQuery):
 
     # # # # # Find # # # # #
     @classmethod
+    @check_connection
     @log_query
     def find_one(cls, _data: dict | None = None, /, **kwargs) -> Self | None:
         """
@@ -66,6 +67,7 @@ class Query(BaseQuery):
         return super().find_one(_data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def find(cls, _data: dict | None = None, /, **kwargs) -> list[Self]:
         """
@@ -77,6 +79,7 @@ class Query(BaseQuery):
         return super().find(_data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def first(cls, _data: dict | None = None, /, **kwargs) -> Self | None:
         """
@@ -89,6 +92,7 @@ class Query(BaseQuery):
         return super().first(_data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def last(cls, _data: dict | None = None, /, **kwargs) -> Self | None:
         """
@@ -101,6 +105,7 @@ class Query(BaseQuery):
 
     # # # # # Count # # # # #
     @classmethod
+    @check_connection
     @log_query
     def count(cls, _data: dict | None = None, /, **kwargs) -> int:
         """
@@ -113,6 +118,7 @@ class Query(BaseQuery):
 
     # # # # # Insert # # # # #
     @classmethod
+    @check_connection
     @log_query
     def insert_one(cls, _data: dict | None = None, /, **kwargs) -> Self:
         """
@@ -125,12 +131,14 @@ class Query(BaseQuery):
         return super().insert_one(_data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def insert_many(cls, _data: dict | None = None, /, **kwargs):
         msg = 'insert_many() is not supported yet.'
         raise DBException(msg)
 
     # # # # # Delete # # # # #
+    @check_connection
     @log_query
     def delete(self) -> None:
         """
@@ -143,6 +151,7 @@ class Query(BaseQuery):
         return super().delete()
 
     @classmethod
+    @check_connection
     @log_query
     def delete_one(cls, _data: dict | None = None, /, **kwargs) -> bool:
         """
@@ -154,6 +163,7 @@ class Query(BaseQuery):
         return super().delete_one(_data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def delete_many(cls, _data: dict | None = None, /, **kwargs) -> int:
         """
@@ -165,6 +175,7 @@ class Query(BaseQuery):
         return super().delete_many(_data, **kwargs)
 
     # # # # # Update # # # # #
+    @check_connection
     @log_query
     def update(self, **kwargs) -> None:
         """
@@ -178,6 +189,7 @@ class Query(BaseQuery):
         return super().update(**kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def update_one(cls, _filter: dict, _data: dict | None = None, /, **kwargs) -> bool:
         """
@@ -190,6 +202,7 @@ class Query(BaseQuery):
         return super().update_one(_filter, _data, **kwargs)
 
     @classmethod
+    @check_connection
     @log_query
     def update_many(cls, _filter: dict, _data: dict | None = None, /, **kwargs) -> int:
         """
@@ -203,7 +216,6 @@ class Query(BaseQuery):
 
     # # # # # Other # # # # #
     @classmethod
-    @log_query
     def find_or_insert(cls, **kwargs) -> tuple[bool, any]:
         """
         Example:
@@ -216,7 +228,6 @@ class Query(BaseQuery):
         return True, cls.insert_one(**kwargs)
 
     @classmethod
-    @log_query
     def find_one_or_raise(cls, **kwargs) -> Self:
         """
         Example:
@@ -232,6 +243,7 @@ class Query(BaseQuery):
             status_code=status.HTTP_404_NOT_FOUND,
         )
 
+    @check_connection
     @log_query
     def save(self, **kwargs) -> None:
         """

{panther-3.1.3 → panther-3.1.5}/panther/db/utils.py

@@ -1,3 +1,4 @@
+import logging
 import operator
 from functools import reduce
 from time import perf_counter
@@ -5,23 +6,38 @@ from time import perf_counter
 import bson
 
 from panther.configs import config
-from panther.logger import query_logger
+
+
+logger = logging.getLogger('query')
 
 
 def log_query(func):
     def log(*args, **kwargs):
+        # Check Database Connection
+        if config['db_engine'] == '':
+            msg = "You don't have active database connection, Check your middlewares"
+            raise NotImplementedError(msg)
+
         if config['log_queries'] is False:
             return func(*args, **kwargs)
         start = perf_counter()
         response = func(*args, **kwargs)
         end = perf_counter()
         class_name = args[0].__name__ if hasattr(args[0], '__name__') else args[0].__class__.__name__
-        query_logger.info(f'\033[1mQuery -->\033[0m  {class_name}.{func.__name__}() --> {(end - start) * 1_000:.2} ms')
+        logger.info(f'\033[1mQuery -->\033[0m  {class_name}.{func.__name__}() --> {(end - start) * 1_000:.2} ms')
         return response
-
     return log
 
 
+def check_connection(func):
+    def wrapper(*args, **kwargs):
+        if config['db_engine'] == '':
+            msg = "You don't have active database connection, Check your middlewares"
+            raise NotImplementedError(msg)
+        return func(*args, **kwargs)
+    return wrapper
+
+
 def prepare_id_for_query(*args, is_mongo: bool = False):
     for d in args:
         if d is None: