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.context_processor
def custom_context():
return { 'VAR': 'VALUE' }
# Register a function into global context
@jinja2.register
def sum(a, b):
return a + b
# Register a function with a different name
@jinja2.register('div')
def mod(a, b):
return a // b
# Register a filter
@jinja2.filter
def test(value, a, b=None):
return a if value else b
# Register a filter with a different name
@jinja2.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.
Project details
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
Hashes for muffin_jinja2-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d023d090ab2cb1d8512e6a7cd241d03c3e53a463659b44cae617bd40de53abf2 |
|
MD5 | 19cabfb3279db89f41348cc1cbd8beed |
|
BLAKE2b-256 | afa20cc0641d914033c138a6366d892b5829e20906b015a716618e688815c040 |