fastapi_chameleon 0.1.9__py3-none-any.whl

fastapi_chameleon/__init__.py

@@ -0,0 +1,9 @@
+"""fastapi-chameleon - Adds integration of the Chameleon template language to FastAPI."""
+
+__version__ = '0.1.9'
+__author__ = 'Michael Kennedy <michael@talkpython.fm>'
+__all__ = ['template', 'global_init']
+
+from .engine import global_init
+from .engine import template
+from .engine import response

fastapi_chameleon/engine.py

@@ -0,0 +1,115 @@
+import inspect
+import os
+from functools import wraps
+from typing import Optional, Union, Callable
+
+import fastapi
+from chameleon import PageTemplateLoader, PageTemplate
+
+from fastapi_chameleon.exceptions import FastAPIChameleonException
+
+__templates: Optional[PageTemplateLoader] = None
+template_path: Optional[str] = None
+
+
+def global_init(template_folder: str, auto_reload=False, cache_init=True):
+    global __templates, template_path
+
+    if __templates and cache_init:
+        return
+
+    if not template_folder:
+        msg = f'The template_folder must be specified.'
+        raise FastAPIChameleonException(msg)
+
+    if not os.path.isdir(template_folder):
+        msg = f"The specified template folder must be a folder, it's not: {template_folder}"
+        raise FastAPIChameleonException(msg)
+
+    template_path = template_folder
+    __templates = PageTemplateLoader(template_folder, auto_reload=auto_reload)
+
+
+def clear():
+    global __templates, template_path
+    __templates = None
+    template_path = None
+
+
+def render(template_file: str, **template_data):
+    if not __templates:
+        raise FastAPIChameleonException("You must call global_init() before rendering templates.")
+
+    page: PageTemplate = __templates[template_file]
+    return page.render(encoding='utf-8', **template_data)
+
+
+def response(template_file: str, mimetype='text/html', status_code=200, **template_data):
+    html = render(template_file, **template_data)
+    return fastapi.Response(content=html, media_type=mimetype, status_code=status_code)
+
+
+def template(template_file: Optional[Union[Callable, str]] = None, mimetype: str = 'text/html'):
+    """
+    Decorate a FastAPI view method to render an HTML response.
+
+    :param str template_file: Optional, the Chameleon template file (path relative to template folder, *.pt).
+    :param str mimetype: The mimetype response (defaults to text/html).
+    :return: Decorator to be consumed by FastAPI
+    """
+
+    wrapped_function = None
+    if callable(template_file):
+        wrapped_function = template_file
+        template_file = None
+
+    def response_inner(f):
+        nonlocal template_file
+        global template_path
+
+        if not template_path:
+            template_path = 'templates'
+            # raise FastAPIChameleonException("Cannot continue: fastapi_chameleon.global_init() has not been called.")
+
+        if not template_file:
+            # Use the default naming scheme: template_folder/module_name/function_name.pt
+            module = f.__module__
+            if '.' in module:
+                module = module.split('.')[-1]
+            view = f.__name__
+            template_file = f'{module}/{view}.html'
+
+            if not os.path.exists(os.path.join(template_path, template_file)):
+                template_file = f'{module}/{view}.pt'
+
+        @wraps(f)
+        def sync_view_method(*args, **kwargs):
+            response_val = f(*args, **kwargs)
+            return __render_response(template_file, response_val, mimetype)
+
+        @wraps(f)
+        async def async_view_method(*args, **kwargs):
+            response_val = await f(*args, **kwargs)
+            return __render_response(template_file, response_val, mimetype)
+
+        if inspect.iscoroutinefunction(f):
+            return async_view_method
+        else:
+            return sync_view_method
+
+    return response_inner(wrapped_function) if wrapped_function else response_inner
+
+
+def __render_response(template_file, response_val, mimetype):
+    # source skip: assign-if-exp
+    if isinstance(response_val, fastapi.Response):
+        return response_val
+
+    if template_file and not isinstance(response_val, dict):
+        msg = f"Invalid return type {type(response_val)}, we expected a dict or fastapi.Response as the return value."
+        raise FastAPIChameleonException(msg)
+
+    model = response_val
+
+    html = render(template_file, **model)
+    return fastapi.Response(content=html, media_type=mimetype)

fastapi_chameleon/exceptions.py

@@ -0,0 +1,2 @@
+class FastAPIChameleonException(Exception):
+    pass

fastapi_chameleon-0.1.9.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Michael Kennedy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_chameleon-0.1.9.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: fastapi-chameleon
+Version: 0.1.9
+Summary: Adds integration of the Chameleon template language to FastAPI.
+Home-page: https://github.com/mikeckennedy/fastapi-chameleon
+Author: Michael Kennedy
+Author-email: michael@talkpython.fm
+License: MIT
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: Chameleon
+
+# fastapi-chameleon
+
+Adds integration of the Chameleon template language to FastAPI. If you are interested in Jinja instead, see the sister project: [github.com/AGeekInside/fastapi-jinja](https://github.com/AGeekInside/fastapi-jinja).
+
+## Installation
+
+Simply `pip install fastapi_chameleon`.
+
+## Usage
+
+This is easy to use. Just create a folder within your web app to hold the templates such as:
+
+```
+├── main.py
+├── views.py
+│
+├── templates
+│   ├── home
+│   │   └── index.pt
+│   └── shared
+│       └── layout.pt
+
+```
+
+In the app startup, tell the library about the folder you wish to use:
+
+```python
+import os
+import fastapi_chameleon
+
+dev_mode = True
+
+folder = os.path.dirname(__file__)
+template_folder = os.path.join(folder, 'templates')
+template_folder = os.path.abspath(template_folder)
+
+fastapi_chameleon.global_init(template_folder, auto_reload=dev_mode)
+```
+
+Then just decorate the FastAPI view methods (works on sync and async methods):
+
+```python
+@router.post('/')
+@fastapi_chameleon.template('home/index.pt')
+async def home_post(request: Request):
+    form = await request.form()
+    vm = PersonViewModel(**form) 
+
+    return vm.dict() # {'first':'Michael', 'last':'Kennedy', ...}
+
+```
+
+The view method should return a `dict` to be passed as variables/values to the template. 
+
+If a `fastapi.Response` is returned, the template is skipped and the response along with status_code and
+other values is directly passed through. This is common for redirects and error responses not meant
+for this page template.
+
+

fastapi_chameleon-0.1.9.dist-info/RECORD

@@ -0,0 +1,8 @@
+fastapi_chameleon/__init__.py,sha256=LBPvG4Ylc2XSgSGVNnn-HIE1Rubz_2EIxrgpSNfqFEs,297
+fastapi_chameleon/engine.py,sha256=30OGDUXAcxGUQQMlJ2pWZoEanBX8gWLq8tdcz3pvp5U,3939
+fastapi_chameleon/exceptions.py,sha256=qjxR28_YzuPwUmYsbCZLUUAMt2Kl4b8Arjtr24Xmo9E,53
+fastapi_chameleon-0.1.9.dist-info/LICENSE,sha256=G9Edv3jcTxX10DuIIQqR3yzEHsSsDssPuGlM-pWjV-s,1072
+fastapi_chameleon-0.1.9.dist-info/METADATA,sha256=tXKFDb51eBDHVsKRdquQXAqKZ_sCtFS6rIeb9D8jUV4,2365
+fastapi_chameleon-0.1.9.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
+fastapi_chameleon-0.1.9.dist-info/top_level.txt,sha256=nBgDUgc1tkIDIL-YY-BplWuaKgE5N2kbrpGrmGwo0ns,18
+fastapi_chameleon-0.1.9.dist-info/RECORD,,

fastapi_chameleon-0.1.9.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.36.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fastapi_chameleon-0.1.9.dist-info/top_level.txt

@@ -0,0 +1 @@
+fastapi_chameleon