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

panther/base_websocket.py

@@ -12,7 +12,7 @@ from panther import status
 from panther.base_request import BaseRequest
 from panther.configs import config
 from panther.db.connections import redis
-from panther.exceptions import InvalidPathVariableAPIError, BaseError
+from panther.exceptions import BaseError, InvalidPathVariableAPIError
 from panther.utils import Singleton
 
 if TYPE_CHECKING:
@@ -83,11 +83,11 @@ class WebsocketConnections(Singleton):
 
     async def _handle_received_message(self, received_message):
         if (
-                isinstance(received_message, dict)
-                and (connection_id := received_message.get('connection_id'))
-                and connection_id in self.connections
-                and 'action' in received_message
-                and 'data' in received_message
+            isinstance(received_message, dict)
+            and (connection_id := received_message.get('connection_id'))
+            and connection_id in self.connections
+            and 'action' in received_message
+            and 'data' in received_message
         ):
             # Check Action of WS
             match received_message['action']:
@@ -96,7 +96,7 @@ class WebsocketConnections(Singleton):
                 case 'close':
                     await self.connections[connection_id].close(
                         code=received_message['data']['code'],
-                        reason=received_message['data']['reason']
+                        reason=received_message['data']['reason'],
                     )
                 case unknown_action:
                     logger.error(f'Unknown Message Action: {unknown_action}')
@@ -124,7 +124,7 @@ class WebsocketConnections(Singleton):
 
         # 3. Put PathVariables and Request(If User Wants It) In kwargs
         try:
-            kwargs = connection.clean_parameters(connection.connect)
+            kwargs = connection.clean_parameters(connection.connect.__annotations__)
         except InvalidPathVariableAPIError as e:
             connection.change_state(state='Rejected', message=e.detail)
             return await connection.close()

panther/caching.py

@@ -1,42 +1,33 @@
-from collections import namedtuple
-from datetime import timedelta, datetime
 import logging
-from types import NoneType
+from collections import namedtuple
+from datetime import datetime, timedelta
 
 import orjson as json
 
-from panther.configs import config
 from panther.db.connections import redis
 from panther.request import Request
 from panther.response import Response
-from panther.throttling import throttling_storage
 from panther.utils import generate_hash_value_from_string, round_datetime
 
 logger = logging.getLogger('panther')
 
-caches = {}
+caches: dict[str, tuple[bytes, dict, int]] = {}
 CachedResponse = namedtuple('CachedResponse', ['data', 'headers', 'status_code'])
 
 
-def api_cache_key(request: Request, cache_exp_time: timedelta | None = None) -> str:
-    client = request.user and request.user.id or request.client.ip
+def api_cache_key(request: Request, duration: timedelta | None = None) -> str:
+    client = (request.user and request.user.id) or request.client.ip
     query_params_hash = generate_hash_value_from_string(request.scope['query_string'].decode('utf-8'))
     key = f'{client}-{request.path}-{query_params_hash}-{request.validated_data}'
 
-    if cache_exp_time:
-        time = round_datetime(datetime.now(), cache_exp_time)
+    if duration:
+        time = round_datetime(datetime.now(), duration)
         return f'{time}-{key}'
 
     return key
 
 
-def throttling_cache_key(request: Request, duration: timedelta) -> str:
-    client = request.user and request.user.id or request.client.ip
-    time = round_datetime(datetime.now(), duration)
-    return f'{time}-{client}-{request.path}'
-
-
-async def get_response_from_cache(*, request: Request, cache_exp_time: timedelta) -> CachedResponse | None:
+async def get_response_from_cache(*, request: Request, duration: timedelta) -> CachedResponse | None:
     """
     If redis.is_connected:
         Get Cached Data From Redis
@@ -47,18 +38,14 @@ async def get_response_from_cache(*, request: Request, cache_exp_time: timedelta
         key = api_cache_key(request=request)
         data = (await redis.get(key) or b'{}').decode()
         if value := json.loads(data):
-            return CachedResponse(
-                data=value[0].encode(),
-                headers=value[1],
-                status_code=value[2]
-            )
+            return CachedResponse(data=value[0].encode(), headers=value[1], status_code=value[2])
     else:
-        key = api_cache_key(request=request, cache_exp_time=cache_exp_time)
+        key = api_cache_key(request=request, duration=duration)
         if value := caches.get(key):
             return CachedResponse(*value)
 
 
-async def set_response_in_cache(*, request: Request, response: Response, cache_exp_time: timedelta | int) -> None:
+async def set_response_in_cache(*, request: Request, response: Response, duration: timedelta | int) -> None:
     """
     If redis.is_connected:
         Cache The Data In Redis
@@ -68,61 +55,10 @@ async def set_response_in_cache(*, request: Request, response: Response, cache_e
 
     if redis.is_connected:
         key = api_cache_key(request=request)
-        cache_data: tuple[str, str, int] = (response.body.decode(), response.headers, response.status_code)
-        cache_exp_time = cache_exp_time or config.DEFAULT_CACHE_EXP
-        cache_data: bytes = json.dumps(cache_data)
-
-        if not isinstance(cache_exp_time, timedelta | int | NoneType):
-            msg = '`cache_exp_time` should be instance of `datetime.timedelta`, `int` or `None`'
-            raise TypeError(msg)
-
-        if cache_exp_time is None:
-            logger.warning(
-                'your response are going to cache in redis forever '
-                '** set DEFAULT_CACHE_EXP in `configs` or set the `cache_exp_time` in `@API.get()` to prevent this **'
-            )
-            await redis.set(key, cache_data)
-        else:
-            await redis.set(key, cache_data, ex=cache_exp_time)
-
-    else:
-        key = api_cache_key(request=request, cache_exp_time=cache_exp_time)
-        cache_data: tuple[bytes, str, int] = (response.body, response.headers, response.status_code)
-
-        caches[key] = cache_data
-
-        if cache_exp_time:
-            logger.info('`cache_exp_time` is not very accurate when `redis` is not connected.')
-
-
-async def get_throttling_from_cache(request: Request, duration: timedelta) -> int:
-    """
-    If redis.is_connected:
-        Get Cached Data From Redis
-    else:
-        Get Cached Data From Memory
-    """
-    key = throttling_cache_key(request=request, duration=duration)
-
-    if redis.is_connected:
-        data = (await redis.get(key) or b'0').decode()
-        return json.loads(data)
-
-    else:
-        return throttling_storage[key]
-
-
-async def increment_throttling_in_cache(request: Request, duration: timedelta) -> None:
-    """
-    If redis.is_connected:
-        Increment The Data In Redis
-    else:
-        Increment The Data In Memory
-    """
-    key = throttling_cache_key(request=request, duration=duration)
-
-    if redis.is_connected:
-        await redis.incrby(key, amount=1)
+        cache_data: tuple[str, dict, int] = (response.body.decode(), response.headers, response.status_code)
+        await redis.set(key, json.dumps(cache_data), ex=duration)
 
     else:
-        throttling_storage[key] += 1
+        key = api_cache_key(request=request, duration=duration)
+        caches[key] = (response.body, response.headers, response.status_code)
+        logger.info('`cache` is not very accurate when `redis` is not connected.')

panther/cli/create_command.py

@@ -1,5 +1,5 @@
+from collections.abc import Callable
 from pathlib import Path
-from typing import Callable
 
 from rich import print as rich_print
 from rich.console import Console
@@ -8,15 +8,16 @@ from rich.prompt import Prompt
 
 from panther import version
 from panther.cli.template import (
-    TEMPLATE,
-    SINGLE_FILE_TEMPLATE,
     AUTHENTICATION_PART,
-    MONITORING_PART,
-    LOG_QUERIES_PART,
     AUTO_REFORMAT_PART,
-    DATABASE_PANTHERDB_PART,
     DATABASE_MONGODB_PART,
-    USER_MODEL_PART, REDIS_PART,
+    DATABASE_PANTHERDB_PART,
+    LOG_QUERIES_PART,
+    MONITORING_PART,
+    REDIS_PART,
+    SINGLE_FILE_TEMPLATE,
+    TEMPLATE,
+    USER_MODEL_PART,
 )
 from panther.cli.utils import cli_error
 
@@ -52,7 +53,7 @@ class CreateProject:
                 'message': 'Directory (default is .)',
                 'validation_func': self._check_all_directories,
                 'error_message': '"{}" Directory Already Exists.',
-                'show_validation_error': True
+                'show_validation_error': True,
             },
             {
                 'field': 'single_file',
@@ -69,7 +70,7 @@ class CreateProject:
                 'field': 'database_encryption',
                 'message': 'Do You Want Encryption For Your Database (Required `cryptography`)',
                 'is_boolean': True,
-                'condition': "self.database == '0'"
+                'condition': "self.database == '0'",
             },
             {
                 'field': 'redis',
@@ -90,7 +91,7 @@ class CreateProject:
                 'field': 'log_queries',
                 'message': 'Do You Want To Log Queries',
                 'is_boolean': True,
-                'condition': "self.database != '2'"
+                'condition': "self.database != '2'",
             },
             {
                 'field': 'auto_reformat',
@@ -194,12 +195,12 @@ class CreateProject:
             self.progress(i + 1)
 
     def ask(
-            self,
-            message: str,
-            default: str | bool,
-            error_message: str,
-            validation_func: Callable,
-            show_validation_error: bool = False,
+        self,
+        message: str,
+        default: str | bool,
+        error_message: str,
+        validation_func: Callable,
+        show_validation_error: bool = False,
     ) -> str:
         value = Prompt.ask(message, console=self.input_console).lower() or default
         while not validation_func(value):

panther/cli/main.py

@@ -15,7 +15,7 @@ def shell(args) -> None:
         return cli_error(
             'Not Enough Arguments, Give me a file path that contains `Panther()` app.\n'
             '       * Make sure to run `panther shell` in the same directory as that file!\n'
-            '       * Example: `panther shell main.py`'
+            '       * Example: `panther shell main.py`',
         )
     elif len(args) != 1:
         return cli_error('Too Many Arguments.')

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: