Support Jinja2 templates for Muffin Framework
Project description
Muffin-Jinja2 – Support Jinja2 templates for Muffin Framework
Requirements
python >= 3.7
Installation
Muffin-Jinja2 should be installed using pip:
pip install muffin-jinja2
Usage
import muffin
import muffin_jinja2
# Create Muffin Application
app = muffin.Application('example')
# Initialize the plugin
# As alternative: jinja2 = Jinja2(app, **options)
jinja2 = muffin_jinja2.Plugin()
jinja2.setup(app, template_folders=['src/templates'])
# Use it inside your handlers
@app.route('/')
async def index(request):
context = {'var': 42}
return await jinja2.render('index.html', **context)Options
Name |
Default value |
Description |
auto_reload |
False |
Auto reload changed templates |
cache_size |
50 |
Cache templates |
extensions |
None |
Enable Jinja2 Extensions (None | list) |
loader |
FileSystemLoader |
Template loader |
encoding |
utf-8 |
Default encoding for file loader |
template_folders |
['templates'] |
List of template folders |
You are able to provide the options when you are initiliazing the plugin:
jinja2.init(app, template_folders=['src/templates'], auto_reload=True)Or setup it inside Muffin.Application config using the jinja2_ prefix for example:
JINJA2_AUTO_RELOAD = True
JINJA2_TEMPLATE_FOLDERS = ['tmpls']Muffin.Application configuration options are case insensitive
Tunning
# Register custom context processor
# could be a function/coroutine
@jinja2.add_context
def custom_context():
return { 'VAR': 'VALUE' }
# Register a function into global context
@jinja2.add_global
def sum(a, b):
return a + b
# Register a function with a different name
@jinja2.add_global('div')
def mod(a, b):
return a // b
# Register a filter
@jinja2.add_filter
def test(value, a, b=None):
return a if value else b
# Register a filter with a different name
@jinja2.add_filter('bool')
def boolean(value):
return bool(value)
@app.route('/')
async def index(request):
""" Check for user is admin. """
local_context = {'key': 'value'}
return await jinja2.render('index.html', **local_context)Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-jinja2/issues
Contributing
Development of Muffin-Jinja2 happens at: https://github.com/klen/muffin-jinja2
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file muffin-jinja2-1.6.3.tar.gz.
File metadata
- Download URL: muffin-jinja2-1.6.3.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 033917ac2f18b91924bec66fe83164a3f3023bae3e1e5d9929b9085815b7bef7 |
|
| MD5 | e36748cf5c1d76022595d8b69fdd65c6 |
|
| BLAKE2b-256 | 57bcbf93646091d74eced339e4c387b85fabac849d19f8f800c77581eb8cdb09 |
File details
Details for the file muffin_jinja2-1.6.3-py3-none-any.whl.
File metadata
- Download URL: muffin_jinja2-1.6.3-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 09461cf57d915126dc54e7f2e5f305d15606c59d361ccf54a815bdff23028f2d |
|
| MD5 | 74a8588219f75eb6ad3b47e64bf180c4 |
|
| BLAKE2b-256 | 41a95a206df2322e26542b4d48f7ec068942e843205e0155250bedfceb7a0640 |
