A page about Jingo.

Jingo is an adapter for using Jinja2 templates within Django. Why are we already replacing the templates? AMO's current PHP templates let you go hog-wild with logic in the templates, while Django is extremely restrictive. Jinja loosens those restrictions somewhat, providing a more powerful engine with the beauty of Django's templates. The tipping point for me was the verbosity of doing L10n in Django templates.

Settings

If you want to configure the Jinja environment, use JINJA_CONFIG in settings.py. It can be a dict or a function that returns a dict. :

JINJA_CONFIG = {'autoescape': False}

or :

def JINJA_CONFIG():
    return {'the_answer': 41 + 1}

Rendering

At this point, Jingo only provides two shortcuts for rendering templates.

jingo.render

The basic usage is to pass an HttpRequest and a template name. All the processors in settings.CONTEXT_PROCESSORS will be applied to the context, just like when you use a RequestContext in Django. Any extra keyword arguments are passed directly to http.HttpResponse.

jingo.views.direct_to_template

Template Helpers

Instead of template tags, Jinja encourages you to add functions and filters to the templating environment. In jingo, we call these helpers. When the Jinja environment is initialized, jingo will try to open a helpers.py file from every app in INSTALLED_APPS. Two decorators are provided to ease the environment extension:

jingo.register.filter

Adds the decorated function to Jinja's filter library.

jingo.register.function

Adds the decorated function to Jinja's global namespace.

Default Helpers

Helpers are available in all templates automatically, without any extra loading.

jingo.helpers

Template Environment

A single Jinja Environment is created for use in all templates. This is available as jingo.env if you need to work with the Environment.

Localization

Since we all love L10n, let's see what it looks like in Jinja templates:

<h2>{{ _('Reviews for {0}')|f(addon.name) }}</h2>

The simple way is to use the familiar underscore and string within a {{ }} moustache block. f is an interpolation filter documented below. Sphinx could create a link if I knew how to do that.

The other method uses Jinja's trans tag:

{% trans user=review.user|user_link, date=review.created|datetime %}
  by {{ user }} on {{ date }}
{% endtrans %}

trans is nice when you have a lot of text or want to inject some variables directly. Both methods are useful, pick the one that makes you happy.

2.9 KiB Raw Blame History