panther 4.2.6__py3-none-any.whl → 4.3.1__py3-none-any.whl

panther/__init__.py

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

panther/_load_configs.py

@@ -1,9 +1,10 @@
 import logging
 import sys
+import types
 from importlib import import_module
 from multiprocessing import Manager
 
-from panther._utils import import_class
+from panther._utils import import_class, check_function_type_endpoint, check_class_type_endpoint
 from panther.background_tasks import background_tasks
 from panther.base_websocket import WebsocketConnections
 from panther.cli.utils import import_error
@@ -29,12 +30,14 @@ __all__ = (
     'load_user_model',
     'load_log_queries',
     'load_middlewares',
+    'load_templates_dir',
     'load_auto_reformat',
     'load_background_tasks',
     'load_default_cache_exp',
     'load_authentication_class',
     'load_urls',
     'load_websocket_connections',
+    'check_endpoints_inheritance',
 )
 
 logger = logging.getLogger('panther')
@@ -82,6 +85,11 @@ def load_timezone(_configs: dict, /) -> None:
         config.TIMEZONE = timezone
 
 
+def load_templates_dir(_configs: dict, /) -> None:
+    if templates_dir := _configs.get('TEMPLATES_DIR'):
+        config.TEMPLATES_DIR = templates_dir
+
+
 def load_database(_configs: dict, /) -> None:
     database_config = _configs.get('DATABASE', {})
     if 'engine' in database_config:
@@ -259,5 +267,14 @@ def load_websocket_connections():
         config.WEBSOCKET_CONNECTIONS = WebsocketConnections(pubsub_connection=pubsub_connection)
 
 
+def check_endpoints_inheritance():
+    """Should be after `load_urls()`"""
+    for _, endpoint in config.FLAT_URLS.items():
+        if isinstance(endpoint, types.FunctionType):
+            check_function_type_endpoint(endpoint=endpoint)
+        else:
+            check_class_type_endpoint(endpoint=endpoint)
+
+
 def _exception_handler(field: str, error: str | Exception) -> PantherError:
     return PantherError(f"Invalid '{field}': {error}")

panther/_utils.py

@@ -4,12 +4,13 @@ import logging
 import re
 import subprocess
 import types
-from typing import Any, Generator, Iterator, AsyncGenerator
 from collections.abc import Callable
 from traceback import TracebackException
+from typing import Any, Generator, Iterator, AsyncGenerator
 
 from panther.exceptions import PantherError
 from panther.file_handler import File
+from panther.websocket import GenericWebsocket
 
 logger = logging.getLogger('panther')
 
@@ -99,19 +100,18 @@ def reformat_code(base_dir):
 def check_function_type_endpoint(endpoint: types.FunctionType) -> Callable:
     # Function Doesn't Have @API Decorator
     if not hasattr(endpoint, '__wrapped__'):
-        logger.critical(f'You may have forgotten to use @API() on the {endpoint.__name__}()')
-        raise TypeError
-    return endpoint
+        raise PantherError(
+            f'You may have forgotten to use `@API()` on the `{endpoint.__module__}.{endpoint.__name__}()`')
 
 
 def check_class_type_endpoint(endpoint: Callable) -> Callable:
     from panther.app import GenericAPI
 
-    if not issubclass(endpoint, GenericAPI):
-        logger.critical(f'You may have forgotten to inherit from GenericAPI on the {endpoint.__name__}()')
-        raise TypeError
-
-    return endpoint().call_method
+    if not issubclass(endpoint, (GenericAPI, GenericWebsocket)):
+        raise PantherError(
+            f'You may have forgotten to inherit from `panther.app.GenericAPI` or `panther.app.GenericWebsocket` '
+            f'on the `{endpoint.__module__}.{endpoint.__name__}()`'
+        )
 
 
 def async_next(iterator: Iterator):

panther/configs.py

@@ -67,6 +67,7 @@ class Config:
     STARTUPS: list[Callable]
     SHUTDOWNS: list[Callable]
     TIMEZONE: str
+    TEMPLATES_DIR: str | list[str]
     AUTO_REFORMAT: bool
     QUERY_ENGINE: typing.Callable | None
     DATABASE: typing.Callable | None
@@ -110,6 +111,7 @@ default_configs = {
     'STARTUPS': [],
     'SHUTDOWNS': [],
     'TIMEZONE': 'UTC',
+    'TEMPLATES_DIR': 'templates',
     'AUTO_REFORMAT': False,
     'QUERY_ENGINE': None,
     'DATABASE': None,

panther/main.py

@@ -58,6 +58,7 @@ class Panther:
         load_throttling(self._configs_module)
         load_user_model(self._configs_module)
         load_log_queries(self._configs_module)
+        load_templates_dir(self._configs_module)
         load_middlewares(self._configs_module)
         load_auto_reformat(self._configs_module)
         load_background_tasks(self._configs_module)
@@ -66,6 +67,8 @@ class Panther:
         load_urls(self._configs_module, urls=self._urls)
         load_websocket_connections()
 
+        check_endpoints_inheritance()
+
     async def __call__(self, scope: dict, receive: Callable, send: Callable) -> None:
         if scope['type'] == 'lifespan':
             message = await receive()
@@ -159,19 +162,10 @@ class Panther:
         await request.read_body()
 
         # Find Endpoint
-        _endpoint, found_path = find_endpoint(path=request.path)
-        if _endpoint is None:
+        endpoint, found_path = find_endpoint(path=request.path)
+        if endpoint is None:
             return await self._raise(send, monitoring=monitoring, status_code=status.HTTP_404_NOT_FOUND)
 
-        # Check Endpoint Type
-        try:
-            if isinstance(_endpoint, types.FunctionType):
-                endpoint = check_function_type_endpoint(endpoint=_endpoint)
-            else:
-                endpoint = check_class_type_endpoint(endpoint=_endpoint)
-        except TypeError:
-            return await self._raise(send, monitoring=monitoring, status_code=status.HTTP_501_NOT_IMPLEMENTED)
-
         # Collect Path Variables
         request.collect_path_variables(found_path=found_path)
 
@@ -185,6 +179,10 @@ class Panther:
                         f'Make sure to return the `request` at the end of `{middleware.__class__.__name__}.before()`')
                     return await self._raise(send, monitoring=monitoring)
 
+            # Prepare the method
+            if not isinstance(endpoint, types.FunctionType):
+                endpoint = endpoint().call_method
+
             # Call Endpoint
             response = await endpoint(request=request)
 

panther/response.py

@@ -1,11 +1,22 @@
 import asyncio
+from sys import version_info
 from types import NoneType
 from typing import Generator, AsyncGenerator, Any, Type
 
+if version_info >= (3, 11):
+    from typing import LiteralString
+else:
+    from typing import TypeVar
+
+    LiteralString = TypeVar('LiteralString')
+
+
 import orjson as json
 from pydantic import BaseModel
+from jinja2 import Environment, FileSystemLoader
 
 from panther import status
+from panther.configs import config
 from panther._utils import to_async_generator
 from panther.db.cursor import Cursor
 from pantherdb import Cursor as PantherDBCursor
@@ -215,3 +226,29 @@ class PlainTextResponse(Response):
         if isinstance(self.data, bytes):
             return self.data
         return self.data.encode()
+
+
+class TemplateResponse(HTMLResponse):
+    environment = Environment(loader=FileSystemLoader(config.TEMPLATES_DIR))
+
+    def __init__(
+        self,
+        source: str | LiteralString | NoneType = None,
+        path: str | NoneType = None,
+        context: dict | NoneType = None,
+        headers: dict | NoneType = None,
+        status_code: int = status.HTTP_200_OK,
+        pagination: Pagination | NoneType = None,
+    ):
+        """
+        :param source: should be a string
+        :param path: should be path of template file
+        :param context: should be dict of items
+        :param headers: should be dict of headers
+        :param status_code: should be int
+        :param pagination: instance of Pagination or None
+            Its template() method will be used
+        """
+
+        template = self.environment.get_template(path) if path is not None else self.environment.from_string(source)
+        super().__init__(template.render(context), headers, status_code, pagination=pagination)

{panther-4.2.6.dist-info → panther-4.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.2.6
+Version: 4.3.1
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -13,21 +13,22 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: httptools ~=0.6.1
-Requires-Dist: pantherdb ~=2.1.0
-Requires-Dist: pydantic ~=2.7.4
-Requires-Dist: rich ~=13.7.1
-Requires-Dist: uvicorn ~=0.27.1
-Requires-Dist: pytz ~=2024.1
+Requires-Dist: httptools~=0.6.1
+Requires-Dist: pantherdb~=2.1.0
+Requires-Dist: pydantic~=2.7.4
+Requires-Dist: rich~=13.7.1
+Requires-Dist: uvicorn~=0.27.1
+Requires-Dist: pytz~=2024.1
+Requires-Dist: Jinja2~=3.1
 Provides-Extra: full
-Requires-Dist: redis ==5.0.1 ; extra == 'full'
-Requires-Dist: motor ~=3.5.0 ; extra == 'full'
-Requires-Dist: bpython ~=0.24 ; extra == 'full'
-Requires-Dist: ruff ~=0.1.9 ; extra == 'full'
-Requires-Dist: python-jose ~=3.3.0 ; extra == 'full'
-Requires-Dist: websockets ~=12.0 ; extra == 'full'
-Requires-Dist: cryptography ~=42.0.8 ; extra == 'full'
-Requires-Dist: watchfiles ~=0.21.0 ; extra == 'full'
+Requires-Dist: redis==5.0.1; extra == "full"
+Requires-Dist: motor~=3.5.0; extra == "full"
+Requires-Dist: bpython~=0.24; extra == "full"
+Requires-Dist: ruff~=0.1.9; extra == "full"
+Requires-Dist: python-jose~=3.3.0; extra == "full"
+Requires-Dist: websockets~=12.0; extra == "full"
+Requires-Dist: cryptography~=42.0.8; extra == "full"
+Requires-Dist: watchfiles~=0.21.0; extra == "full"
 
 
 [![PyPI](https://img.shields.io/pypi/v/panther?label=PyPI)](https://pypi.org/project/panther/) [![PyVersion](https://img.shields.io/pypi/pyversions/panther.svg)](https://pypi.org/project/panther/) [![codecov](https://codecov.io/github/AliRn76/panther/graph/badge.svg?token=YWFQA43GSP)](https://codecov.io/github/AliRn76/panther) [![Downloads](https://static.pepy.tech/badge/panther/month)](https://pepy.tech/project/panther) [![license](https://img.shields.io/github/license/alirn76/panther.svg)](https://github.com/alirn76/panther/blob/main/LICENSE)

{panther-4.2.6.dist-info → panther-4.3.1.dist-info}/RECORD

@@ -1,24 +1,24 @@
-panther/__init__.py,sha256=tmDiShQr_-JjYBeI3TswawX-WkQFwh8Hmd0pmBS_6-8,110
-panther/_load_configs.py,sha256=AVkoixkUFkBQiTmrLrwCmg0eiPW2U_Uw2EGNEGQRfnI,9281
-panther/_utils.py,sha256=j0rwIxTf0rtcZAAD-1nGE-_bWpvinyKtnwt3uO0hMmY,4330
+panther/__init__.py,sha256=hMDOHZroAMX-dAiBlxUfhmaKrxK2GYCD-0hCQf25VJU,110
+panther/_load_configs.py,sha256=NZEwp3s7Mq_gU6w5FFN-3JfJImjZtf4_q-qengDQ6Y0,9875
+panther/_utils.py,sha256=R1tsUde1zA5iJtk-ZvWe8hp6JaNhKgNoH2rxpdiQDMc,4449
 panther/app.py,sha256=e2eb4sXIaBje5vpcm4pbvvEO_sj83pLfBHCIZJFFX38,8222
 panther/authentications.py,sha256=gf7BVyQ8vXKhiumJAtD0aAK7uIHWx_snbOKYAKrYuVw,5677
 panther/background_tasks.py,sha256=HBYubDIiO_673cl_5fqCUP9zzimzRgRkDSkag9Msnbs,7656
 panther/base_request.py,sha256=XD2v1gLWcCKHePowRxT6_fYnS4tdKFxTLINMX0HQu8M,3880
 panther/base_websocket.py,sha256=L0tiQQjg7E3462cd91PMf_SoVMMK4YiwW45yTFdTLhY,10973
 panther/caching.py,sha256=ltuJYdjNiAaKIs3jpO5EBpL8Y6CF1vAIQqh8J_Np10g,4098
-panther/configs.py,sha256=EaLApT6nYcguBoNXBG_8n6DU6HTNxsulI2943j8UAkE,3174
+panther/configs.py,sha256=Z8bo--VqspXJKk1_LR2zovDi3oG2lITMJ9brgo5lNog,3243
 panther/events.py,sha256=bxDqrfiNNBlvD03vEk2LDK4xbMzTMFVcgAjx2ein7mI,1158
 panther/exceptions.py,sha256=7rHdJIES2__kqOStIqbHl3Uxask2lzKgLQlkZvvDwFA,1591
 panther/file_handler.py,sha256=I94tpbtTVniBnnUMkFr3Eis6kPDt8sLzS5u8TzFrR5I,1323
 panther/generics.py,sha256=D2ia7M4ML15kMZiuCIMpL7ZfQhMmKpqE4wCmuRE-q4Y,7233
 panther/logging.py,sha256=SGgF9faQM1QmbmMPVc6m1DY-TbV329kTD8BuzGLx3I0,2073
-panther/main.py,sha256=UbIxwaojvY_vH9nYfBpkulRBqVEj4Lbl81Er4XW_KCY,9334
+panther/main.py,sha256=SnDN_aqpg5qG7jqwrb9JEiBs9bSmUUDursGuXs3FJbQ,9159
 panther/monitoring.py,sha256=y1F3c8FJlnmooM-m1nSyOTa9eWq0v1nHnmw9zz-4Kls,1314
 panther/pagination.py,sha256=ANJrEF0q1nVAfD33I4nZfUUxFcETzJb01gIhbZX3HEw,1639
 panther/permissions.py,sha256=9-J5vzvEKa_PITwEVQbZZv8PG2FOu05YBlD5yMrKcfc,348
 panther/request.py,sha256=F9ZiAWSse7_6moAzqdoFInUN4zTKlzijh9AdU9w3Jfw,1673
-panther/response.py,sha256=Njp4zJozNic8J4ucG8Sgh-xeBZOgtoz2cfdDkJlGOWU,7582
+panther/response.py,sha256=uQ41lmBhdFUu3mmkftmbiZEvVgGoenEbt7zVwIDodbk,8851
 panther/routings.py,sha256=1eqbjubLnUUEQRlz8mIF464ImvCMjyasiekHBtxEQoQ,6218
 panther/serializer.py,sha256=UX-cVS-11KnxijUhPXsBs_Pb-Sm3EVzUQFTf9bFQT0A,9096
 panther/status.py,sha256=Gc_PnYrHfInTsZpGbqiCfDB-py1C7Rh8KMdb6Lq9Exs,3346
@@ -49,9 +49,9 @@ panther/panel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 panther/panel/apis.py,sha256=COsbwKZyTgyHvHYbpDfusifAH9ojMS3z1KhZCt9M-Ms,2428
 panther/panel/urls.py,sha256=JiV-H4dWE-m_bfaTTVxzOxTvJmOWhyLOvcbM7xU3Bn4,240
 panther/panel/utils.py,sha256=0Rv79oR5IEqalqwpRKQHMn1p5duVY5mxMqDKiA5mWx4,437
-panther-4.2.6.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
-panther-4.2.6.dist-info/METADATA,sha256=UuyDwsfYekAvKNc_9GgkLiPnKs4zgraJUXY2jxRFxq4,6532
-panther-4.2.6.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-panther-4.2.6.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
-panther-4.2.6.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
-panther-4.2.6.dist-info/RECORD,,
+panther-4.3.1.dist-info/LICENSE,sha256=2aF1hL2aC0zRPjzUkSxJUzZbn2_uLoOkn7DHjzZni-I,1524
+panther-4.3.1.dist-info/METADATA,sha256=32_c-_BRnAQRawYwDccXv1fpYEk571vUqAAEA20ltX8,6537
+panther-4.3.1.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+panther-4.3.1.dist-info/entry_points.txt,sha256=6GPxYFGuzVfNB4YpHFJvYex6iWah5_tLnirAHwj2Qsg,51
+panther-4.3.1.dist-info/top_level.txt,sha256=VbBs02JGXTIoHMzsX-eLOk2MCbBZzQbLhWiYpI7xI2g,8
+panther-4.3.1.dist-info/RECORD,,

{panther-4.2.6.dist-info → panther-4.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any