panther 3.8.2__py3-none-any.whl → 4.0.0__py3-none-any.whl

panther/cli/create_command.py

@@ -16,8 +16,7 @@ from panther.cli.template import (
     AUTO_REFORMAT_PART,
     DATABASE_PANTHERDB_PART,
     DATABASE_MONGODB_PART,
-    USER_MODEL_PART,
-    PANTHERDB_ENCRYPTION,
+    USER_MODEL_PART, REDIS_PART,
 )
 from panther.cli.utils import cli_error
 
@@ -35,6 +34,7 @@ class CreateProject:
         self.base_directory = '.'
         self.database = '0'
         self.database_encryption = False
+        self.redis = False
         self.authentication = False
         self.monitoring = True
         self.log_queries = True
@@ -61,7 +61,7 @@ class CreateProject:
             },
             {
                 'field': 'database',
-                'message': '    0: PantherDB\n    1: MongoDB (Required `pymongo`)\n    2: No Database\nChoose Your Database (default is 0)',
+                'message': '    0: PantherDB (File-Base, No Requirements)\n    1: MongoDB (Required `pymongo`)\n    2: No Database\nChoose Your Database (default is 0)',
                 'validation_func': lambda x: x in ['0', '1', '2'],
                 'error_message': "Invalid Choice, '{}' not in ['0', '1', '2']",
             },
@@ -71,6 +71,11 @@ class CreateProject:
                 'is_boolean': True,
                 'condition': "self.database == '0'"
             },
+            {
+                'field': 'redis',
+                'message': 'Do You Want To Use Redis (Required `redis`)',
+                'is_boolean': True,
+            },
             {
                 'field': 'authentication',
                 'message': 'Do You Want To Use JWT Authentication (Required `python-jose`)',
@@ -78,7 +83,7 @@ class CreateProject:
             },
             {
                 'field': 'monitoring',
-                'message': 'Do You Want To Use Built-in Monitoring',
+                'message': 'Do You Want To Use Built-in Monitoring (Required `watchfiles`)',
                 'is_boolean': True,
             },
             {
@@ -88,7 +93,7 @@ class CreateProject:
             },
             {
                 'field': 'auto_reformat',
-                'message': 'Do You Want To Use Auto Reformat (Required `ruff`)',
+                'message': 'Do You Want To Use Auto Code Reformat (Required `ruff`)',
                 'is_boolean': True,
             },
         ]
@@ -139,7 +144,9 @@ class CreateProject:
         monitoring_part = MONITORING_PART if self.monitoring else ''
         log_queries_part = LOG_QUERIES_PART if self.log_queries else ''
         auto_reformat_part = AUTO_REFORMAT_PART if self.auto_reformat else ''
-        database_encryption = PANTHERDB_ENCRYPTION if self.database_encryption else ''
+        database_encryption = 'True' if self.database_encryption else 'False'
+        database_extension = 'pdb' if self.database_encryption else 'json'
+        redis_part = REDIS_PART if self.redis else ''
         if self.database == '0':
             database_part = DATABASE_PANTHERDB_PART
         elif self.database == '1':
@@ -153,7 +160,9 @@ class CreateProject:
         data = data.replace('{LOG_QUERIES}', log_queries_part)
         data = data.replace('{AUTO_REFORMAT}', auto_reformat_part)
         data = data.replace('{DATABASE}', database_part)
-        data = data.replace('{PANTHERDB_ENCRYPTION}', database_encryption)
+        data = data.replace('{PANTHERDB_ENCRYPTION}', database_encryption)  # Should be after `DATABASE`
+        data = data.replace('{PANTHERDB_EXTENSION}', database_extension)  # Should be after `DATABASE`
+        data = data.replace('{REDIS}', redis_part)
 
         data = data.replace('{PROJECT_NAME}', self.project_name.lower())
         data = data.replace('{PANTHER_VERSION}', version())
@@ -168,19 +177,19 @@ class CreateProject:
             field_name = question.pop('field')
             question['default'] = getattr(self, field_name)
             is_boolean = question.pop('is_boolean', False)
-            clean_output = str  # Do Nothing
+            convert_output = str  # Do Nothing
             if is_boolean:
                 question['message'] += f' (default is {self._to_str(question["default"])})'
                 question['validation_func'] = self._is_boolean
                 question['error_message'] = "Invalid Choice, '{}' not in ['y', 'n']"
-                clean_output = self._to_boolean
+                convert_output = self._to_boolean
 
             # Check Question Condition
             if 'condition' in question and eval(question.pop('condition')) is False:
                 print(flush=True)
             # Ask Question
             else:
-                setattr(self, field_name, clean_output(self.ask(**question)))
+                setattr(self, field_name, convert_output(self.ask(**question)))
             self.progress(i + 1)
 
     def ask(
@@ -193,6 +202,7 @@ class CreateProject:
     ) -> str:
         value = Prompt.ask(message, console=self.input_console).lower() or default
         while not validation_func(value):
+            # Remove the last line, show error message and ask again
             [print(end=self.REMOVE_LAST_LINE, flush=True) for _ in range(message.count('\n') + 1)]
             error = validation_func(value, return_error=True) if show_validation_error else value
             self.console.print(error_message.format(error), style='bold red')

panther/cli/monitor_command.py

@@ -1,71 +1,97 @@
 import contextlib
+import logging
 import os
+import signal
 from collections import deque
 from pathlib import Path
 
 from rich import box
 from rich.align import Align
 from rich.console import Group
-from rich.layout import Layout
 from rich.live import Live
 from rich.panel import Panel
 from rich.table import Table
-from watchfiles import watch
 
-from panther.cli.utils import cli_error
+from panther.cli.utils import import_error
 from panther.configs import config
 
+with contextlib.suppress(ImportError):
+    from watchfiles import watch
 
-def monitor() -> None:
-    monitoring_log_file = Path(config['base_dir'] / 'logs' / 'monitoring.log')
+loggerr = logging.getLogger('panther')
 
-    def _generate_table(rows: deque) -> Panel:
-        layout = Layout()
 
-        rows = list(rows)
-        _, lines = os.get_terminal_size()
+class Monitoring:
+    def __init__(self):
+        self.rows = deque()
+        self.monitoring_log_file = Path(config.BASE_DIR / 'logs' / 'monitoring.log')
+
+    def monitor(self) -> None:
+        if error := self.initialize():
+            # Don't continue if initialize() has error
+            loggerr.error(error)
+            return
+
+        with (
+            self.monitoring_log_file.open() as f,
+            Live(
+                self.generate_table(),
+                vertical_overflow='visible',
+                screen=True,
+            ) as live,
+            contextlib.suppress(KeyboardInterrupt)
+        ):
+            f.readlines()  # Set cursor at the end of the file
+
+            for _ in watch(self.monitoring_log_file):
+                for line in f.readlines():
+                    self.rows.append(line.split('|'))
+                    live.update(self.generate_table())
+
+    def initialize(self) -> str:
+        # Check requirements
+        try:
+            from watchfiles import watch
+        except ImportError as e:
+            return import_error(e, package='watchfiles').args[0]
+
+        # Check log file
+        if not self.monitoring_log_file.exists():
+            return f'`{self.monitoring_log_file}` file not found. (Make sure `MONITORING` is `True` in `configs`'
+
+        # Initialize Deque
+        self.update_rows()
+
+        # Register the signal handler
+        signal.signal(signal.SIGWINCH, self.update_rows)
+
+    def generate_table(self) -> Panel:
+        # 2023-03-24 01:42:52 | GET | /user/317/ | 127.0.0.1:48856 |  0.0366 ms | 200
 
         table = Table(box=box.MINIMAL_DOUBLE_HEAD)
         table.add_column('Datetime', justify='center', style='magenta', no_wrap=True)
-        table.add_column('Method', justify='center', style='cyan')
-        table.add_column('Path', justify='center', style='cyan')
+        table.add_column('Method', justify='center', style='cyan', no_wrap=True)
+        table.add_column('Path', justify='center', style='cyan', no_wrap=True)
         table.add_column('Client', justify='center', style='cyan')
         table.add_column('Response Time', justify='center', style='blue')
-        table.add_column('Status Code', justify='center', style='blue')
+        table.add_column('Status', justify='center', style='blue', no_wrap=True)
 
-        for row in rows[-lines:]:  # It will give us "lines" last lines of "rows"
+        for row in self.rows:
             table.add_row(*row)
-        layout.update(table)
 
         return Panel(
             Align.center(Group(table)),
             box=box.ROUNDED,
-            padding=(1, 2),
+            padding=(0, 2),
             title='Monitoring',
             border_style='bright_blue',
         )
 
-    if not monitoring_log_file.exists():
-        return cli_error('Monitoring file not found. (You need at least one monitoring record for this action)')
+    def update_rows(self, *args, **kwargs):
+        # Top = -4, Bottom = -2 --> -6
+        # Print of each line needs two line, so --> x // 2
+        lines = (os.get_terminal_size()[1] - 6) // 2
+        self.rows = deque(self.rows, maxlen=lines)
 
-    with monitoring_log_file.open() as f:
-        f.readlines()  # Set cursor at the end of file
 
-        _, init_lines_count = os.get_terminal_size()
-        messages = deque(maxlen=init_lines_count - 10)  # Save space for header and footer
-
-        with (
-            Live(
-                _generate_table(messages),
-                auto_refresh=False,
-                vertical_overflow='visible',
-                screen=True,
-            ) as live,
-            contextlib.suppress(KeyboardInterrupt),
-        ):
-            for _ in watch(monitoring_log_file):
-                data = f.readline().split('|')
-                # 2023-03-24 01:42:52 | GET | /user/317/ | 127.0.0.1:48856 |  0.0366 ms | 200
-                messages.append(data)
-                live.update(_generate_table(messages))
-                live.refresh()
+monitor = Monitoring().monitor

panther/cli/template.py

@@ -11,6 +11,7 @@ from panther import status, version
 from panther.app import API
 from panther.request import Request
 from panther.response import Response
+from panther.utils import timezone_now
 
 
 @API()
@@ -24,7 +25,7 @@ async def info_api(request: Request):
         'panther_version': version(),
         'method': request.method,
         'query_params': request.query_params,
-        'datetime_now': datetime.now().isoformat(),
+        'datetime_now': timezone_now().isoformat(),
         'user_agent': request.headers.user_agent,
     }
     return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
@@ -55,19 +56,19 @@ configs_py = """\"""
 {PROJECT_NAME} Project (Generated by Panther on %s)
 \"""
 
-from datetime import timedelta
 from pathlib import Path
 
-from panther.throttling import Throttling
 from panther.utils import load_env
 
 BASE_DIR = Path(__name__).resolve().parent
 env = load_env(BASE_DIR / '.env')
 
-SECRET_KEY = env['SECRET_KEY']{DATABASE}{USER_MODEL}{AUTHENTICATION}{MONITORING}{LOG_QUERIES}{AUTO_REFORMAT}{PANTHERDB_ENCRYPTION}
+SECRET_KEY = env['SECRET_KEY']{DATABASE}{REDIS}{USER_MODEL}{AUTHENTICATION}{MONITORING}{LOG_QUERIES}{AUTO_REFORMAT}
 
 # More Info: https://PantherPy.GitHub.io/urls/
 URLs = 'core.urls.url_routing'
+
+TIMEZONE = 'UTC'
 """ % datetime.now().date().isoformat()
 
 env = """SECRET_KEY='%s'
@@ -99,6 +100,7 @@ requirements = """panther==%s
 
 TEMPLATE = {
     'app': {
+        '__init__.py': '',
         'apis.py': apis_py,
         'models.py': models_py,
         'serializers.py': serializers_py,
@@ -106,6 +108,7 @@ TEMPLATE = {
         'urls.py': app_urls_py,
     },
     'core': {
+        '__init__.py': '',
         'configs.py': configs_py,
         'urls.py': urls_py,
     },
@@ -126,15 +129,16 @@ from panther.app import API
 from panther.request import Request
 from panther.response import Response
 from panther.throttling import Throttling
-from panther.utils import load_env
+from panther.utils import load_env, timezone_now
 
 BASE_DIR = Path(__name__).resolve().parent
 env = load_env(BASE_DIR / '.env')
 
-SECRET_KEY = env['SECRET_KEY']{DATABASE}{USER_MODEL}{AUTHENTICATION}{MONITORING}{LOG_QUERIES}{AUTO_REFORMAT}{PANTHERDB_ENCRYPTION}
+SECRET_KEY = env['SECRET_KEY']{DATABASE}{REDIS}{USER_MODEL}{AUTHENTICATION}{MONITORING}{LOG_QUERIES}{AUTO_REFORMAT}
 
 InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
 
+TIMEZONE = 'UTC'
 
 @API()
 async def hello_world_api():
@@ -147,7 +151,7 @@ async def info_api(request: Request):
         'panther_version': version(),
         'method': request.method,
         'query_params': request.query_params,
-        'datetime_now': datetime.now().isoformat(),
+        'datetime_now': timezone_now().isoformat(),
         'user_agent': request.headers.user_agent,
     }
     return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
@@ -155,10 +159,11 @@ async def info_api(request: Request):
 
 url_routing = {
     '/': hello_world_api,
+    'info/': info_api,
 }
 
 app = Panther(__name__, configs=__name__, urls=url_routing)
-"""
+""" % datetime.now().date().isoformat()
 
 SINGLE_FILE_TEMPLATE = {
     'main.py': single_main_py,
@@ -168,18 +173,37 @@ SINGLE_FILE_TEMPLATE = {
 }
 
 DATABASE_PANTHERDB_PART = """
-# More Info: Https://PantherPy.GitHub.io/middlewares/
 
-MIDDLEWARES = [
-    ('panther.middlewares.db.DatabaseMiddleware', {'url': f'pantherdb://{BASE_DIR}/database.pdb'}),
-]"""
+# More Info: https://PantherPy.GitHub.io/database/
+DATABASE = {
+    'engine': {
+        'class': 'panther.db.connections.PantherDBConnection',
+        'path': BASE_DIR / 'database.{PANTHERDB_EXTENSION}',
+        'encryption': {PANTHERDB_ENCRYPTION}
+    }
+}"""
 
 DATABASE_MONGODB_PART = """
-# More Info: Https://PantherPy.GitHub.io/middlewares/
 
-MIDDLEWARES = [
-    ('panther.middlewares.db.DatabaseMiddleware', {'url': f'mongodb://127.0.0.1:27017/{PROJECT_NAME}'}),
-]"""
+# More Info: https://PantherPy.GitHub.io/database/
+DATABASE = {
+    'engine': {
+        'class': 'panther.db.connections.MongoDBConnection',
+        'host': '127.0.0.1',
+        'port': 27017,
+        'database': '{PROJECT_NAME}'
+    }
+}"""
+
+REDIS_PART = """
+
+# More Info: https://PantherPy.GitHub.io/redis/
+REDIS = {
+    'class': 'panther.db.connections.RedisConnection',
+    'host': '127.0.0.1',
+    'port': 6379,
+    'db': 0,
+}"""
 
 USER_MODEL_PART = """
 
@@ -205,7 +229,3 @@ AUTO_REFORMAT_PART = """
 
 # More Info: https://pantherpy.github.io/configs/#auto_reformat/
 AUTO_REFORMAT = True"""
-
-PANTHERDB_ENCRYPTION = """
-
-PANTHERDB_ENCRYPTION = True"""

panther/cli/utils.py

@@ -3,11 +3,11 @@ import platform
 
 from rich import print as rprint
 
-from panther.exceptions import PantherException
+from panther.configs import Config
+from panther.exceptions import PantherError
 
 logger = logging.getLogger('panther')
 
-
 if platform.system() == 'Windows':
     h = '|'
     v = '_'
@@ -63,11 +63,11 @@ help_message = f"""{logo}
 """
 
 
-def import_error(message: str | Exception, package: str | None = None) -> None:
+def import_error(message: str | Exception, package: str | None = None) -> PantherError:
     msg = str(message)
     if package:
         msg += f' -> Hint: `pip install {package}`'
-    raise PantherException(msg)
+    return PantherError(msg)
 
 
 def cli_error(message: str | Exception) -> None:
@@ -109,44 +109,58 @@ def print_uvicorn_help_message():
     rprint('Run `uvicorn --help` for more help')
 
 
-def print_info(config: dict):
-    mo = config['monitoring']
-    lq = config['log_queries']
-    bt = config['background_tasks']
-    ws = config['has_ws']
-    bd = '{0:<39}'.format(str(config['base_dir']))
+def print_info(config: Config):
+    from panther.db.connections import redis
+
+    mo = config.MONITORING
+    lq = config.LOG_QUERIES
+    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]}...'
 
     # Monitoring
-    if config['monitoring']:
+    if config.MONITORING:
         monitor = f'{h} * Run "panther monitor" in another session for Monitoring{h}\n'
     else:
         monitor = None
 
     # Uvloop
+    uvloop_msg = None
     if platform.system() != 'Windows':
         try:
             import uvloop
-            uvloop = None
         except ImportError:
-            uvloop = (
+            uvloop_msg = (
                 f'{h} * You may want to install `uvloop` for better performance{h}\n'
                 f'{h}   `pip install uvloop`                                   {h}\n')
-    else:
-        uvloop = None
+
+    # 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'
+        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}   Websocket: {ws}                                   \t   {h}
 {h}   Base directory: {bd}{h}
 """
     if monitor:
         info_message += monitor
-    if uvloop:
-        info_message += uvloop
+    if uvloop_msg:
+        info_message += uvloop_msg
+    if gunicorn_msg:
+        info_message += gunicorn_msg
+
     info_message += bottom
     rprint(info_message)

panther/configs.py

@@ -1,3 +1,4 @@
+import copy
 import typing
 from dataclasses import dataclass
 from datetime import timedelta
@@ -7,7 +8,6 @@ from typing import Callable
 from pydantic._internal._model_construction import ModelMetaclass
 
 from panther.throttling import Throttling
-from panther.utils import Singleton
 
 
 class JWTConfig:
@@ -41,71 +41,78 @@ class QueryObservable:
     @classmethod
     def update(cls):
         for observer in cls.observers:
-            observer._reload_bases(parent=config.query_engine)
+            observer._reload_bases(parent=config.QUERY_ENGINE)
 
 
 @dataclass
-class Config(Singleton):
-    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
-    reversed_http_middlewares: list
-    reversed_ws_middlewares: list
-    user_model: ModelMetaclass | None
-    authentication: ModelMetaclass | None
-    jwt_config: JWTConfig | None
-    models: list[dict]
-    flat_urls: dict
-    urls: dict
-    query_engine: typing.Callable | None
-    websocket_connections: typing.Callable | None
-    background_tasks: bool
-    has_ws: bool
-    startup: Callable | None
-    shutdown: Callable | None
-    auto_reformat: bool
-    pantherdb_encryption: bool
+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[tuple]
+    WS_MIDDLEWARES: list[tuple]
+    USER_MODEL: ModelMetaclass | None
+    AUTHENTICATION: ModelMetaclass | None
+    WS_AUTHENTICATION: ModelMetaclass | None
+    JWT_CONFIG: JWTConfig | None
+    MODELS: list[dict]
+    FLAT_URLS: dict
+    URLS: dict
+    WEBSOCKET_CONNECTIONS: typing.Callable | None
+    BACKGROUND_TASKS: bool
+    HAS_WS: bool
+    STARTUPS: list[Callable]
+    SHUTDOWNS: list[Callable]
+    TIMEZONE: str
+    AUTO_REFORMAT: bool
+    QUERY_ENGINE: typing.Callable | None
+    DATABASE: typing.Callable | None
 
     def __setattr__(self, key, value):
         super().__setattr__(key, value)
-        if key == 'query_engine':
+        if key == 'QUERY_ENGINE' and value:
             QueryObservable.update()
 
     def __setitem__(self, key, value):
-        setattr(self, key, value)
+        setattr(self, key.upper(), value)
 
     def __getitem__(self, item):
-        return getattr(self, item)
-
-
-config = Config(
-    base_dir=Path(),
-    monitoring=False,
-    log_queries=False,
-    default_cache_exp=None,
-    throttling=None,
-    secret_key=None,
-    http_middlewares=[],
-    ws_middlewares=[],
-    reversed_http_middlewares=[],
-    reversed_ws_middlewares=[],
-    user_model=None,
-    authentication=None,
-    jwt_config=None,
-    models=[],
-    flat_urls={},
-    urls={},
-    query_engine=None,
-    websocket_connections=None,
-    background_tasks=False,
-    has_ws=False,
-    startup=None,
-    shutdown=None,
-    auto_reformat=False,
-    pantherdb_encryption=False,
-)
+        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',
+    'AUTO_REFORMAT': False,
+    'QUERY_ENGINE': None,
+    'DATABASE': None,
+}
+
+config = Config(**copy.deepcopy(default_configs))