panther 4.2.6__tar.gz → 4.3.1__tar.gz

{panther-4.2.6 → panther-4.3.1}/PKG-INFO

@@ -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
@@ -19,6 +19,7 @@ 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"

{panther-4.2.6 → panther-4.3.1}/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-4.2.6 → panther-4.3.1}/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-4.2.6 → panther-4.3.1}/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-4.2.6 → panther-4.3.1}/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-4.2.6 → panther-4.3.1}/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-4.2.6 → panther-4.3.1}/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 → panther-4.3.1}/panther.egg-info/PKG-INFO

@@ -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
@@ -19,6 +19,7 @@ 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"

{panther-4.2.6 → panther-4.3.1}/panther.egg-info/requires.txt

@@ -4,6 +4,7 @@ pydantic~=2.7.4
 rich~=13.7.1
 uvicorn~=0.27.1
 pytz~=2024.1
+Jinja2~=3.1
 
 [full]
 redis==5.0.1

{panther-4.2.6 → panther-4.3.1}/setup.py

@@ -56,6 +56,7 @@ setup(
         'rich~=13.7.1',
         'uvicorn~=0.27.1',
         'pytz~=2024.1',
+        'Jinja2~=3.1',
     ],
     extras_require=EXTRAS_REQUIRE,
 )

{panther-4.2.6 → panther-4.3.1}/tests/test_response.py

@@ -2,7 +2,7 @@ from unittest import IsolatedAsyncioTestCase
 
 from panther import Panther
 from panther.app import API, GenericAPI
-from panther.response import Response, HTMLResponse, PlainTextResponse, StreamingResponse
+from panther.response import Response, HTMLResponse, PlainTextResponse, StreamingResponse, TemplateResponse
 from panther.test import APIClient
 
 
@@ -116,6 +116,18 @@ class ReturnHTMLResponse(GenericAPI):
         return HTMLResponse('<html><head><title></title></head></html>')
 
 
+@API()
+async def return_template_response() -> TemplateResponse:
+    return TemplateResponse(source='<html><body><p>{{ content }}</p></body></html>', context={'content': 'Hello World'})
+
+
+class ReturnTemplateResponse(GenericAPI):
+    def get(self) -> TemplateResponse:
+        return TemplateResponse(
+            source='<html><body><p>{{ content }}</p></body></html>', context={'content': 'Hello World'}
+        )
+
+
 @API()
 async def return_plain_response():
     return PlainTextResponse('Hello World')
@@ -160,7 +172,7 @@ urls = {
     'response-tuple': return_response_tuple,
     'html': return_html_response,
     'plain': return_plain_response,
-
+    'template': return_template_response,
     'nothing-cls': ReturnNothing,
     'none-cls': ReturnNone,
     'dict-cls': ReturnDict,
@@ -172,8 +184,8 @@ urls = {
     'response-list-cls': ReturnResponseList,
     'response-tuple-cls': ReturnResponseTuple,
     'html-cls': ReturnHTMLResponse,
+    'template-cls': ReturnTemplateResponse,
     'plain-cls': ReturnPlainResponse,
-
     'stream': ReturnStreamingResponse,
     'async-stream': ReturnAsyncStreamingResponse,
     'invalid-status-code': ReturnInvalidStatusCode,
@@ -406,6 +418,26 @@ class TestResponses(IsolatedAsyncioTestCase):
         assert res.headers['Access-Control-Allow-Origin'] == '*'
         assert res.headers['Content-Length'] == '41'
 
+    async def test_response_template(self) -> None:
+        res: Response = await self.client.get('template/')
+        assert res.status_code == 200
+        assert res.data == '<html><body><p>Hello World</p></body></html>'
+        assert res.body == b'<html><body><p>Hello World</p></body></html>'
+        assert set(res.headers.keys()) == {'Content-Type', 'Access-Control-Allow-Origin', 'Content-Length'}
+        assert res.headers['Content-Type'] == 'text/html; charset=utf-8'
+        assert res.headers['Access-Control-Allow-Origin'] == '*'
+        assert res.headers['Content-Length'] == '44'
+
+    async def test_response_template_cls(self) -> None:
+        res: Response = await self.client.get('template-cls/')
+        assert res.status_code == 200
+        assert res.data == '<html><body><p>Hello World</p></body></html>'
+        assert res.body == b'<html><body><p>Hello World</p></body></html>'
+        assert set(res.headers.keys()) == {'Content-Type', 'Access-Control-Allow-Origin', 'Content-Length'}
+        assert res.headers['Content-Type'] == 'text/html; charset=utf-8'
+        assert res.headers['Access-Control-Allow-Origin'] == '*'
+        assert res.headers['Content-Length'] == '44'
+
     async def test_response_plain(self):
         res = await self.client.get('plain/')
         assert res.status_code == 200

{panther-4.2.6 → panther-4.3.1}/tests/test_utils.py

@@ -379,6 +379,60 @@ class TestLoadConfigs(TestCase):
                 AUTHENTICATION = None
                 SECRET_KEY = None
 
+    def test_check_function_endpoint_decorator(self):
+        with self.assertLogs(level='ERROR') as captured:
+            try:
+                Panther(name=__name__, configs=__name__, urls={'/': invalid_api})
+            except SystemExit:
+                assert True
+            else:
+                assert False
+
+        assert len(captured.records) == 1
+        assert captured.records[0].getMessage() == 'You may have forgotten to use `@API()` on the `tests.test_utils.invalid_api()`'
+
+    def test_check_class_endpoint_inheritance(self):
+        with self.assertLogs(level='ERROR') as captured:
+            try:
+                Panther(name=__name__, configs=__name__, urls={'/': InvalidAPI})
+            except SystemExit:
+                assert True
+            else:
+                assert False
+
+        assert len(captured.records) == 1
+        assert captured.records[0].getMessage() == (
+            f'You may have forgotten to inherit from `panther.app.GenericAPI` or `panther.app.GenericWebsocket` '
+            f'on the `tests.test_utils.InvalidAPI()`'
+        )
+
+    def test_check_websocket_inheritance(self):
+        with self.assertLogs(level='ERROR') as captured:
+            try:
+                Panther(name=__name__, configs=__name__, urls={'/': InvalidWebsocket})
+            except SystemExit:
+                assert True
+            else:
+                assert False
+
+        assert len(captured.records) == 1
+        assert captured.records[0].getMessage() == (
+            f'You may have forgotten to inherit from `panther.app.GenericAPI` or `panther.app.GenericWebsocket` '
+            f'on the `tests.test_utils.InvalidWebsocket()`'
+        )
+
+
+def invalid_api():
+    pass
+
+
+class InvalidAPI:
+    pass
+
+
+class InvalidWebsocket:
+    pass
+
 
 class CorrectTestMiddleware(BaseMiddleware):
     pass