Skip to main content

Support Jinja2 templates for Muffin Framework

Project description

Muffin-Jinja2 – Support Jinja2 templates for Muffin Framework

Tests Status PYPI Version

Requirements

  • python >= 3.9

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

muffin_jinja2-1.8.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

muffin_jinja2-1.8.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file muffin_jinja2-1.8.1.tar.gz.

File metadata

  • Download URL: muffin_jinja2-1.8.1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure

File hashes

Hashes for muffin_jinja2-1.8.1.tar.gz
Algorithm Hash digest
SHA256 20dd5c7842aed4c796f061aacfd826fce0b07598a47e5e9ca1cca6c95d208083
MD5 9271b81ada8eed99a9aae62e32ef7b66
BLAKE2b-256 500346606703d026578df334106f72ea5cc32f4bc0244bfa150f783f1d9ea1fd

See more details on using hashes here.

File details

Details for the file muffin_jinja2-1.8.1-py3-none-any.whl.

File metadata

  • Download URL: muffin_jinja2-1.8.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure

File hashes

Hashes for muffin_jinja2-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e2fab285c414c303af18527931f85051e95e6ad91006c1b4bb8a25cfccd5e99
MD5 b920da4d8c74b344e034a3d225b2f2db
BLAKE2b-256 409636ae1f0ad5527f30856a8d177e29116ba1a214330e860b3cfd6c126f59da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page