├── setup.py ├── README.md ├── .gitignore ├── sanic_mako.py └── LICENSE /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | sanic-mako 3 | ---------- 4 | 5 | """ 6 | import os 7 | import re 8 | import sys 9 | import codecs 10 | from setuptools import setup 11 | 12 | with codecs.open(os.path.join(os.path.abspath(os.path.dirname( 13 | __file__)), 'sanic_mako.py'), 'r', 'latin1') as fp: 14 | try: 15 | version = re.findall(r"^__version__ = '([^']+)'$", fp.read(), re.M)[0] 16 | except IndexError: 17 | raise RuntimeError('Unable to determine version.') 18 | 19 | setup( 20 | name='Sanic-Mako', 21 | version=version, 22 | url='https://github.com/dongweiming/sanic-mako', 23 | license='Apache 2', 24 | author='DongWeiming', 25 | author_email='ciici123@gmail.com', 26 | description='Mako templating support for Sanic.', 27 | long_description=__doc__, 28 | py_modules=['sanic_mako'], 29 | zip_safe=False, 30 | platforms='any', 31 | install_requires=['Werkzeug', 'Mako'], 32 | long_description_content_type="text/markdown", 33 | classifiers=[ 34 | 'Framework :: AsyncIO', 35 | 'Environment :: Web Environment', 36 | 'Intended Audience :: Developers', 37 | 'License :: OSI Approved :: Apache Software License', 38 | 'Operating System :: OS Independent', 39 | 'Programming Language :: Python', 40 | 'Programming Language :: Python :: 3', 41 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 42 | 'Topic :: Software Development :: Libraries :: Python Modules' 43 | ] 44 | ) 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sanic-mako 2 | Mako support for sanic 3 | 4 | ## Installation 5 | 6 | `python3 -m pip install sanic-mako` 7 | 8 | ## Features 9 | 10 | `sanic-mako` supports: 11 | 12 | - `@mako.template` syntax 13 | - use `render_template_def` render a specific def from a given template 14 | - use `render_template` render a template from the template folder with the given context 15 | - factory pattern `init_app` method for creating apps 16 | 17 | ## Usage 18 | 19 | ```python 20 | 21 | from sanic import Sanic 22 | from sanic.response import json 23 | from sanic_mako import SanicMako 24 | 25 | app = Sanic() 26 | 27 | mako = SanicMako(app) 28 | # or setup later 29 | # mako = SanicMako() 30 | # mako.init_app(app) 31 | 32 | @app.route('/') 33 | @mako.template('index.html') # decorator method is staticmethod 34 | async def index(request): 35 | return {'greetings': 'Hello, sanic!'} 36 | 37 | 38 | @bp.route('/login', methods=['GET', 'POST']) 39 | async def login(request): 40 | error = None 41 | return await render_template('admin/login_user.html', request, 42 | {'error': error}) 43 | 44 | 45 | @bp.route('/post//react', methods=['POST', 'DELETE']) 46 | async def react(request, post_id): 47 | # ... 48 | return json({ 'r': 0, 'html': await render_template_def( 49 | 'utils.html', 'render_react_container', request, 50 | {'reaction_type': reaction_type }) }) 51 | 52 | 53 | if __name__ == '__main__': 54 | app.run(host='0.0.0.0', port=8000, debug=True) 55 | ``` 56 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /sanic_mako.py: -------------------------------------------------------------------------------- 1 | import os 2 | import asyncio 3 | import functools 4 | import sys 5 | import pkgutil 6 | from collections.abc import Mapping 7 | 8 | from sanic.response import HTTPResponse 9 | from mako.lookup import TemplateLookup 10 | from sanic.exceptions import ServerError 11 | from mako.exceptions import TemplateLookupException, text_error_template 12 | 13 | __version__ = '0.7.0' 14 | 15 | __all__ = ('get_lookup', 'render_template', 'render_template_def', 16 | 'render_string') 17 | 18 | 19 | APP_KEY = 'sanic_mako_lookup' 20 | APP_CONTEXT_PROCESSORS_KEY = 'sanic_mako_context_processors' 21 | REQUEST_CONTEXT_KEY = 'sanic_mako_context' 22 | 23 | 24 | def get_root_path(import_name): 25 | mod = sys.modules.get(import_name) 26 | if mod is not None and hasattr(mod, '__file__'): 27 | return os.path.dirname(os.path.abspath(mod.__file__)) 28 | 29 | loader = pkgutil.get_loader(import_name) 30 | if loader is None or import_name == '__main__': 31 | return os.getcwd() 32 | 33 | __import__(import_name) 34 | mod = sys.modules[import_name] 35 | filepath = getattr(mod, '__file__', None) 36 | 37 | if filepath is None: 38 | raise RuntimeError('No root path can be found for the provided ' 39 | 'module "{import_name}". This can happen because the ' 40 | 'module came from an import hook that does ' 41 | 'not provide file name information or because ' 42 | 'it\'s a namespace package. In this case ' 43 | 'the root path needs to be explicitly provided.') 44 | 45 | return os.path.dirname(os.path.abspath(filepath)) 46 | 47 | 48 | class TemplateError(RuntimeError): 49 | """ A template has thrown an error during rendering. """ 50 | 51 | def __init__(self, template): 52 | super(TemplateError, self).__init__() 53 | self.einfo = sys.exc_info() 54 | self.text = text_error_template().render() 55 | if hasattr(template, 'uri'): 56 | msg = "Error occurred while rendering template '{0}'" 57 | msg = msg.format(template.uri) 58 | else: 59 | msg = template.args[0] 60 | super(TemplateError, self).__init__(msg) 61 | 62 | 63 | class SanicMako: 64 | def __init__(self, app=None, pkg_path=None, context_processors=(), 65 | app_key=APP_KEY): 66 | self.app = app 67 | 68 | if app: 69 | self.init_app(app, pkg_path, context_processors) 70 | 71 | def init_app(self, app, pkg_path=None, context_processors=(), 72 | app_key=APP_KEY): 73 | 74 | if pkg_path is not None and os.path.isdir(pkg_path): 75 | paths = [pkg_path] 76 | else: 77 | paths = [os.path.join(get_root_path(app.name), 'templates')] 78 | 79 | self.context_processors = context_processors 80 | 81 | if context_processors: 82 | app[APP_CONTEXT_PROCESSORS_KEY] = context_processors 83 | app.middlewares.append(context_processors_middleware) 84 | 85 | kw = { 86 | 'input_encoding': app.config.get('MAKO_INPUT_ENCODING', 'utf-8'), 87 | 'module_directory': app.config.get('MAKO_MODULE_DIRECTORY', None), 88 | 'collection_size': app.config.get('MAKO_COLLECTION_SIZE', -1), 89 | 'imports': app.config.get('MAKO_IMPORTS', []), 90 | 'filesystem_checks': app.config.get('MAKO_FILESYSTEM_CHECKS', True), 91 | 'default_filters': app.config.get('MAKO_DEFAULT_FILTERS', ['str', 'h']), # noqa 92 | 'preprocessor': app.config.get('MAKO_PREPROCESSOR', None), 93 | 'strict_undefined': app.config.get('MAKO_STRICT_UNDEFINED', False), 94 | } 95 | 96 | setattr(app.ctx, app_key, TemplateLookup(directories=paths, **kw)) 97 | 98 | return getattr(app.ctx, app_key) 99 | 100 | @staticmethod 101 | def template(template_name, app_key=APP_KEY, status=200): 102 | def wrapper(func): 103 | @functools.wraps(func) 104 | async def wrapped(*args, **kwargs): 105 | if asyncio.iscoroutinefunction(func): 106 | coro = func 107 | else: 108 | coro = asyncio.coroutine(func) 109 | context = await coro(*args, **kwargs) 110 | request = args[-1] 111 | response = await render_template(template_name, request, context, 112 | app_key=app_key) 113 | response.status = status 114 | return response 115 | return wrapped 116 | return wrapper 117 | 118 | 119 | def get_lookup(app, app_key=APP_KEY): 120 | return getattr(app.ctx, app_key) 121 | 122 | 123 | async def render_string(template_name, request, context, *, app_key=APP_KEY): 124 | lookup = get_lookup(request.app, app_key) 125 | 126 | if lookup is None: 127 | raise TemplateError(ServerError( 128 | f"Template engine is not initialized, " 129 | "call sanic_mako.init_app first", status_code=500)) 130 | try: 131 | template = lookup.get_template(template_name) 132 | except TemplateLookupException as e: 133 | raise TemplateError(ServerError(f"Template '{template_name}' not found", 134 | status_code=500)) from e 135 | if not isinstance(context, Mapping): 136 | raise TemplateError(ServerError( 137 | "context should be mapping, not {type(context)}", status_code=500)) 138 | if request.ctx.__dict__.get(REQUEST_CONTEXT_KEY): 139 | context = dict(request[REQUEST_CONTEXT_KEY], **context) 140 | try: 141 | text = template.render(request=request, app=request.app, **context) 142 | except Exception: 143 | translate = request.app.config.get("MAKO_TRANSLATE_EXCEPTIONS", False) 144 | if translate: 145 | template.uri = template_name 146 | raise TemplateError(template) 147 | else: 148 | raise 149 | 150 | return text 151 | 152 | 153 | async def render_template_def(template_name, def_name, request, context, *, 154 | app_key=APP_KEY): 155 | lookup = get_lookup(request.app, app_key) 156 | 157 | if lookup is None: 158 | raise TemplateError(ServerError( 159 | f"Template engine is not initialized, " 160 | "call sanic_mako.init_app first", status_code=500)) 161 | try: 162 | template = lookup.get_template(template_name) 163 | except TemplateLookupException as e: 164 | raise TemplateError(ServerError(f"Template '{template_name}' not found", 165 | status_code=500)) from e 166 | if not isinstance(context, Mapping): 167 | raise TemplateError(ServerError( 168 | "context should be mapping, not {type(context)}", status_code=500)) 169 | if request.ctx.__dict__.get(REQUEST_CONTEXT_KEY): 170 | context = dict(request[REQUEST_CONTEXT_KEY], **context) 171 | try: 172 | text = template.get_def(def_name).render(app=request.app, **context) 173 | except Exception: 174 | translate = request.app.config.get("MAKO_TRANSLATE_EXCEPTIONS", True) 175 | if translate: 176 | template.uri = template_name 177 | raise TemplateError(template) 178 | else: 179 | raise 180 | 181 | return text 182 | 183 | 184 | async def render_template(template_name, request, context, *, 185 | content_type=None, app_key=APP_KEY): 186 | text = await render_string(template_name, request, context, app_key=app_key) 187 | if content_type is None: 188 | content_type = 'text/html' 189 | return HTTPResponse(text, content_type=content_type) 190 | 191 | 192 | async def context_processors_middleware(app, handler): 193 | async def middleware(request): 194 | request[REQUEST_CONTEXT_KEY] = {} 195 | for processor in app[APP_CONTEXT_PROCESSORS_KEY]: 196 | request[REQUEST_CONTEXT_KEY].update( 197 | (await processor(request))) 198 | return (await handler(request)) 199 | return middleware 200 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------