panther 5.0.0b3__py3-none-any.whl → 5.0.0b5__py3-none-any.whl

panther/cli/monitor_command.py

@@ -41,7 +41,7 @@ class Monitoring:
                 vertical_overflow='visible',
                 screen=True,
             ) as live,
-            contextlib.suppress(KeyboardInterrupt)
+            contextlib.suppress(KeyboardInterrupt),
         ):
             f.readlines()  # Set cursor at the end of the file
 
@@ -52,11 +52,12 @@ class Monitoring:
 
             for _ in watching:
                 for line in f.readlines():
-                    # line = date_time | method | path | ip:port | response_time(seconds) | status
+                    # line = datetime | method | path | ip:port | response_time(seconds) | status
                     columns = line.split('|')
-                    columns[4] = self._clean_response_time(columns[4])
-                    self.rows.append(columns)
-                    live.update(self.generate_table())
+                    if len(columns) != 2:  # Can be `datetime | ` on initiation.
+                        columns[4] = self._clean_response_time(columns[4])
+                        self.rows.append(columns)
+                        live.update(self.generate_table())
 
     def initialize(self) -> str:
         # Check requirements
@@ -67,7 +68,11 @@ class Monitoring:
 
         # Check log file
         if not self.monitoring_log_file.exists():
-            return f'`{self.monitoring_log_file}` file not found. (Make sure `panther.middlewares.monitoring.MonitoringMiddleware` is in your `MIDDLEWARES`)'
+            return (
+                f'`{self.monitoring_log_file}` file not found. '
+                f'Make sure `panther.middlewares.monitoring.MonitoringMiddleware` is in your `MIDDLEWARES`.\n'
+                f'documentation: https://PantherPy.github.io/middlewares/#monitoring-middleware'
+            )
 
         # Initialize Deque
         self.update_rows()

panther/cli/run_command.py

@@ -1,82 +1,16 @@
 import contextlib
-import os
+import sys
 
 import uvicorn
 
-from panther.cli.utils import print_uvicorn_help_message, clean_args, cli_error
-
-
-def _handle_commands(args: dict[str, str | None]) -> dict:
-    """
-    Boolean Commands:
-    - reload
-    - access-log
-    - no-access-log
-    - use-colors
-    - no-use-colors
-    - server-header
-    - no-server-header
-
-    Int Commands:
-    - port
-    - ws_max_size
-    - ws_max_queue
-    - ws_ping_interval
-    - ws_ping_timeout
-    """
-    _command = {}
-
-    if 'reload' in args:
-        _command['reload'] = bool(args.pop('reload', None))
-
-    _command['access_log'] = False  # Default
-    if 'access-log' in args:
-        _command['access_log'] = bool(args.pop('access-log', None))
-
-    if 'no-access-log' in args:
-        _command['access_log'] = not bool(args.pop('no-access-log', None))
-
-    if 'use-colors' in args:
-        _command['use_colors'] = bool(args.pop('use-colors', None))
-
-    if 'no-use-colors' in args:
-        _command['use_colors'] = not bool(args.pop('no-use-colors', None))
-
-    if 'server-header' in args:
-        _command['server_header'] = bool(args.pop('server-header', None))
-
-    if 'no-server-header' in args:
-        _command['server_header'] = not bool(args.pop('no-server-header', None))
-
-    if 'port' in args:
-        _command['port'] = int(args.pop('port'))
-
-    if 'ws_max_size' in args:
-        _command['ws_max_size'] = int(args.pop('ws_max_size'))
-
-    if 'ws_max_queue' in args:
-        _command['ws_max_queue'] = int(args.pop('ws_max_queue'))
-
-    if 'ws_ping_interval' in args:
-        _command['ws_ping_interval'] = int(args.pop('ws_ping_interval'))
-
-    if 'ws_ping_timeout' in args:
-        _command['ws_ping_timeout'] = int(args.pop('ws_ping_timeout'))
-
-    return _command
+from panther.cli.utils import cli_error
 
 
 def run(args: list[str]) -> None:
-    args = clean_args(args)
-
-    if any(a in args for a in ['h', 'help', '-h', '--help']):
-        print_uvicorn_help_message()
-        return
-    command = {'app_dir': os.getcwd()}
-    command.update(_handle_commands(args))
-    command.update(args)
     try:
         with contextlib.suppress(KeyboardInterrupt):
-            uvicorn.run('main:app', **command)
+            # First arg will be ignored by @Click, so ...
+            sys.argv = ['main'] + args
+            uvicorn.main()
     except TypeError as e:
         cli_error(e)

panther/cli/template.py

@@ -5,7 +5,7 @@ from panther.utils import generate_secret_key
 
 apis_py = """from datetime import datetime
 
-from app.throttling import InfoThrottling
+from app.throttling import InfoThrottle
 
 from panther import status, version
 from panther.app import API
@@ -19,7 +19,7 @@ async def hello_world_api():
     return {'detail': 'Hello World'}
 
 
-@API(cache=True, throttling=InfoThrottling)
+@API(cache=True, throttling=InfoThrottle)
 async def info_api(request: Request):
     data = {
         'panther_version': version(),
@@ -39,9 +39,9 @@ serializers_py = """from panther.serializer import ModelSerializer
 
 throttling_py = """from datetime import timedelta
 
-from panther.throttling import Throttling
+from panther.throttling import Throttle
 
-InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
+InfoThrottle = Throttle(rate=5, duration=timedelta(minutes=1))
 """
 
 app_urls_py = """from app.apis import hello_world_api, info_api
@@ -132,7 +132,7 @@ from panther import Panther, status, version
 from panther.app import API
 from panther.request import Request
 from panther.response import Response
-from panther.throttling import Throttling
+from panther.throttling import Throttle
 from panther.utils import load_env, timezone_now
 
 BASE_DIR = Path(__name__).resolve().parent
@@ -144,7 +144,7 @@ MIDDLEWARES = [
     {MONITORING}
 ]
 
-InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
+InfoThrottle = Throttle(rate=5, duration=timedelta(minutes=1))
 
 TIMEZONE = 'UTC'
 
@@ -154,7 +154,7 @@ async def hello_world_api():
     return {'detail': 'Hello World'}
 
 
-@API(cache=True, throttling=InfoThrottling)
+@API(cache=True, throttling=InfoThrottle)
 async def info_api(request: Request):
     data = {
         'panther_version': version(),

panther/cli/utils.py

@@ -23,43 +23,52 @@ else:
     br = '╯'
     bl = '╰'
 
-top = f'{tl}{58 * v}{tr}'
-bottom = f'{bl}{58 * v}{br}'
+top = f'{tl}{60 * v}{tr}'
+bottom = f'{bl}{60 * v}{br}'
 
 logo = rf"""{top}
-{h}    ____                 __    __                         {h}
-{h}   /\  _`\              /\ \__/\ \                        {h}
-{h}   \ \ \L\ \ __      ___\ \ ,_\ \ \___      __   _ __     {h}
-{h}    \ \ ,__/'__`\  /' _ `\ \ \/\ \  _ `\  /'__`\/\`'__\   {h}
-{h}     \ \ \/\ \L\.\_/\ \/\ \ \ \_\ \ \ \ \/\  __/\ \ \/    {h}
-{h}      \ \_\ \__/.\_\ \_\ \_\ \__\\ \_\ \_\ \____\\ \_\    {h}
-{h}       \/_/\/__/\/_/\/_/\/_/\/__/ \/_/\/_/\/____/ \/_/    {h}
-{h}                                                          {h}"""
-
-help_message = f"""{logo}
-{h}   usage:                                                 {h}
-{h}       - panther create                                   {h}
-{h}           Create project interactive                     {h}
-{h}                                                          {h}
-{h}       - panther create <project_name> <directory>        {h}
-{h}           Default<directory> is `.`                      {h}
-{h}           * It will create the project non-interactive   {h}
-{h}                                                          {h}
-{h}       - panther run [--reload | --help]                  {h}
-{h}           Run your project with uvicorn                  {h}
-{h}                                                          {h}
-{h}       - panther shell <application file path>            {h}
-{h}           Run interactive python shell                   {h}
-{h}           * Example: `panther shell main.py`             {h}
-{h}                                                          {h}
-{h}       - panther monitor                                  {h}
-{h}           Show the monitor :)                            {h}
-{h}                                                          {h}
-{h}       - panther version | --version                      {h}
-{h}           Print the current version of Panther           {h}
-{h}                                                          {h}
-{h}       - panther h | help | --help | -h                   {h}
-{h}           Show this message and exit                     {h}
+{h}     ____                 __    __                          {h}
+{h}    /\  _`\              /\ \__/\ \                         {h}
+{h}    \ \ \L\ \ __      ___\ \ ,_\ \ \___      __   _ __      {h}
+{h}     \ \ ,__/'__`\  /' _ `\ \ \/\ \  _ `\  /'__`\/\`'__\    {h}
+{h}      \ \ \/\ \L\.\_/\ \/\ \ \ \_\ \ \ \ \/\  __/\ \ \/     {h}
+{h}       \ \_\ \__/.\_\ \_\ \_\ \__\\ \_\ \_\ \____\\ \_\     {h}
+{h}        \/_/\/__/\/_/\/_/\/_/\/__/ \/_/\/_/\/____/ \/_/     {h}
+{h}                                                            {h}"""
+
+help_message = rf"""{logo}
+{h}   Usage: panther <command> \[options]                       {h}
+{h}                                                            {h}
+{h}   Commands:                                                {h}
+{h}       - create \[project_name] \[directory]                  {h}
+{h}           Create a new Panther project.                    {h}
+{h}           * Interactive mode if no arguments provided.     {h}
+{h}           * Non-interactive if project_name and directory  {h}
+{h}             are specified (default directory: .).          {h}
+{h}           Example:                                         {h}
+{h}               - `panther create`                           {h}
+{h}               - `panther create myapp myapp`               {h}
+{h}                                                            {h}
+{h}       - run <app> \[options]                                {h}
+{h}           Run your Panther project using Uvicorn.          {h}
+{h}           * app: address of your application.              {h}
+{h}           * options: Check `uvicorn --help` for options.   {h}
+{h}           * `panther run` is alias of `uvicorn`.           {h}
+{h}           Example: `panther run main:app --reload`         {h}
+{h}                                                            {h}
+{h}       - shell <application_file>                           {h}       
+{h}           Start an interactive Python shell with your app. {h}
+{h}           * application_file: path to your main app file.  {h}           
+{h}           Example: `panther shell main.py`                 {h}
+{h}                                                            {h}
+{h}       - monitor                                            {h}
+{h}           Display real-time request monitoring.            {h}
+{h}                                                            {h}
+{h}       - version | --version                                {h}
+{h}           Display the current version of Panther.          {h}
+{h}                                                            {h}
+{h}       - help | h | --help | -h                             {h}
+{h}           Show this help message and exit.                 {h}
 {bottom}
 """
 
@@ -87,29 +96,10 @@ def cli_info(message: str) -> None:
     logger.info('Use "panther -h" for more help\n')
 
 
-def clean_args(args: list[str]) -> dict:
-    """
-    Input: ['--reload', '--host', '127.0.0.1', ...]
-    Output: {'--reload: None, 'host': '127.0.0.1', ...}
-    """
-    _args = {}
-    for i, arg in enumerate(args):
-        if arg.startswith('--'):
-            if (i + 1) < len(args):
-                _args[arg[2:]] = args[i + 1]
-            else:
-                _args[arg[2:]] = True
-    return _args
-
-
 def print_help_message():
     rprint(help_message)
 
 
-def print_uvicorn_help_message():
-    rprint('Run `uvicorn --help` for more help')
-
-
 def print_info(config: Config):
     from panther.db.connections import redis
 
@@ -118,15 +108,12 @@ def print_info(config: Config):
     bt = config.BACKGROUND_TASKS
     ws = config.HAS_WS
     rd = redis.is_connected
-    bd = '{0:<39}'.format(str(config.BASE_DIR))
-    if len(bd) > 39:
-        bd = f'{bd[:36]}...'
+    bd = f'{config.BASE_DIR!s:<41}'
+    if len(bd) > 41:
+        bd = f'{bd[:38]}...'
 
     # Monitoring
-    if config.MONITORING:
-        monitor = f'{h} * Run "panther monitor" in another session for Monitoring{h}\n'
-    else:
-        monitor = None
+    monitor = f'{h} * Run "panther monitor" in another session for Monitoring  {h}\n' if config.MONITORING else None
 
     # Uvloop
     uvloop_msg = None
@@ -135,25 +122,27 @@ def print_info(config: Config):
             import uvloop
         except ImportError:
             uvloop_msg = (
-                f'{h} * You may want to install `uvloop` for better performance{h}\n'
-                f'{h}   `pip install uvloop`                                   {h}\n')
+                f'{h} * You may want to install `uvloop` for better performance  {h}\n'
+                f'{h}   `pip install uvloop`                                     {h}\n'
+            )
 
     # Gunicorn if Websocket
     gunicorn_msg = None
     if config.HAS_WS:
         try:
             import gunicorn
-            gunicorn_msg = f'{h} * You have WS, so make sure to run gunicorn with --preload{h}\n'
+
+            gunicorn_msg = f'{h} * You have WS, so make sure to run gunicorn with --preload  {h}\n'
         except ImportError:
             pass
 
     # Message
     info_message = f"""{logo}
-{h}   Redis: {rd}                                       \t   {h}
-{h}   Websocket: {ws}                                   \t   {h}
-{h}   Monitoring: {mo}                                  \t   {h}
-{h}   Log Queries: {lq}                                 \t   {h}
-{h}   Background Tasks: {bt}                            \t   {h}
+{h}   Redis: {rd}                                       \t     {h}
+{h}   Websocket: {ws}                                   \t     {h}
+{h}   Monitoring: {mo}                                  \t     {h}
+{h}   Log Queries: {lq}                                 \t     {h}
+{h}   Background Tasks: {bt}                            \t     {h}
 {h}   Base directory: {bd}{h}
 """
     if monitor:

panther/configs.py

@@ -1,25 +1,24 @@
-import copy
 import typing
-from dataclasses import dataclass
+from collections.abc import Callable
+from dataclasses import dataclass, field
 from datetime import timedelta
 from pathlib import Path
-from typing import Callable
 
 import jinja2
 from pydantic import BaseModel as PydanticBaseModel
-from panther.throttling import Throttling
+
 
 class JWTConfig:
     def __init__(
-            self,
-            key: str,
-            algorithm: str = 'HS256',
-            life_time: timedelta | int = timedelta(days=1),
-            refresh_life_time: timedelta | int | None = None,
+        self,
+        key: str,
+        algorithm: str = 'HS256',
+        life_time: timedelta | int = timedelta(days=1),
+        refresh_life_time: timedelta | int | None = None,
     ):
         self.key = key
         self.algorithm = algorithm
-        self.life_time = life_time.total_seconds() if isinstance(life_time, timedelta) else life_time
+        self.life_time = int(life_time.total_seconds()) if isinstance(life_time, timedelta) else life_time
 
         if refresh_life_time:
             if isinstance(refresh_life_time, timedelta):
@@ -29,6 +28,14 @@ class JWTConfig:
         else:
             self.refresh_life_time = self.life_time * 2
 
+    def __eq__(self, other):
+        return bool(
+            self.key == other.key
+            and self.algorithm == other.algorithm
+            and self.life_time == other.life_time
+            and self.refresh_life_time == other.refresh_life_time,
+        )
+
 
 class QueryObservable:
     observers = []
@@ -45,77 +52,68 @@ class QueryObservable:
 
 @dataclass
 class Config:
-    BASE_DIR: Path
-    MONITORING: bool
-    LOG_QUERIES: bool
-    DEFAULT_CACHE_EXP: timedelta | None
-    THROTTLING: Throttling | None
-    SECRET_KEY: bytes | None
-    HTTP_MIDDLEWARES: list
-    WS_MIDDLEWARES: list
-    USER_MODEL: type[PydanticBaseModel] | None # type: type[panther.db.Model]
-    AUTHENTICATION: type[PydanticBaseModel] | None
-    WS_AUTHENTICATION: type[PydanticBaseModel] | None
-    JWT_CONFIG: JWTConfig | None
-    MODELS: list[type[PydanticBaseModel]]  # type: type[panther.db.Model]
-    FLAT_URLS: dict
-    URLS: dict
-    WEBSOCKET_CONNECTIONS: typing.Callable | None
-    BACKGROUND_TASKS: bool
-    HAS_WS: bool
-    STARTUPS: list[Callable]
-    SHUTDOWNS: list[Callable]
-    TIMEZONE: str
-    TEMPLATES_DIR: str | list[str]
-    JINJA_ENVIRONMENT: jinja2.Environment | None
-    AUTO_REFORMAT: bool
-    QUERY_ENGINE: typing.Callable | None
-    DATABASE: typing.Callable | None
+    BASE_DIR: Path = Path()
+    MONITORING: bool = False
+    LOG_QUERIES: bool = False
+    THROTTLING = None  # type: panther.throttling.Throttle
+    SECRET_KEY: str | None = None
+    HTTP_MIDDLEWARES: list = field(default_factory=list)
+    WS_MIDDLEWARES: list = field(default_factory=list)
+    USER_MODEL: type[PydanticBaseModel] | None = None
+    AUTHENTICATION: type[PydanticBaseModel] | None = None
+    WS_AUTHENTICATION: type[PydanticBaseModel] | None = None
+    JWT_CONFIG: JWTConfig | None = None
+    MODELS: list = field(default_factory=list)
+    FLAT_URLS: dict = field(default_factory=dict)
+    URLS: dict = field(default_factory=dict)
+    WEBSOCKET_CONNECTIONS: Callable | None = None
+    BACKGROUND_TASKS: bool = False
+    HAS_WS: bool = False
+    TIMEZONE: str = 'UTC'
+    TEMPLATES_DIR: str | list[str] = '.'
+    JINJA_ENVIRONMENT: jinja2.Environment | None = None
+    AUTO_REFORMAT: bool = False
+    QUERY_ENGINE: Callable | None = None
+    DATABASE: Callable | None = None
+
+    def refresh(self):
+        """
+        Reset built-in fields and remove any custom (non-built-in) attributes.
+        * In some tests we need to `refresh` the `config` values
+        """
+        builtin_fields = set(self.__dataclass_fields__)
+        current_fields = set(self.__dict__)
+
+        # Reset built-in fields
+        for field_name in builtin_fields:
+            field_def = self.__dataclass_fields__[field_name]
+            default = field_def.default_factory() if callable(field_def.default_factory) else field_def.default
+            setattr(self, field_name, default)
+
+        # Delete custom attributes
+        for field_name in current_fields - builtin_fields:
+            delattr(self, field_name)
+
+    def vars(self) -> dict[str, typing.Any]:
+        """Return all config variables (built-in + custom)."""
+        return dict(self.__dict__)
 
     def __setattr__(self, key, value):
         super().__setattr__(key, value)
         if key == 'QUERY_ENGINE' and value:
             QueryObservable.update()
 
+    def __getattr__(self, item: str):
+        try:
+            return object.__getattribute__(self, item)
+        except AttributeError:
+            return None
+
     def __setitem__(self, key, value):
         setattr(self, key.upper(), value)
 
     def __getitem__(self, item):
         return getattr(self, item.upper())
 
-    def refresh(self):
-        # In some tests we need to `refresh` the `config` values
-        for key, value in copy.deepcopy(default_configs).items():
-            setattr(self, key, value)
-
-
-default_configs = {
-    'BASE_DIR': Path(),
-    'MONITORING': False,
-    'LOG_QUERIES': False,
-    'DEFAULT_CACHE_EXP': None,
-    'THROTTLING': None,
-    'SECRET_KEY': None,
-    'HTTP_MIDDLEWARES': [],
-    'WS_MIDDLEWARES': [],
-    'USER_MODEL': None,
-    'AUTHENTICATION': None,
-    'WS_AUTHENTICATION': None,
-    'JWT_CONFIG': None,
-    'MODELS': [],
-    'FLAT_URLS': {},
-    'URLS': {},
-    'WEBSOCKET_CONNECTIONS': None,
-    'BACKGROUND_TASKS': False,
-    'HAS_WS': False,
-    'STARTUPS': [],
-    'SHUTDOWNS': [],
-    'TIMEZONE': 'UTC',
-    'TEMPLATES_DIR': '.',
-    'JINJA_ENVIRONMENT': None,
-    'AUTO_REFORMAT': False,
-    'QUERY_ENGINE': None,
-    'DATABASE': None,
-}
-
-config = Config(**copy.deepcopy(default_configs))
+
+config = Config()

panther/db/connections.py

@@ -38,15 +38,15 @@ class BaseDatabaseConnection:
 
 class MongoDBConnection(BaseDatabaseConnection):
     def init(
-            self,
-            host: str = 'localhost',
-            port: int = 27017,
-            document_class: dict[str, Any] | None = None,
-            tz_aware: bool | None = None,
-            connect: bool | None = None,
-            type_registry=None,  # type: bson.codec_options.TypeRegistry
-            database: str | None = None,
-            **kwargs: Any,
+        self,
+        host: str = 'localhost',
+        port: int = 27017,
+        document_class: dict[str, Any] | None = None,
+        tz_aware: bool | None = None,
+        connect: bool | None = None,
+        type_registry=None,  # type: bson.codec_options.TypeRegistry
+        database: str | None = None,
+        **kwargs: Any,
     ) -> None:
         try:
             from motor.motor_asyncio import AsyncIOMotorClient
@@ -55,6 +55,7 @@ class MongoDBConnection(BaseDatabaseConnection):
 
         with contextlib.suppress(ImportError):
             import uvloop
+
             asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 
         self._client: AsyncIOMotorClient = AsyncIOMotorClient(
@@ -72,6 +73,10 @@ class MongoDBConnection(BaseDatabaseConnection):
     def session(self):
         return self._database
 
+    @property
+    def client(self):
+        return self._client
+
 
 class PantherDBConnection(BaseDatabaseConnection):
     def init(self, path: str | None = None, encryption: bool = False):
@@ -81,7 +86,7 @@ class PantherDBConnection(BaseDatabaseConnection):
                 import cryptography
             except ImportError as e:
                 raise import_error(e, package='cryptography')
-            params['secret_key'] = config.SECRET_KEY
+            params['secret_key'] = config.SECRET_KEY.encode()
 
         self._connection: PantherDB = PantherDB(**params)
 
@@ -89,30 +94,36 @@ class PantherDBConnection(BaseDatabaseConnection):
     def session(self):
         return self._connection
 
+    @property
+    def client(self):
+        return self._connection
+
 
 class DatabaseConnection(Singleton):
     @property
     def session(self):
         return config.DATABASE.session
 
+    @property
+    def client(self):
+        return config.DATABASE.client
+
 
 class RedisConnection(Singleton, _Redis):
     is_connected: bool = False
 
     def __init__(
-            self,
-            init: bool = False,
-            host: str = 'localhost',
-            port: int = 6379,
-            db: int = 0,
-            websocket_db: int = 0,
-            **kwargs
+        self,
+        init: bool = False,
+        host: str = 'localhost',
+        port: int = 6379,
+        db: int = 0,
+        **kwargs,
     ):
         if init:
             self.host = host
             self.port = port
             self.db = db
-            self.websocket_db = websocket_db
             self.kwargs = kwargs
 
             super().__init__(host=host, port=port, db=db, **kwargs)
@@ -132,12 +143,7 @@ class RedisConnection(Singleton, _Redis):
 
     def create_connection_for_websocket(self) -> _Redis:
         if not hasattr(self, 'websocket_connection'):
-            self.websocket_connection = _Redis(
-                host=self.host,
-                port=self.port,
-                db=self.websocket_db,
-                **self.kwargs
-            )
+            self.websocket_connection = _Redis(host=self.host, port=self.port, db=0, **self.kwargs)
         return self.websocket_connection
 
 

panther/db/cursor.py

@@ -36,6 +36,9 @@ class Cursor(_Cursor):
     def __aiter__(self) -> Self:
         return self
 
+    def __iter__(self) -> Self:
+        return self
+
     async def next(self) -> Self:
         return await self.cls._create_model_instance(document=super().next())
 
@@ -51,7 +54,6 @@ class Cursor(_Cursor):
         except StopIteration:
             raise
 
-
     def __getitem__(self, index: int | slice) -> Cursor[Self] | Self:
         document = super().__getitem__(index)
         if isinstance(document, dict):