Skip to content
This repository

An adapter for using Jinja2 templates with Django.

tag: v0.6.1

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 docs
Octocat-spinner-32 examples Tests run at all on Django 1.5. November 30, 2012
Octocat-spinner-32 jingo
Octocat-spinner-32 .gitignore Ignore more. November 13, 2012
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 CHANGELOG
Octocat-spinner-32 LICENSE
Octocat-spinner-32 MANIFEST.in Add Changelog. November 13, 2012
Octocat-spinner-32 README.rst
Octocat-spinner-32 fabfile.py
Octocat-spinner-32 fake_settings.py Tests run at all on Django 1.5. November 30, 2012
Octocat-spinner-32 requirements.txt
Octocat-spinner-32 setup.py
README.rst

Jingo

System Message: ERROR/3 (<string>, line 2)

Unknown directive type "module".

.. module:: jingo

Jingo is an adapter for using Jinja2 templates within Django.

Note

Coffin or Jingo?

Jingo differs from Coffin in two major ways:

  • Jingo serves purely as a minimalistic bridge between Django and Jinja2. Coffin attempts to reduce the differences between Jinja2 templates and Django's native templates.
  • Jingo has a far supperior name, as it is a portmanteau of 'Jinja' and Django.

Usage

When configured properly (see Settings below) you can render Jinja2 templates in your view the same way you'd render Django templates:

from django.shortcuts import render


def MyView(request):
    # TODO: Do something.
    context = dict(user_ids=[1, 2, 3, 4])
    render('users/search.html', context)

..note:

Not only does ``django.shorcuts.render`` work, but so does any method that
Django provides to render templates.

Settings

You'll want to use Django to use jingo's template loader. In settings.py:

TEMPLATE_LOADERS = (
    'jingo.Loader',
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
)

This will let you use django.shortcuts.render or django.shortcuts.render_to_response.

You can optionally specify which filename patterns to consider Jinja2 templates:

JINGO_INCLUDE_PATTERN = r'\.jinja2'  # use any regular expression here

This will consider every template file that contains the substring .jinja2 to be a Jinja2 file (unless it's in a module explicitly excluded, see below).

And finally you may have apps that do not use Jinja2, these must be excluded from the loader:

JINGO_EXCLUDE_APPS = ('debug_toolbar',)

If a template path begins with debug_toolbar, the Jinja loader will raise a TemplateDoesNotExist exception. This causes Django to move onto the next loader in TEMPLATE_LOADERS to find a template - in this case, django.template.loaders.filesystem.Loader.

Note

Technically, we're looking at the template path, not the app. Often these are the same, but in some cases, like 'registration' in the default setting--which is an admin template--they are not.

The default is in jingo.EXCLUDE_APPS:

EXCLUDE_APPS = (
    'admin',
    'admindocs',
    'registration'
)

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}

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:

System Message: ERROR/3 (<string>, line 113)

Unknown directive type "function".

.. function:: jingo.register.filter

    Adds the decorated function to Jinja's filter library.

System Message: ERROR/3 (<string>, line 117)

Unknown directive type "function".

.. function:: jingo.register.function

    Adds the decorated function to Jinja's global namespace.


System Message: ERROR/3 (<string>, line 122)

Unknown directive type "highlight".

.. highlight:: jinja

Default Helpers

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

System Message: ERROR/3 (<string>, line 130)

Unknown directive type "automodule".

.. automodule:: jingo.helpers
    :members:


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.

Forms

Django marks its form HTML "safe" according to its own rules, which Jinja2 does not recognize.

System Message: ERROR/3 (<string>, line 168)

Unknown directive type "automodule".

.. automodule:: jingo.monkey


Testing

Testing is handle via fabric:

fab test
Something went wrong with that request. Please try again.