Suppress "None" output as string in Jinja2

Question

How do I persuade Jinja2 to not print "None" when the value is None?

I have a number of entries in a dictionary and I would like to output everything in a single loop instead of having special cases for different keywords. If I have a value of None (the NoneType not the string) then the string "None" is inserted into the template rendering results.

Trying to suppress it using
{{ value or '' }} works too well as it will replace the numeric value zero as well.

Do I need to filter the dictionary before passing it to Jinja2 for rendering?

Asked By: Spaceghost

||

Source

Answer 1

In new versions of Jinja2 (2.9+):

{{ value if value }}

In older versions of Jinja2 (prior to 2.9):

{{ value if value is not none }} works great.

if this raises an error about not having an else try using an else ..

{{ value if value is not none else '' }}

Answered By: Joran Beasley

Answer 2

Default filter:

{{ value|default("", True) }}

Answered By: solarc

Answer 3

Another option is to use the finalize hook on the environment:

>>> import jinja2
>>> e = jinja2.Environment()
>>> e.from_string("{{ this }} / {{ that }}").render(this=0, that=None)
u'0 / None'

but:

>>> def my_finalize(thing):
...     return thing if thing is not None else ''
...
>>> e = jinja2.Environment(finalize=my_finalize)
>>> e.from_string("{{ this }} / {{ that }}").render(this=0, that=None)
u'0 / '

Answered By: SingleNegationElimination

Answer 4

A custom filter can solve the problem. Declare it like this:

def filter_suppress_none(val):
    if not val is None:
        return val
    else:
        return ''

Install it like this:

templating_environment.filters['sn'] = filter_suppress_none

Use it like this:

{{value|sn}}

Answered By: AlexVhr

Answer 5

According to this post from the Pocco Mailing List: https://groups.google.com/d/msg/pocoo-libs/SQ9ubo_Kamw/TadIdab9eN8J

Armin Ronacher (creater of Jinja2/Flask, etc…) recommends the following “pythonic” snippet:

{{ variable or 0 }} {{ variable or '' }}

The notion here being that once again, explicit is preferable to implicit.

Edit: The selected answer is definitely the correct one. I haven’t really come across a situation where a template variable would be either a string or the numeric zero, so the above snippets might help reduce the code noise in the template.

Answered By: Brownbay

Suppress "None" output as string in Jinja2

Question:

Answers: