panther 4.2.6__tar.gz → 4.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.2.6
+Version: 4.3.0
 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.0}/panther/__init__.py

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

{panther-4.2.6 → panther-4.3.0}/panther/_load_configs.py

@@ -29,6 +29,7 @@ __all__ = (
     'load_user_model',
     'load_log_queries',
     'load_middlewares',
+    'load_templates_dir',
     'load_auto_reformat',
     'load_background_tasks',
     'load_default_cache_exp',
@@ -82,6 +83,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:

{panther-4.2.6 → panther-4.3.0}/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.0}/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)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 4.2.6
+Version: 4.3.0
 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.0}/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.0}/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.0}/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