Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 151 Commits
.github		.github
muffin_jinja2		muffin_jinja2
tests		tests
.git-commits.yaml		.git-commits.yaml
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.rst		README.rst
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml

Repository files navigation

Muffin-Jinja2

Muffin-Jinja2 -- Support Jinja2 templates forMuffin Framework

Contents

Requirements

python >= 3.9

Installation

Muffin-Jinja2 should be installed using pip:

pip install muffin-jinja2

Usage

importmuffinimportmuffin_jinja2# Create Muffin Applicationapp=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('/')asyncdefindex(request):context= {'var':42}returnawaitjinja2.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 insideMuffin.Application config using the jinja2_ prefix for example:

JINJA2_AUTO_RELOAD=TrueJINJA2_TEMPLATE_FOLDERS= ['tmpls']

Muffin.Application configuration options are case insensitive

Tunning

# Register custom context processor# could be a function/coroutine@jinja2.add_contextdefcustom_context():return {'VAR':'VALUE' }# Register a function into global context@jinja2.add_globaldefsum(a,b):returna+b# Register a function with a different name@jinja2.add_global('div')defmod(a,b):returna//b# Register a filter@jinja2.add_filterdeftest(value,a,b=None):returnaifvalueelseb# Register a filter with a different name@jinja2.add_filter('bool')defboolean(value):returnbool(value)@app.route('/')asyncdefindex(request):""" Check for user is admin. """local_context= {'key':'value'}returnawaitjinja2.render('index.html',**local_context)