D J A N G O F I LT E R S
truncatewords_html
{{ value|truncatewords_html:2 }}
Similar to truncatewords , except that it is aware of
HTML tags like truncatechars_html .
unordered_list {{ value|unordered_list }}
Recursively takes a self-nested list and returns an
HTML unordered list – WITHOUT opening and closing
<ul> tags.
upper {{ value|upper }}
Uppercases the given value. "chunky bacon"
becomes "CHUNKY BACON" .
urlencode {{ value|urlencode }}
Escapes a value for use in a URL. If value is
"https://www.example.org/foo?a=b&c=d", the
output will be "https%3A//www.example.org/
foo%3Fa%3Db%26c%3Dd".
urlize {{ value|urlize }}
Converts URLs and email addresses in text into
clickable links. Apply this filter only to plain text.
If value is "Check out sixfeetup.com" , the output
will be "Check out <a href="http://sixfeetup.
com"rel="nofollow">sixfeetup.com</a>".
urlizetrunc {{ value|urlizetrunc:15 }}
Combines urlize and truncatechars . If value is
"Click www.djangoproject.com", the output would
be 'Click <a href="http://www.djangoproject.
com"rel="nofollow">www.djangopr...</a>'.
wordwrap {{ value|wordwrap:5 }}
Wraps words at specified line length. If value is Joel
is a slug , the output would be: Joel
is a
slug
yesno {{ value|yesno:"yeah,no,maybe" }}
Maps values for True, False, and (optionally) None,
to the strings "yes" , "no" , "maybe", or a custom
mapping passed as a comma-separated list. If value
is True, the output would be yeah. If value is None,
the output would be maybe .
This publication is licensed under a Creative Commons
are you ready to bring in
PLAYER 2?
Six Feet Up is a software company focused on
helping tech teams regain momentum. We help
develop custom Python apps using Django,
Pyramid and Plone. We help deploy apps on a
variety of private and public clouds, such as AWS.
Companies like NASA and UCLA have sought out
our passion for quality since 1999. We are proud to
be a certified woman-owned business (WBE).
More info at:
S I X F E E T U P.C O M
Attribution-ShareAlike 3. 0 United States License.
St r at e g y Guide
C O M M O N B U I LT- I N F I LT E R
REFERENCE
add {{ value|add:"2" }}
Adds the argument to the value. If value is 4, then the
output will be 6. Strings that can be coerced to integers
will be summed, not concatenated.
capfirst {{ value|capfirst }}
Capitalizes the first character of the value. If the first
character is not a letter, this filter has no effect. If
value is "django", the output will be "django".
cut {{ value|cut:" " }}
Removes all values of arg from the given string.
If value is "So cool", the output will be "Socool".
date {{ value|date }}
or {{ value|date:"D d M Y" }}
Formats a date according to the given format for the
current locale. When used without a format string, the
DATE_FORMAT format specifier is used. Additionally you
can use the format specifiers "DATE_FORMAT" or "SHORT_
DATE_FORMAT" which will cause the format specification
in your settings. DATE_FORMAT or SHORT_DATE_FORMAT
to be used. You can also localize the behavior of this
filter by setting USE_LI0N to True and LANUAGE_CODE to
a default locale. You can combine date with the time
filter to render a full representation of adatetime value.
{{ value|date:"D d M Y" }}{{ value|time:"H:i" }}
default {{ value|default:"default text" }}
If value evaluates to False, uses the given default.
Otherwise, uses the value . If value is "", the output
will be default text.
dictsort {{ value|dictsort:"name" }}
Takes a list of dictionaries and returns that list sorted by
the key given in the argument.
If value is:[ {'name': 'zed', 'age': 19}, {'name':
'amy', 'age': 22}, {'name': 'joe', 'age': 31}, ]
then the output would be: [ {'name': 'amy', 'age':
22}, {'name': 'joe', 'age': 31}, {'name': 'zed',
'age': 19},]
S I X F E E T U P.C O M
divisibleby {{ value|divisibleby:"3" }}
Returns True if the value is divisible by the argument.
If value is 21, the output would be True .
escape {{ value|escape }}
Escapes a string’s HTML . Specifically, it makes these
replacements:
< is converted to &lt;, > is converted to
&gt; , 'single quote) is converted to &#39; ,"
(double quote) is converted to &quot; , and & is
converted to &amp;
Applying escape to a variable that would normally have
auto-escaping applied to the result will only result in
one round of escaping being done. If you want multiple
escaping passes to be applied, use the
force_escape filter.
filesizeformat {{ value|filesizeformat }}
Formats the value like a ‘human-readable’ file size.
If value is 123456789, the output would be 117.7 MB.
first {{ value|first }}
Returns the first item in a list.
floatformat {{ value|floatformat }}
When used without an argument, rounds a floating-
point number to one decimal place. If used with a
numeric integer argument, rounds a number to that
many decimal places. Passing0(zero) will round the
float to the nearest integer. If value is 34.26234 for
{{ value|floatformat }} the output will be 34.3 . If
value is 34.23234 for {{ value|floatformat:"0" }} the
output will be 34.
iriencode {{ value|iriencode }}
Converts an IRI(Internationalized Resource
Identifier) to a string that is suitable for including in
a URL . If value is "?test=1&me=2", the output will
be"?test=1&amp;me=2" .
join {{ value|join:" / " }}
Joins a list with a string, like Python’s str. join(list)
If value is the list ['a','b','c'] , the output will be the
string "a / b / c" .
last {{ value|last }}
Returns the last item in a list. Given ['a','b','c'], the
output will be "c".
length {{ value|length }}
Returns the length of the value. This works for both
strings and lists.
linebreaks {{ value|linebreaks }}
Replaces line breaks in plain text with appropriate HTML;
a single newline becomes an HTML line break
(<br /) and a new line followed by a blank line becomes
a paragraph break ( </p> ). If value is Joel\nis a slug ,
the output will be <p>Joel<br />is a slug</p> .
linebreaksbr {{ value|linebreaksbr }}
Converts all newlines in a piece of plain text to HTML line
breaks ( <br /> ).
lower {{ value|lower }}
Converts a string into all lowercase.
pluralize {{ num_messages|pluralize}}
Returns a plural suffix if the value is not 1 . By default,
this suffix is ‘s’ . If num_messages is 1, the output
will beYou have 1 message. If num_messages is 2
the output will be You have 2 messages. For words
that require a suffix other than ‘s’, you can provide an
alternate suffix as a parameter to the filter. You have {{
num_buses }} bus{{ num_buses|pluralize:"es" }} .
pprint pprint. pprint()
A wrapper around pprint. pprint()– for debugging.
random {{ value|random }}
Returns a random item from the given list. If value is
the list ['a', 'b', 'c', 'd'], the output could be "b" .
safe {{ var|safe }}
Marks a string as not requiring further HTML escaping
prior to output. When auto escaping is off, this filter
has no effect. If you are chaining filters, a filter applied
after safe can make the contents unsafe again. The
following code prints the variable as is, unescaped: {{
var|safe|escape }}
slice {{ some_list|slice:":2" }}
Returns a slice of the list. Uses the same syntax as
Python’s list slicing. If some_list is ['a', 'b', 'c'] , the
output will be ['a', 'b'].
slugify {{ value|slugify }}
Converts to ASCII . Converts spaces to hyphens.
Removes characters that aren’t alphanumerics,
underscores, or hyphens. Converts to lowercase. Also
strips leading and trailing whitespace. If value is "Joel is
a slug" , the output will be "joel-is-a-slug".
stringformat {{ value|stringformat:"E" }}
Formats the variable according to the argument
using printf-style String Formatting syntax, with
the exception that the leading "%" is dropped. In
the example above, if value is 10, the output will be
1.000000E+01 .
striptags {{ value|striptags }}
Makes all possible efforts to strip all [X]HTML tags.
striptags doesn't give any guarantee about its
output being HTML safe so NEVER apply the safe filter
to a striptags output. For something more robust,
use the clean method of the bleach Python library.
time {{ value|time }}
Formats a time according to the given format. When
used without a format string, the TIME_FORMAT format
specifier is used. {{ value|time:"TIME_FORMAT" }}{{
value|time:"H:i" }}
timesince
{{ blog_date|timesince:comment_date }}
timeuntil {{ conference_
date|timeuntil:from_date }}
Formats a date as the time since an optional
second date without which the comparison point
is now. If blog_date is a date instance representing
midnight on 1 June 2006 , and comment_date is a
date instance for 08:00 on 1 June 2006 , then the
following would return "8 hours". timeuntil works
similarly totimesince except that it measures the
time from now until the given date or datetime .
title {{ value|title }}
Converts a string into titlecase. If value is "my FIRST
post", the output will be "My First Post" .
truncatechars {{ value|truncatechars:3 }}
Truncates a string at the specified number of
characters.
truncatechars_html
{{ value|truncatechars_html:9 }}
Similar to truncatechars, except that it is aware of
HTML tags. If value is "<p>Joel is a slug</p>" , the
output will be "<p>Joeli...</p>" .
truncatewords {{ value|truncatewords:2 }}
Truncates a string after a certain number of words.

S I X F E E T U P.C O M A R E Y O U R E A DY T O B RI N G I N P L AY E R 2
Using the Poll model from the canonical
Django tutorials, you might want to put
something into your templates that looks
simply like:
{% show_choices_for_poll mypoll %}
To pull this off you’ll need a template for your
tag, like poll_choices.html:
<ul>
{% for choice in poll.choices %}
<li>{{ choice }}</li>
{% endfor %}
</ul>
and the tag to pass poll to the template:
@register.inclusion_tag(‘poll_choices.html’)
def show_choices_for_poll(poll):
return {‘poll’: poll}
The decorator does all of the heavy lifting
passing your returned dictionary as a context
to poll_choices.html template and returning
the rendered content back to your original
template.
As powerful as this is, you may find it doesn’t
cover your particular use case. If that’s the
case, Django gives you all of the tools might
need to build a tag from the ground up.
If you find yourself in this situation, head
on over to https://docs.djangoproject.
com/en/2.0/howto/custom-template-
tags/#advanced-custom-template-tags
are you ready to bring in
PLAYER 2?
Six Feet Up is a software company focused on
helping tech teams regain momentum. We help
develop custom Python apps using Django,
Pyramid and Plone. We help deploy apps on a
variety of private and public clouds, such as AWS.
Companies like NASA and UCLA have sought out
our passion for quality since 1999. We are proud to
be a certified woman-owned business (WBE).
More info at:
S I X F E E T U P.C O M
This publication is licensed under a Creative Commons
Attribution-ShareAlike 3.0 United States License.
MAKING CUSTOM
D J A N G O T E M P L AT E TA G S
St r at e g y Guide
Django’s templates are already pretty
powerful using just their built in capabilities,
but there is more you can do to increase
code re-use and keep your templates DRY.
The simplest is just a direct placeholder that
will return arbitrary text to be inserted at the
point of the tag.
Start by creating a templatetags folder with
a blank __init__.py in your app. This is
where you will locate your tag library called,
perhaps, mylibrary.py
Create a simple greeter tag like so:
# myapp/templatetags/mylibrary.py
from django import template
import random
# gives you a registry with decorators to
make it easy!
register = template.Library()
@register.simple_tag
def greet():
greeting = random.choice([‘Hello’,
‘Yo’, ‘Hi’, ‘Hey’, ‘Oh Hai’, ])
return greeting
S I X F E E T U P.C O M
If you need access to data in the context, you Arguments can also be passed: So, all together, you could use these in a
have to tell the decorator: template like so:

@register.simple_tag(takes_context=True)
def greet_current_user(context):
return “Hai {}”.format(context.user.
first_name)
If you intend to include HTML in your output,
be sure to mark it as safe. The recommended
way is to use django.utils.html.format_
html which behaves just like str.format
but includes some safety nets specific to
including foreign HTML output:
from django.utils.html import format_html
@register.simple_tag
def indypy_meetup_html():
call_to_action = ‘Join us!’
format_string = ‘<a href=”https://
www.meetup.com/indypy/”>{}</a>’
return format_html(format_string,
call_to_action)
@register.simple_tag
def with_gusto(string): {% load mylibrary %}
return format_html(‘<b>{}!!!</b>’, string) <p>
{% if request.user.is_anonymous %}
{% greet %}
Another common type of tag is the {% else %}
Assignment Tag. These can add data the {% greet_current_user %}
template context for use by other tags but {% endif %}
generate no output. For example, you might </p>
want to retrieve a list of active users by name: <p>
{% indypy_meetup_html %}
{% with_gusto “IndyPy is a great python
@register.assignment_tag user group” %}
def get_active_users(): </p>
“”” return first name and last initial
for all active users. {% if request.user.is_authenticated %}
“”” {% get_active_users as all_users %}
return [ “{} {}.”.format(u.first_name, {% if all_users %}
u.last_name[0]) <p> Here are some people might
for u in User.objects. meet:
filter(active=True)] {{ all_users|join:”, “ }}
</p>
{% endif %}
Though you might normally do such things {% endif %}
in the view, it can some sometimes be more
convenient inside the template. To use this,
you need simply reference the tag and give it An even more powerful approach builds
name for the results, like so: upon the takes_context option, tag
arguments, and additional templates to
create inclusion tags. These tags display
{% get_active_users as all_users %} data in your template using another
template fed by data from your context!

S I X F E E T U P.C O M A R E Y O U R E A DY T O B RI N G I N P L AY E R 2