docs/templates.rst

   1 Template Designer Documentation
   2 ===============================
   3
   4 .. highlight:: html+jinja
   5
   6 This document describes the syntax and semantics of the template engine and
   7 will be most useful as reference to those creating Jinja templates.  As the
   8 template engine is very flexible the configuration from the application might
   9 be slightly different from here in terms of delimiters and behavior of
  10 undefined values.
  11
  12
  13 Synopsis
  14 --------
  15
  16 A template is simply a text file.  It can generate any text-based format
  17 (HTML, XML, CSV, LaTeX, etc.).  It doesn't have a specific extension,
  18 ``.html`` or ``.xml`` are just fine.
  19
  20 A template contains **variables** or **expressions**, which get replaced with
  21 values when the template is evaluated, and tags, which control the logic of
  22 the template.  The template syntax is heavily inspired by Django and Python.
  23
  24 Below is a minimal template that illustrates a few basics.  We will cover
  25 the details later in that document::
  26
  27     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
  28     <html lang="en">
  29     <head>
  30         <title>My Webpage</title>
  31     </head>
  32     <body>
  33         <ul id="navigation">
  34         {% for item in navigation %}
  35             <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
  36         {% endfor %}
  37         </ul>
  38
  39         <h1>My Webpage</h1>
  40         {{ a_variable }}
  41     </body>
  42     </html>
  43
  44 This covers the default settings.  The application developer might have
  45 changed the syntax from ``{% foo %}`` to ``<% foo %>`` or something similar.
  46
  47 There are two kinds of delimiters. ``{% ... %}`` and ``{{ ... }}``.  The first
  48 one is used to execute statements such as for-loops or assign values, the
  49 latter prints the result of the expression to the template.
  50
  51 .. _variables:
  52
  53 Variables
  54 ---------
  55
  56 The application passes variables to the templates you can mess around in the
  57 template.  Variables may have attributes or elements on them you can access
  58 too.  How a variable looks like, heavily depends on the application providing
  59 those.
  60
  61 You can use a dot (``.``) to access attributes of a variable, alternative the
  62 so-called "subscript" syntax (``[]``) can be used.  The following lines do
  63 the same::
  64
  65     {{ foo.bar }}
  66     {{ foo['bar'] }}
  67
  68 It's important to know that the curly braces are *not* part of the variable
  69 but the print statement.  If you access variables inside tags don't put the
  70 braces around.
  71
  72 If a variable or attribute does not exist you will get back an undefined
  73 value.  What you can do with that kind of value depends on the application
  74 configuration, the default behavior is that it evaluates to an empty string
  75 if printed and that you can iterate over it, but every other operation fails.
  76
  77 .. _notes-on-subscriptions:
  78
  79 .. admonition:: Implementation
  80
  81     For convenience sake ``foo.bar`` in Jinja2 does the following things on
  82     the Python layer:
  83
  84     -   check if there is an attribute called `bar` on `foo`.
  85     -   if there is not, check if there is an item ``'bar'`` in `foo`.
  86     -   if there is not, return an undefined object.
  87
  88     ``foo['bar']`` on the other hand works mostly the same with the a small
  89     difference in the order:
  90
  91     -   check if there is an item ``'bar'`` in `foo`.
  92     -   if there is not, check if there is an attribute called `bar` on `foo`.
  93     -   if there is not, return an undefined object.
  94
  95     This is important if an object has an item or attribute with the same
  96     name.  Additionally there is the :func:`attr` filter that just looks up
  97     attributes.
  98
  99 .. _filters:
 100
 101 Filters
 102 -------
 103
 104 Variables can be modified by **filters**.  Filters are separated from the
 105 variable by a pipe symbol (``|``) and may have optional arguments in
 106 parentheses.  Multiple filters can be chained.  The output of one filter is
 107 applied to the next.
 108
 109 ``{{ name|striptags|title }}`` for example will remove all HTML Tags from the
 110 `name` and title-cases it.  Filters that accept arguments have parentheses
 111 around the arguments, like a function call.  This example will join a list
 112 by commas:  ``{{ list|join(', ') }}``.
 113
 114 The :ref:`builtin-filters` below describes all the builtin filters.
 115
 116 .. _tests:
 117
 118 Tests
 119 -----
 120
 121 Beside filters there are also so called "tests" available.  Tests can be used
 122 to test a variable against a common expression.  To test a variable or
 123 expression you add `is` plus the name of the test after the variable.  For
 124 example to find out if a variable is defined you can do ``name is defined``
 125 which will then return true or false depending on if `name` is defined.
 126
 127 Tests can accept arguments too.  If the test only takes one argument you can
 128 leave out the parentheses to group them.  For example the following two
 129 expressions do the same::
 130
 131     {% if loop.index is divisibleby 3 %}
 132     {% if loop.index is divisibleby(3) %}
 133
 134 The :ref:`builtin-tests` below describes all the builtin tests.
 135
 136
 137 Comments
 138 --------
 139
 140 To comment-out part of a line in a template, use the comment syntax which is
 141 by default set to ``{# ... #}``.  This is useful to comment out parts of the
 142 template for debugging or to add information for other template designers or
 143 yourself::
 144
 145     {# note: disabled template because we no longer use this
 146         {% for user in users %}
 147             ...
 148         {% endfor %}
 149     #}
 150
 151
 152 Whitespace Control
 153 ------------------
 154
 155 In the default configuration whitespace is not further modified by the
 156 template engine, so each whitespace (spaces, tabs, newlines etc.) is returned
 157 unchanged.  If the application configures Jinja to `trim_blocks` the first
 158 newline after a a template tag is removed automatically (like in PHP).
 159
 160 But you can also strip whitespace in templates by hand.  If you put an minus
 161 sign (``-``) to the start or end of an block (for example a for tag), a
 162 comment or variable expression you can remove the whitespaces after or before
 163 that block::
 164
 165     {% for item in seq -%}
 166         {{ item }}
 167     {%- endfor %}
 168
 169 This will yield all elements without whitespace between them.  If `seq` was
 170 a list of numbers from ``1`` to ``9`` the output would be ``123456789``.
 171
 172 If :ref:`line-statements` are enabled they strip leading whitespace
 173 automatically up to the beginning of the line.
 174
 175 .. admonition:: Note
 176
 177     You must not use a whitespace between the tag and the minus sign.
 178
 179     **valid**::
 180
 181         {%- if foo -%}...{% endif %}
 182
 183     **invalid**::
 184
 185         {% - if foo - %}...{% endif %}
 186
 187
 188 Escaping
 189 --------
 190
 191 It is sometimes desirable or even necessary to have Jinja ignore parts it
 192 would otherwise handle as variables or blocks.  For example if the default
 193 syntax is used and you want to use ``{{`` as raw string in the template and
 194 not start a variable you have to use a trick.
 195
 196 The easiest way is to output the variable delimiter (``{{``) by using a
 197 variable expression::
 198
 199     {{ '{{' }}
 200
 201 For bigger sections it makes sense to mark a block `raw`.  For example to
 202 put Jinja syntax as example into a template you can use this snippet::
 203
 204     {% raw %}
 205         <ul>
 206         {% for item in seq %}
 207             <li>{{ item }}</li>
 208         {% endfor %}
 209         </ul>
 210     {% endraw %}
 211
 212
 213 .. _line-statements:
 214
 215 Line Statements
 216 ---------------
 217
 218 If line statements are enabled by the application it's possible to mark a
 219 line as a statement.  For example if the line statement prefix is configured
 220 to ``#`` the following two examples are equivalent::
 221
 222     <ul>
 223     # for item in seq
 224         <li>{{ item }}</li>
 225     # endfor
 226     </ul>
 227
 228     <ul>
 229     {% for item in seq %}
 230         <li>{{ item }}</li>
 231     {% endfor %}
 232     </ul>
 233
 234 The line statement prefix can appear anywhere on the line as long as no text
 235 precedes it.  For better readability statements that start a block (such as
 236 `for`, `if`, `elif` etc.) may end with a colon::
 237
 238     # for item in seq:
 239         ...
 240     # endfor
 241
 242
 243 .. admonition:: Note
 244
 245     Line statements can span multiple lines if there are open parentheses,
 246     braces or brackets::
 247
 248         <ul>
 249         # for href, caption in [('index.html', 'Index'),
 250                                 ('about.html', 'About')]:
 251             <li><a href="{{ href }}">{{ caption }}</a></li>
 252         # endfor
 253         </ul>
 254
 255 Since Jinja 2.2 line-based comments are available as well.  For example if
 256 the line-comment prefix is configured to be ``##`` everything from ``##`` to
 257 the end of the line is ignored (excluding the newline sign)::
 258
 259     # for item in seq:
 260         <li>{{ item }}</li>     ## this comment is ignored
 261     # endfor
 262
 263
 264 .. _template-inheritance:
 265
 266 Template Inheritance
 267 --------------------
 268
 269 The most powerful part of Jinja is template inheritance. Template inheritance
 270 allows you to build a base "skeleton" template that contains all the common
 271 elements of your site and defines **blocks** that child templates can override.
 272
 273 Sounds complicated but is very basic. It's easiest to understand it by starting
 274 with an example.
 275
 276
 277 Base Template
 278 ~~~~~~~~~~~~~
 279
 280 This template, which we'll call ``base.html``, defines a simple HTML skeleton
 281 document that you might use for a simple two-column page. It's the job of
 282 "child" templates to fill the empty blocks with content::
 283
 284     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
 285     <html lang="en">
 286     <html xmlns="http://www.w3.org/1999/xhtml">
 287     <head>
 288         {% block head %}
 289         <link rel="stylesheet" href="style.css" />
 290         <title>{% block title %}{% endblock %} - My Webpage</title>
 291         {% endblock %}
 292     </head>
 293     <body>
 294         <div id="content">{% block content %}{% endblock %}</div>
 295         <div id="footer">
 296             {% block footer %}
 297             &copy; Copyright 2008 by <a href="http://domain.invalid/">you</a>.
 298             {% endblock %}
 299         </div>
 300     </body>
 301
 302 In this example, the ``{% block %}`` tags define four blocks that child templates
 303 can fill in. All the `block` tag does is to tell the template engine that a
 304 child template may override those portions of the template.
 305
 306 Child Template
 307 ~~~~~~~~~~~~~~
 308
 309 A child template might look like this::
 310
 311     {% extends "base.html" %}
 312     {% block title %}Index{% endblock %}
 313     {% block head %}
 314         {{ super() }}
 315         <style type="text/css">
 316             .important { color: #336699; }
 317         </style>
 318     {% endblock %}
 319     {% block content %}
 320         <h1>Index</h1>
 321         <p class="important">
 322           Welcome on my awesome homepage.
 323         </p>
 324     {% endblock %}
 325
 326 The ``{% extends %}`` tag is the key here. It tells the template engine that
 327 this template "extends" another template.  When the template system evaluates
 328 this template, first it locates the parent.  The extends tag should be the
 329 first tag in the template.  Everything before it is printed out normally and
 330 may cause confusion.  For details about this behavior and how to take
 331 advantage of it, see :ref:`null-master-fallback`.
 332
 333 The filename of the template depends on the template loader.  For example the
 334 :class:`FileSystemLoader` allows you to access other templates by giving the
 335 filename.  You can access templates in subdirectories with an slash::
 336
 337     {% extends "layout/default.html" %}
 338
 339 But this behavior can depend on the application embedding Jinja.  Note that
 340 since the child template doesn't define the ``footer`` block, the value from
 341 the parent template is used instead.
 342
 343 You can't define multiple ``{% block %}`` tags with the same name in the
 344 same template.  This limitation exists because a block tag works in "both"
 345 directions.  That is, a block tag doesn't just provide a hole to fill - it
 346 also defines the content that fills the hole in the *parent*.  If there
 347 were two similarly-named ``{% block %}`` tags in a template, that template's
 348 parent wouldn't know which one of the blocks' content to use.
 349
 350 If you want to print a block multiple times you can however use the special
 351 `self` variable and call the block with that name::
 352
 353     <title>{% block title %}{% endblock %}</title>
 354     <h1>{{ self.title() }}</h1>
 355     {% block body %}{% endblock %}
 356
 357
 358 Super Blocks
 359 ~~~~~~~~~~~~
 360
 361 It's possible to render the contents of the parent block by calling `super`.
 362 This gives back the results of the parent block::
 363
 364     {% block sidebar %}
 365         <h3>Table Of Contents</h3>
 366         ...
 367         {{ super() }}
 368     {% endblock %}
 369
 370
 371 Named Block End-Tags
 372 ~~~~~~~~~~~~~~~~~~~~
 373
 374 Jinja2 allows you to put the name of the block after the end tag for better
 375 readability::
 376
 377     {% block sidebar %}
 378         {% block inner_sidebar %}
 379             ...
 380         {% endblock inner_sidebar %}
 381     {% endblock sidebar %}
 382
 383 However the name after the `endblock` word must match the block name.
 384
 385
 386 Block Nesting and Scope
 387 ~~~~~~~~~~~~~~~~~~~~~~~
 388
 389 Blocks can be nested for more complex layouts.  However per default blocks
 390 may not access variables from outer scopes::
 391
 392     {% for item in seq %}
 393         <li>{% block loop_item %}{{ item }}{% endblock %}</li>
 394     {% endfor %}
 395
 396 This example would output empty ``<li>`` items because `item` is unavailable
 397 inside the block.  The reason for this is that if the block is replaced by
 398 a child template a variable would appear that was not defined in the block or
 399 passed to the context.
 400
 401 Starting with Jinja 2.2 you can explicitly specify that variables are
 402 available in a block by setting the block to "scoped" by adding the `scoped`
 403 modifier to a block declaration::
 404
 405     {% for item in seq %}
 406         <li>{% block loop_item scoped %}{{ item }}{% endblock %}</li>
 407     {% endfor %}
 408
 409 When overriding a block the `scoped` modifier does not have to be provided.
 410
 411
 412 Template Objects
 413 ~~~~~~~~~~~~~~~~
 414
 415 .. versionchanged:: 2.4
 416
 417 If a template object was passed to the template context you can
 418 extend from that object as well.  Assuming the calling code passes
 419 a layout template as `layout_template` to the environment, this
 420 code works::
 421
 422     {% extends layout_template %}
 423
 424 Previously the `layout_template` variable had to be a string with
 425 the layout template's filename for this to work.
 426
 427
 428 HTML Escaping
 429 -------------
 430
 431 When generating HTML from templates, there's always a risk that a variable will
 432 include characters that affect the resulting HTML.  There are two approaches:
 433 manually escaping each variable or automatically escaping everything by default.
 434
 435 Jinja supports both, but what is used depends on the application configuration.
 436 The default configuaration is no automatic escaping for various reasons:
 437
 438 -   escaping everything except of safe values will also mean that Jinja is
 439     escaping variables known to not include HTML such as numbers which is
 440     a huge performance hit.
 441
 442 -   The information about the safety of a variable is very fragile.  It could
 443     happen that by coercing safe and unsafe values the return value is double
 444     escaped HTML.
 445
 446 Working with Manual Escaping
 447 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 448
 449 If manual escaping is enabled it's **your** responsibility to escape
 450 variables if needed.  What to escape?  If you have a variable that *may*
 451 include any of the following chars (``>``, ``<``, ``&``, or ``"``) you
 452 **have to** escape it unless the variable contains well-formed and trusted
 453 HTML.  Escaping works by piping the variable through the ``|e`` filter:
 454 ``{{ user.username|e }}``.
 455
 456 Working with Automatic Escaping
 457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 458
 459 When automatic escaping is enabled everything is escaped by default except
 460 for values explicitly marked as safe.  Those can either be marked by the
 461 application or in the template by using the `|safe` filter.  The main
 462 problem with this approach is that Python itself doesn't have the concept
 463 of tainted values so the information if a value is safe or unsafe can get
 464 lost.  If the information is lost escaping will take place which means that
 465 you could end up with double escaped contents.
 466
 467 Double escaping is easy to avoid however, just rely on the tools Jinja2
 468 provides and don't use builtin Python constructs such as the string modulo
 469 operator.
 470
 471 Functions returning template data (macros, `super`, `self.BLOCKNAME`) return
 472 safe markup always.
 473
 474 String literals in templates with automatic escaping are considered unsafe
 475 too.  The reason for this is that the safe string is an extension to Python
 476 and not every library will work properly with it.
 477
 478
 479 List of Control Structures
 480 --------------------------
 481
 482 A control structure refers to all those things that control the flow of a
 483 program - conditionals (i.e. if/elif/else), for-loops, as well as things like
 484 macros and blocks.  Control structures appear inside ``{% ... %}`` blocks
 485 in the default syntax.
 486
 487 For
 488 ~~~
 489
 490 Loop over each item in a sequence.  For example, to display a list of users
 491 provided in a variable called `users`::
 492
 493     <h1>Members</h1>
 494     <ul>
 495     {% for user in users %}
 496       <li>{{ user.username|e }}</li>
 497     {% endfor %}
 498     </ul>
 499
 500 As variables in templates retain their object properties, it is possible to
 501 iterate over containers like `dict`::
 502
 503     <dl>
 504     {% for key, value in my_dict.iteritems() %}
 505         <dt>{{ key|e }}</dt>
 506         <dd>{{ value|e }}</dd>
 507     {% endfor %}
 508     </dl>
 509
 510 Note however that dictionaries usually are unordered so you might want to
 511 either pass it as a sorted list to the template or use the `dictsort`
 512 filter.
 513
 514 Inside of a for-loop block you can access some special variables:
 515
 516 +-----------------------+---------------------------------------------------+
 517 | Variable              | Description                                       |
 518 +=======================+===================================================+
 519 | `loop.index`          | The current iteration of the loop. (1 indexed)    |
 520 +-----------------------+---------------------------------------------------+
 521 | `loop.index0`         | The current iteration of the loop. (0 indexed)    |
 522 +-----------------------+---------------------------------------------------+
 523 | `loop.revindex`       | The number of iterations from the end of the loop |
 524 |                       | (1 indexed)                                       |
 525 +-----------------------+---------------------------------------------------+
 526 | `loop.revindex0`      | The number of iterations from the end of the loop |
 527 |                       | (0 indexed)                                       |
 528 +-----------------------+---------------------------------------------------+
 529 | `loop.first`          | True if first iteration.                          |
 530 +-----------------------+---------------------------------------------------+
 531 | `loop.last`           | True if last iteration.                           |
 532 +-----------------------+---------------------------------------------------+
 533 | `loop.length`         | The number of items in the sequence.              |
 534 +-----------------------+---------------------------------------------------+
 535 | `loop.cycle`          | A helper function to cycle between a list of      |
 536 |                       | sequences.  See the explanation below.            |
 537 +-----------------------+---------------------------------------------------+
 538
 539 Within a for-loop, it's possible to cycle among a list of strings/variables
 540 each time through the loop by using the special `loop.cycle` helper::
 541
 542     {% for row in rows %}
 543         <li class="{{ loop.cycle('odd', 'even') }}">{{ row }}</li>
 544     {% endfor %}
 545
 546 Since Jinja 2.1 an extra `cycle` helper exists that allows loop-unbound
 547 cycling.  For more information have a look at the :ref:`builtin-globals`.
 548
 549 .. _loop-filtering:
 550
 551 Unlike in Python it's not possible to `break` or `continue` in a loop.  You
 552 can however filter the sequence during iteration which allows you to skip
 553 items.  The following example skips all the users which are hidden::
 554
 555     {% for user in users if not user.hidden %}
 556         <li>{{ user.username|e }}</li>
 557     {% endfor %}
 558
 559 The advantage is that the special `loop` variable will count correctly thus
 560 not counting the users not iterated over.
 561
 562 If no iteration took place because the sequence was empty or the filtering
 563 removed all the items from the sequence you can render a replacement block
 564 by using `else`::
 565
 566     <ul>
 567     {% for user in users %}
 568         <li>{{ user.username|e }}</li>
 569     {% else %}
 570         <li><em>no users found</em></li>
 571     {% endfor %}
 572     </ul>
 573
 574 It is also possible to use loops recursively.  This is useful if you are
 575 dealing with recursive data such as sitemaps.  To use loops recursively you
 576 basically have to add the `recursive` modifier to the loop definition and
 577 call the `loop` variable with the new iterable where you want to recurse.
 578
 579 The following example implements a sitemap with recursive loops::
 580
 581     <ul class="sitemap">
 582     {%- for item in sitemap recursive %}
 583         <li><a href="{{ item.href|e }}">{{ item.title }}</a>
 584         {%- if item.children -%}
 585             <ul class="submenu">{{ loop(item.children) }}</ul>
 586         {%- endif %}</li>
 587     {%- endfor %}
 588     </ul>
 589
 590
 591 If
 592 ~~
 593
 594 The `if` statement in Jinja is comparable with the if statements of Python.
 595 In the simplest form you can use it to test if a variable is defined, not
 596 empty or not false::
 597
 598     {% if users %}
 599     <ul>
 600     {% for user in users %}
 601         <li>{{ user.username|e }}</li>
 602     {% endfor %}
 603     </ul>
 604     {% endif %}
 605
 606 For multiple branches `elif` and `else` can be used like in Python.  You can
 607 use more complex :ref:`expressions` there too::
 608
 609     {% if kenny.sick %}
 610         Kenny is sick.
 611     {% elif kenny.dead %}
 612         You killed Kenny!  You bastard!!!
 613     {% else %}
 614         Kenny looks okay --- so far
 615     {% endif %}
 616
 617 If can also be used as :ref:`inline expression <if-expression>` and for
 618 :ref:`loop filtering <loop-filtering>`.
 619
 620
 621 Macros
 622 ~~~~~~
 623
 624 Macros are comparable with functions in regular programming languages.  They
 625 are useful to put often used idioms into reusable functions to not repeat
 626 yourself.
 627
 628 Here a small example of a macro that renders a form element::
 629
 630     {% macro input(name, value='', type='text', size=20) -%}
 631         <input type="{{ type }}" name="{{ name }}" value="{{
 632             value|e }}" size="{{ size }}">
 633     {%- endmacro %}
 634
 635 The macro can then be called like a function in the namespace::
 636
 637     <p>{{ input('username') }}</p>
 638     <p>{{ input('password', type='password') }}</p>
 639
 640 If the macro was defined in a different template you have to
 641 :ref:`import <import>` it first.
 642
 643 Inside macros you have access to three special variables:
 644
 645 `varargs`
 646     If more positional arguments are passed to the macro than accepted by the
 647     macro they end up in the special `varargs` variable as list of values.
 648
 649 `kwargs`
 650     Like `varargs` but for keyword arguments.  All unconsumed keyword
 651     arguments are stored in this special variable.
 652
 653 `caller`
 654     If the macro was called from a :ref:`call<call>` tag the caller is stored
 655     in this variable as macro which can be called.
 656
 657 Macros also expose some of their internal details.  The following attributes
 658 are available on a macro object:
 659
 660 `name`
 661     The name of the macro.  ``{{ input.name }}`` will print ``input``.
 662
 663 `arguments`
 664     A tuple of the names of arguments the macro accepts.
 665
 666 `defaults`
 667     A tuple of default values.
 668
 669 `catch_kwargs`
 670     This is `true` if the macro accepts extra keyword arguments (ie: accesses
 671     the special `kwargs` variable).
 672
 673 `catch_varargs`
 674     This is `true` if the macro accepts extra positional arguments (ie:
 675     accesses the special `varargs` variable).
 676
 677 `caller`
 678     This is `true` if the macro accesses the special `caller` variable and may
 679     be called from a :ref:`call<call>` tag.
 680
 681 If a macro name starts with an underscore it's not exported and can't
 682 be imported.
 683
 684
 685 .. _call:
 686
 687 Call
 688 ~~~~
 689
 690 In some cases it can be useful to pass a macro to another macro.  For this
 691 purpose you can use the special `call` block.  The following example shows
 692 a macro that takes advantage of the call functionality and how it can be
 693 used::
 694
 695     {% macro render_dialog(title, class='dialog') -%}
 696         <div class="{{ class }}">
 697             <h2>{{ title }}</h2>
 698             <div class="contents">
 699                 {{ caller() }}
 700             </div>
 701         </div>
 702     {%- endmacro %}
 703
 704     {% call render_dialog('Hello World') %}
 705         This is a simple dialog rendered by using a macro and
 706         a call block.
 707     {% endcall %}
 708
 709 It's also possible to pass arguments back to the call block.  This makes it
 710 useful as replacement for loops.  Generally speaking a call block works
 711 exactly like an macro, just that it doesn't have a name.
 712
 713 Here an example of how a call block can be used with arguments::
 714
 715     {% macro dump_users(users) -%}
 716         <ul>
 717         {%- for user in users %}
 718             <li><p>{{ user.username|e }}</p>{{ caller(user) }}</li>
 719         {%- endfor %}
 720         </ul>
 721     {%- endmacro %}
 722
 723     {% call(user) dump_users(list_of_user) %}
 724         <dl>
 725             <dl>Realname</dl>
 726             <dd>{{ user.realname|e }}</dd>
 727             <dl>Description</dl>
 728             <dd>{{ user.description }}</dd>
 729         </dl>
 730     {% endcall %}
 731
 732
 733 Filters
 734 ~~~~~~~
 735
 736 Filter sections allow you to apply regular Jinja2 filters on a block of
 737 template data.  Just wrap the code in the special `filter` section::
 738
 739     {% filter upper %}
 740         This text becomes uppercase
 741     {% endfilter %}
 742
 743
 744 Assignments
 745 ~~~~~~~~~~~
 746
 747 Inside code blocks you can also assign values to variables.  Assignments at
 748 top level (outside of blocks, macros or loops) are exported from the template
 749 like top level macros and can be imported by other templates.
 750
 751 Assignments use the `set` tag and can have multiple targets::
 752
 753     {% set navigation = [('index.html', 'Index'), ('about.html', 'About')] %}
 754     {% set key, value = call_something() %}
 755
 756
 757 Extends
 758 ~~~~~~~
 759
 760 The `extends` tag can be used to extend a template from another one.  You
 761 can have multiple of them in a file but only one of them may be executed
 762 at the time.  See the section about :ref:`template-inheritance` above.
 763
 764
 765 Block
 766 ~~~~~
 767
 768 Blocks are used for inheritance and act as placeholders and replacements
 769 at the same time.  They are documented in detail as part of the section
 770 about :ref:`template-inheritance`.
 771
 772
 773 Include
 774 ~~~~~~~
 775
 776 The `include` statement is useful to include a template and return the
 777 rendered contents of that file into the current namespace::
 778
 779     {% include 'header.html' %}
 780         Body
 781     {% include 'footer.html' %}
 782
 783 Included templates have access to the variables of the active context by
 784 default.  For more details about context behavior of imports and includes
 785 see :ref:`import-visibility`.
 786
 787 From Jinja 2.2 onwards you can mark an include with ``ignore missing`` in
 788 which case Jinja will ignore the statement if the template to be ignored
 789 does not exist.  When combined with ``with`` or ``without context`` it has
 790 to be placed *before* the context visibility statement.  Here some valid
 791 examples::
 792
 793     {% include "sidebar.html" ignore missing %}
 794     {% include "sidebar.html" ignore missing with context %}
 795     {% include "sidebar.html" ignore missing without context %}
 796
 797 .. versionadded:: 2.2
 798
 799 You can also provide a list of templates that are checked for existence
 800 before inclusion.  The first template that exists will be included.  If
 801 `ignore missing` is given, it will fall back to rendering nothing if
 802 none of the templates exist, otherwise it will raise an exception.
 803
 804 Example::
 805
 806     {% include ['page_detailed.html', 'page.html'] %}
 807     {% include ['special_sidebar.html', 'sidebar.html'] ignore missing %}
 808
 809 .. versionchanged:: 2.4
 810    If a template object was passed to the template context you can
 811    include that object using `include`.
 812
 813 .. _import:
 814
 815 Import
 816 ~~~~~~
 817
 818 Jinja2 supports putting often used code into macros.  These macros can go into
 819 different templates and get imported from there.  This works similar to the
 820 import statements in Python.  It's important to know that imports are cached
 821 and imported templates don't have access to the current template variables,
 822 just the globals by defualt.  For more details about context behavior of
 823 imports and includes see :ref:`import-visibility`.
 824
 825 There are two ways to import templates.  You can import the complete template
 826 into a variable or request specific macros / exported variables from it.
 827
 828 Imagine we have a helper module that renders forms (called `forms.html`)::
 829
 830     {% macro input(name, value='', type='text') -%}
 831         <input type="{{ type }}" value="{{ value|e }}" name="{{ name }}">
 832     {%- endmacro %}
 833
 834     {%- macro textarea(name, value='', rows=10, cols=40) -%}
 835         <textarea name="{{ name }}" rows="{{ rows }}" cols="{{ cols
 836             }}">{{ value|e }}</textarea>
 837     {%- endmacro %}
 838
 839 The easiest and most flexible is importing the whole module into a variable.
 840 That way you can access the attributes::
 841
 842     {% import 'forms.html' as forms %}
 843     <dl>
 844         <dt>Username</dt>
 845         <dd>{{ forms.input('username') }}</dd>
 846         <dt>Password</dt>
 847         <dd>{{ forms.input('password', type='password') }}</dd>
 848     </dl>
 849     <p>{{ forms.textarea('comment') }}</p>
 850
 851
 852 Alternatively you can import names from the template into the current
 853 namespace::
 854
 855     {% from 'forms.html' import input as input_field, textarea %}
 856     <dl>
 857         <dt>Username</dt>
 858         <dd>{{ input_field('username') }}</dd>
 859         <dt>Password</dt>
 860         <dd>{{ input_field('password', type='password') }}</dd>
 861     </dl>
 862     <p>{{ textarea('comment') }}</p>
 863
 864 Macros and variables starting with one ore more underscores are private and
 865 cannot be imported.
 866
 867 .. versionchanged:: 2.4
 868    If a template object was passed to the template context you can
 869    import from that object.
 870
 871
 872 .. _import-visibility:
 873
 874 Import Context Behavior
 875 -----------------------
 876
 877 Per default included templates are passed the current context and imported
 878 templates not.  The reason for this is that imports unlike includes are
 879 cached as imports are often used just as a module that holds macros.
 880
 881 This however can be changed of course explicitly.  By adding `with context`
 882 or `without context` to the import/include directive the current context
 883 can be passed to the template and caching is disabled automatically.
 884
 885 Here two examples::
 886
 887     {% from 'forms.html' import input with context %}
 888     {% include 'header.html' without context %}
 889
 890 .. admonition:: Note
 891
 892     In Jinja 2.0 the context that was passed to the included template
 893     did not include variables defined in the template.  As a matter of
 894     fact this did not work::
 895
 896         {% for box in boxes %}
 897             {% include "render_box.html" %}
 898         {% endfor %}
 899
 900     The included template ``render_box.html`` is *not* able to access
 901     `box` in Jinja 2.0. As of Jinja 2.1 ``render_box.html`` *is* able
 902     to do so.
 903
 904
 905 .. _expressions:
 906
 907 Expressions
 908 -----------
 909
 910 Jinja allows basic expressions everywhere.  These work very similar to regular
 911 Python and even if you're not working with Python you should feel comfortable
 912 with it.
 913
 914 Literals
 915 ~~~~~~~~
 916
 917 The simplest form of expressions are literals.  Literals are representations
 918 for Python objects such as strings and numbers.  The following literals exist:
 919
 920 "Hello World":
 921     Everything between two double or single quotes is a string.  They are
 922     useful whenever you need a string in the template (for example as
 923     arguments to function calls, filters or just to extend or include a
 924     template).
 925
 926 42 / 42.23:
 927     Integers and floating point numbers are created by just writing the
 928     number down.  If a dot is present the number is a float, otherwise an
 929     integer.  Keep in mind that for Python ``42`` and ``42.0`` is something
 930     different.
 931
 932 ['list', 'of', 'objects']:
 933     Everything between two brackets is a list.  Lists are useful to store
 934     sequential data in or to iterate over them.  For example you can easily
 935     create a list of links using lists and tuples with a for loop::
 936
 937         <ul>
 938         {% for href, caption in [('index.html', 'Index'), ('about.html', 'About'),
 939                                  ('downloads.html', 'Downloads')] %}
 940             <li><a href="{{ href }}">{{ caption }}</a></li>
 941         {% endfor %}
 942         </ul>
 943
 944 ('tuple', 'of', 'values'):
 945     Tuples are like lists, just that you can't modify them.  If the tuple
 946     only has one item you have to end it with a comma.  Tuples are usually
 947     used to represent items of two or more elements.  See the example above
 948     for more details.
 949
 950 {'dict': 'of', 'key': 'and', 'value': 'pairs'}:
 951     A dict in Python is a structure that combines keys and values.  Keys must
 952     be unique and always have exactly one value.  Dicts are rarely used in
 953     templates, they are useful in some rare cases such as the :func:`xmlattr`
 954     filter.
 955
 956 true / false:
 957     true is always true and false is always false.
 958
 959 .. admonition:: Note
 960
 961     The special constants `true`, `false` and `none` are indeed lowercase.
 962     Because that caused confusion in the past, when writing `True` expands
 963     to an undefined variable that is considered false, all three of them can
 964     be written in title case too (`True`, `False`, and `None`).  However for
 965     consistency (all Jinja identifiers are lowercase) you should use the
 966     lowercase versions.
 967
 968 Math
 969 ~~~~
 970
 971 Jinja allows you to calculate with values.  This is rarely useful in templates
 972 but exists for completeness' sake.  The following operators are supported:
 973
 974 \+
 975     Adds two objects together.  Usually the objects are numbers but if both are
 976     strings or lists you can concatenate them this way.  This however is not
 977     the preferred way to concatenate strings!  For string concatenation have
 978     a look at the ``~`` operator.  ``{{ 1 + 1 }}`` is ``2``.
 979
 980 \-
 981     Substract the second number from the first one.  ``{{ 3 - 2 }}`` is ``1``.
 982
 983 /
 984     Divide two numbers.  The return value will be a floating point number.
 985     ``{{ 1 / 2 }}`` is ``{{ 0.5 }}``.
 986
 987 //
 988     Divide two numbers and return the truncated integer result.
 989     ``{{ 20 // 7 }}`` is ``2``.
 990
 991 %
 992     Calculate the remainder of an integer division.  ``{{ 11 % 7 }}`` is ``4``.
 993
 994 \*
 995     Multiply the left operand with the right one.  ``{{ 2 * 2 }}`` would
 996     return ``4``.  This can also be used to repeat a string multiple times.
 997     ``{{ '=' * 80 }}`` would print a bar of 80 equal signs.
 998
 999 \**
1000     Raise the left operand to the power of the right operand.  ``{{ 2**3 }}``
1001     would return ``8``.
1002
1003 Comparisons
1004 ~~~~~~~~~~~
1005
1006 ==
1007     Compares two objects for equality.
1008
1009 !=
1010     Compares two objects for inequality.
1011
1012 >
1013     `true` if the left hand side is greater than the right hand side.
1014
1015 >=
1016     `true` if the left hand side is greater or equal to the right hand side.
1017
1018 <
1019     `true` if the left hand side is lower than the right hand side.
1020
1021 <=
1022     `true` if the left hand side is lower or equal to the right hand side.
1023
1024 Logic
1025 ~~~~~
1026
1027 For `if` statements, `for` filtering or `if` expressions it can be useful to
1028 combine multiple expressions:
1029
1030 and
1031     Return true if the left and the right operand is true.
1032
1033 or
1034     Return true if the left or the right operand is true.
1035
1036 not
1037     negate a statement (see below).
1038
1039 (expr)
1040     group an expression.
1041
1042 .. admonition:: Note
1043
1044     The ``is`` and ``in`` operators support negation using an infix notation
1045     too: ``foo is not bar`` and ``foo not in bar`` instead of ``not foo is bar``
1046     and ``not foo in bar``.  All other expressions require a prefix notation:
1047     ``not (foo and bar).``
1048
1049
1050 Other Operators
1051 ~~~~~~~~~~~~~~~
1052
1053 The following operators are very useful but don't fit into any of the other
1054 two categories:
1055
1056 in
1057     Perform sequence / mapping containment test.  Returns true if the left
1058     operand is contained in the right.  ``{{ 1 in [1, 2, 3] }}`` would for
1059     example return true.
1060
1061 is
1062     Performs a :ref:`test <tests>`.
1063
1064 \|
1065     Applies a :ref:`filter <filters>`.
1066
1067 ~
1068     Converts all operands into strings and concatenates them.
1069     ``{{ "Hello " ~ name ~ "!" }}`` would return (assuming `name` is
1070     ``'John'``) ``Hello John!``.
1071
1072 ()
1073     Call a callable: ``{{ post.render() }}``.  Inside of the parentheses you
1074     can use positional arguments and keyword arguments like in python:
1075     ``{{ post.render(user, full=true) }}``.
1076
1077 . / []
1078     Get an attribute of an object.  (See :ref:`variables`)
1079
1080
1081 .. _if-expression:
1082
1083 If Expression
1084 ~~~~~~~~~~~~~
1085
1086 It is also possible to use inline `if` expressions.  These are useful in some
1087 situations.  For example you can use this to extend from one template if a
1088 variable is defined, otherwise from the default layout template::
1089
1090     {% extends layout_template if layout_template is defined else 'master.html' %}
1091
1092 The general syntax is ``<do something> if <something is true> else <do
1093 something else>``.
1094
1095 The `else` part is optional.  If not provided the else block implicitly
1096 evaluates into an undefined object::
1097
1098     {{ '[%s]' % page.title if page.title }}
1099
1100
1101 .. _builtin-filters:
1102
1103 List of Builtin Filters
1104 -----------------------
1105
1106 .. jinjafilters::
1107
1108
1109 .. _builtin-tests:
1110
1111 List of Builtin Tests
1112 ---------------------
1113
1114 .. jinjatests::
1115
1116 .. _builtin-globals:
1117
1118 List of Global Functions
1119 ------------------------
1120
1121 The following functions are available in the global scope by default:
1122
1123 .. function:: range([start,] stop[, step])
1124
1125     Return a list containing an arithmetic progression of integers.
1126     range(i, j) returns [i, i+1, i+2, ..., j-1]; start (!) defaults to 0.
1127     When step is given, it specifies the increment (or decrement).
1128     For example, range(4) returns [0, 1, 2, 3].  The end point is omitted!
1129     These are exactly the valid indices for a list of 4 elements.
1130
1131     This is useful to repeat a template block multiple times for example
1132     to fill a list.  Imagine you have 7 users in the list but you want to
1133     render three empty items to enforce a height with CSS::
1134
1135         <ul>
1136         {% for user in users %}
1137             <li>{{ user.username }}</li>
1138         {% endfor %}
1139         {% for number in range(10 - users|count) %}
1140             <li class="empty"><span>...</span></li>
1141         {% endfor %}
1142         </ul>
1143
1144 .. function:: lipsum(n=5, html=True, min=20, max=100)
1145
1146     Generates some lorem ipsum for the template.  Per default five paragraphs
1147     with HTML are generated each paragraph between 20 and 100 words.  If html
1148     is disabled regular text is returned.  This is useful to generate simple
1149     contents for layout testing.
1150
1151 .. function:: dict(\**items)
1152
1153     A convenient alternative to dict literals.  ``{'foo': 'bar'}`` is the same
1154     as ``dict(foo='bar')``.
1155
1156 .. class:: cycler(\*items)
1157
1158     The cycler allows you to cycle among values similar to how `loop.cycle`
1159     works.  Unlike `loop.cycle` however you can use this cycler outside of
1160     loops or over multiple loops.
1161
1162     This is for example very useful if you want to show a list of folders and
1163     files, with the folders on top, but both in the same list with alternating
1164     row colors.
1165
1166     The following example shows how `cycler` can be used::
1167
1168         {% set row_class = cycler('odd', 'even') %}
1169         <ul class="browser">
1170         {% for folder in folders %}
1171           <li class="folder {{ row_class.next() }}">{{ folder|e }}</li>
1172         {% endfor %}
1173         {% for filename in files %}
1174           <li class="file {{ row_class.next() }}">{{ filename|e }}</li>
1175         {% endfor %}
1176         </ul>
1177
1178     A cycler has the following attributes and methods:
1179
1180     .. method:: reset()
1181
1182         Resets the cycle to the first item.
1183
1184     .. method:: next()
1185
1186         Goes one item a head and returns the then current item.
1187
1188     .. attribute:: current
1189
1190         Returns the current item.
1191
1192     **new in Jinja 2.1**
1193
1194 .. class:: joiner(sep=', ')
1195
1196     A tiny helper that can be use to "join" multiple sections.  A joiner is
1197     passed a string and will return that string every time it's called, except
1198     the first time in which situation it returns an empty string.  You can
1199     use this to join things::
1200
1201         {% set pipe = joiner("|") %}
1202         {% if categories %} {{ pipe() }}
1203             Categories: {{ categories|join(", ") }}
1204         {% endif %}
1205         {% if author %} {{ pipe() }}
1206             Author: {{ author() }}
1207         {% endif %}
1208         {% if can_edit %} {{ pipe() }}
1209             <a href="?action=edit">Edit</a>
1210         {% endif %}
1211
1212     **new in Jinja 2.1**
1213
1214
1215 Extensions
1216 ----------
1217
1218 The following sections cover the built-in Jinja2 extensions that may be
1219 enabled by the application.  The application could also provide further
1220 extensions not covered by this documentation.  In that case there should
1221 be a separate document explaining the extensions.
1222
1223 .. _i18n-in-templates:
1224
1225 i18n
1226 ~~~~
1227
1228 If the i18n extension is enabled it's possible to mark parts in the template
1229 as translatable.  To mark a section as translatable you can use `trans`::
1230
1231     <p>{% trans %}Hello {{ user }}!{% endtrans %}</p>
1232
1233 To translate a template expression --- say, using template filters or just
1234 accessing an attribute of an object --- you need to bind the expression to a
1235 name for use within the translation block::
1236
1237     <p>{% trans user=user.username %}Hello {{ user }}!{% endtrans %}</p>
1238
1239 If you need to bind more than one expression inside a `trans` tag, separate
1240 the pieces with a comma (``,``)::
1241
1242     {% trans book_title=book.title, author=author.name %}
1243     This is {{ book_title }} by {{ author }}
1244     {% endtrans %}
1245
1246 Inside trans tags no statements are allowed, only variable tags are.
1247
1248 To pluralize, specify both the singular and plural forms with the `pluralize`
1249 tag, which appears between `trans` and `endtrans`::
1250
1251     {% trans count=list|length %}
1252     There is {{ count }} {{ name }} object.
1253     {% pluralize %}
1254     There are {{ count }} {{ name }} objects.
1255     {% endtrans %}
1256
1257 Per default the first variable in a block is used to determine the correct
1258 singular or plural form.  If that doesn't work out you can specify the name
1259 which should be used for pluralizing by adding it as parameter to `pluralize`::
1260
1261     {% trans ..., user_count=users|length %}...
1262     {% pluralize user_count %}...{% endtrans %}
1263
1264 It's also possible to translate strings in expressions.  For that purpose
1265 three functions exist:
1266
1267 _   `gettext`: translate a single string
1268 -   `ngettext`: translate a pluralizable string
1269 -   `_`: alias for `gettext`
1270
1271 For example you can print a translated string easily this way::
1272
1273     {{ _('Hello World!') }}
1274
1275 To use placeholders you can use the `format` filter::
1276
1277     {{ _('Hello %(user)s!')|format(user=user.username) }}
1278
1279 For multiple placeholders always use keyword arguments to `format` as other
1280 languages may not use the words in the same order.
1281
1282 .. versionchanged:: 2.5
1283
1284 If newstyle gettext calls are activated (:ref:`newstyle-gettext`), using
1285 placeholders is a lot easier:
1286
1287 .. sourcecode:: html+jinja
1288
1289     {{ gettext('Hello World!') }}
1290     {{ gettext('Hello %(name)s!', name='World') }}
1291     {{ ngettext('%(num)d apple', '%(num)d apples', apples|count) }}
1292
1293 Note that the `ngettext` function's format string automatically receives
1294 the count as `num` parameter additionally to the regular parameters.
1295
1296
1297 Expression Statement
1298 ~~~~~~~~~~~~~~~~~~~~
1299
1300 If the expression-statement extension is loaded a tag called `do` is available
1301 that works exactly like the regular variable expression (``{{ ... }}``) just
1302 that it doesn't print anything.  This can be used to modify lists::
1303
1304     {% do navigation.append('a string') %}
1305
1306
1307 Loop Controls
1308 ~~~~~~~~~~~~~
1309
1310 If the application enables the :ref:`loopcontrols-extension` it's possible to
1311 use `break` and `continue` in loops.  When `break` is reached, the loop is
1312 terminated;  if `continue` is reached, the processing is stopped and continues
1313 with the next iteration.
1314
1315 Here a loop that skips every second item::
1316
1317     {% for user in users %}
1318         {%- if loop.index is even %}{% continue %}{% endif %}
1319         ...
1320     {% endfor %}
1321
1322 Likewise a look that stops processing after the 10th iteration::
1323
1324     {% for user in users %}
1325         {%- if loop.index >= 10 %}{% break %}{% endif %}
1326     {%- endfor %}
1327
1328
1329 With Statement
1330 ~~~~~~~~~~~~~~
1331
1332 .. versionadded:: 2.3
1333
1334 If the application enables the :ref:`with-extension` it is possible to
1335 use the `with` keyword in templates.  This makes it possible to create
1336 a new inner scope.  Variables set within this scope are not visible
1337 outside of the scope.
1338
1339 With in a nutshell::
1340
1341     {% with %}
1342         {% set foo = 42 %}
1343         {{ foo }}           foo is 42 here
1344     {% endwith %}
1345     foo is not visible here any longer
1346
1347 Because it is common to set variables at the beginning of the scope
1348 you can do that within the with statement.  The following two examples
1349 are equivalent::
1350
1351     {% with foo = 42 %}
1352         {{ foo }}
1353     {% endwith %}
1354
1355     {% with %}
1356         {% set foo = 42 %}
1357         {{ foo }}
1358     {% endwith %}
1359
1360 .. _autoescape-overrides:
1361
1362 Autoescape Extension
1363 --------------------
1364
1365 .. versionadded:: 2.4
1366
1367 If the application enables the :ref:`autoescape-extension` one can
1368 activate and deactivate the autoescaping from within the templates.
1369
1370 Example::
1371
1372     {% autoescape true %}
1373         Autoescaping is active within this block
1374     {% endautoescape %}
1375
1376     {% autoescape false %}
1377         Autoescaping is inactive within this block
1378     {% endautoescape %}
1379
1380 After the `endautoescape` the behavior is reverted to what it was before.