OpenQuizz
Une application de gestion des contenus pédagogiques
jinja2.filters Namespace Reference

Functions

def contextfilter (f)
 
def evalcontextfilter (f)
 
def environmentfilter (f)
 
def ignore_case (value)
 
def make_attrgetter (environment, attribute, postprocess=None, default=None)
 
def make_multi_attrgetter (environment, attribute, postprocess=None)
 
def do_forceescape (value)
 
def do_urlencode (value)
 
def do_replace (eval_ctx, s, old, new, count=None)
 
def do_upper (s)
 
def do_lower (s)
 
def do_xmlattr (_eval_ctx, d, autospace=True)
 
def do_capitalize (s)
 
def do_title (s)
 
def do_dictsort (value, case_sensitive=False, by="key", reverse=False)
 
def do_sort (environment, value, reverse=False, case_sensitive=False, attribute=None)
 
def do_unique (environment, value, case_sensitive=False, attribute=None)
 
def do_min (environment, value, case_sensitive=False, attribute=None)
 
def do_max (environment, value, case_sensitive=False, attribute=None)
 
def do_default (value, default_value=u"", boolean=False)
 
def do_join (eval_ctx, value, d=u"", attribute=None)
 
def do_center (value, width=80)
 
def do_first (environment, seq)
 
def do_last (environment, seq)
 
def do_random (context, seq)
 
def do_filesizeformat (value, binary=False)
 
def do_pprint (value, verbose=False)
 
def do_urlize (eval_ctx, value, trim_url_limit=None, nofollow=False, target=None, rel=None)
 
def do_indent (s, width=4, first=False, blank=False, indentfirst=None)
 
def do_truncate (env, s, length=255, killwords=False, end="...", leeway=None)
 
def do_wordwrap (environment, s, width=79, break_long_words=True, wrapstring=None, break_on_hyphens=True)
 
def do_wordcount (s)
 
def do_int (value, default=0, base=10)
 
def do_float (value, default=0.0)
 
def do_format (value, *args, **kwargs)
 
def do_trim (value, chars=None)
 
def do_striptags (value)
 
def do_slice (value, slices, fill_with=None)
 
def do_batch (value, linecount, fill_with=None)
 
def do_round (value, precision=0, method="common")
 
def do_groupby (environment, value, attribute)
 
def do_sum (environment, iterable, attribute=None, start=0)
 
def do_list (value)
 
def do_mark_safe (value)
 
def do_mark_unsafe (value)
 
def do_reverse (value)
 
def do_attr (environment, obj, name)
 
def do_map (*args, **kwargs)
 
def do_select (*args, **kwargs)
 
def do_reject (*args, **kwargs)
 
def do_selectattr (*args, **kwargs)
 
def do_rejectattr (*args, **kwargs)
 
def do_tojson (eval_ctx, value, indent=None)
 
def prepare_map (args, kwargs)
 
def prepare_select_or_reject (args, kwargs, modfunc, lookup_attr)
 
def select_or_reject (args, kwargs, modfunc, lookup_attr)
 

Variables

 FILTERS
 

Function Documentation

◆ contextfilter()

def jinja2.filters.contextfilter (   f)
Decorator for marking context dependent filters. The current
:class:`Context` will be passed as first argument.

◆ do_attr()

def jinja2.filters.do_attr (   environment,
  obj,
  name 
)
Get an attribute of an object.  ``foo|attr("bar")`` works like
``foo.bar`` just that always an attribute is returned and items are not
looked up.

See :ref:`Notes on subscriptions <notes-on-subscriptions>` for more details.

◆ do_batch()

def jinja2.filters.do_batch (   value,
  linecount,
  fill_with = None 
)
A filter that batches items. It works pretty much like `slice`
just the other way round. It returns a list of lists with the
given number of items. If you provide a second parameter this
is used to fill up missing items. See this example:

.. sourcecode:: html+jinja

    <table>
    {%- for row in items|batch(3, '&nbsp;') %}
      <tr>
      {%- for column in row %}
        <td>{{ column }}</td>
      {%- endfor %}
      </tr>
    {%- endfor %}
    </table>

◆ do_capitalize()

def jinja2.filters.do_capitalize (   s)
Capitalize a value. The first character will be uppercase, all others
lowercase.

◆ do_center()

def jinja2.filters.do_center (   value,
  width = 80 
)
Centers the value in a field of a given width.

◆ do_default()

def jinja2.filters.do_default (   value,
  default_value = u"",
  boolean = False 
)
If the value is undefined it will return the passed default value,
otherwise the value of the variable:

.. sourcecode:: jinja

    {{ my_variable|default('my_variable is not defined') }}

This will output the value of ``my_variable`` if the variable was
defined, otherwise ``'my_variable is not defined'``. If you want
to use default with variables that evaluate to false you have to
set the second parameter to `true`:

.. sourcecode:: jinja

    {{ ''|default('the string was empty', true) }}

.. versionchanged:: 2.11
   It's now possible to configure the :class:`~jinja2.Environment` with
   :class:`~jinja2.ChainableUndefined` to make the `default` filter work
   on nested elements and attributes that may contain undefined values
   in the chain without getting an :exc:`~jinja2.UndefinedError`.

◆ do_dictsort()

def jinja2.filters.do_dictsort (   value,
  case_sensitive = False,
  by = "key",
  reverse = False 
)
Sort a dict and yield (key, value) pairs. Because python dicts are
unsorted you may want to use this function to order them by either
key or value:

.. sourcecode:: jinja

    {% for key, value in mydict|dictsort %}
        sort the dict by key, case insensitive

    {% for key, value in mydict|dictsort(reverse=true) %}
        sort the dict by key, case insensitive, reverse order

    {% for key, value in mydict|dictsort(true) %}
        sort the dict by key, case sensitive

    {% for key, value in mydict|dictsort(false, 'value') %}
        sort the dict by value, case insensitive

◆ do_filesizeformat()

def jinja2.filters.do_filesizeformat (   value,
  binary = False 
)
Format the value like a 'human-readable' file size (i.e. 13 kB,
4.1 MB, 102 Bytes, etc).  Per default decimal prefixes are used (Mega,
Giga, etc.), if the second parameter is set to `True` the binary
prefixes are used (Mebi, Gibi).

◆ do_first()

def jinja2.filters.do_first (   environment,
  seq 
)
Return the first item of a sequence.

◆ do_float()

def jinja2.filters.do_float (   value,
  default = 0.0 
)
Convert the value into a floating point number. If the
conversion doesn't work it will return ``0.0``. You can
override this default using the first parameter.

◆ do_forceescape()

def jinja2.filters.do_forceescape (   value)
Enforce HTML escaping.  This will probably double escape variables.

◆ do_format()

def jinja2.filters.do_format (   value,
args,
**  kwargs 
)
Apply the given values to a `printf-style`_ format string, like
``string % values``.

.. sourcecode:: jinja

    {{ "%s, %s!"|format(greeting, name) }}
    Hello, World!

In most cases it should be more convenient and efficient to use the
``%`` operator or :meth:`str.format`.

.. code-block:: text

    {{ "%s, %s!" % (greeting, name) }}
    {{ "{}, {}!".format(greeting, name) }}

.. _printf-style: https://docs.python.org/library/stdtypes.html
    #printf-style-string-formatting

◆ do_groupby()

def jinja2.filters.do_groupby (   environment,
  value,
  attribute 
)
Group a sequence of objects by an attribute using Python's
:func:`itertools.groupby`. The attribute can use dot notation for
nested access, like ``"address.city"``. Unlike Python's ``groupby``,
the values are sorted first so only one group is returned for each
unique value.

For example, a list of ``User`` objects with a ``city`` attribute
can be rendered in groups. In this example, ``grouper`` refers to
the ``city`` value of the group.

.. sourcecode:: html+jinja

    <ul>{% for city, items in users|groupby("city") %}
      <li>{{ city }}
        <ul>{% for user in items %}
          <li>{{ user.name }}
        {% endfor %}</ul>
      </li>
    {% endfor %}</ul>

``groupby`` yields namedtuples of ``(grouper, list)``, which
can be used instead of the tuple unpacking above. ``grouper`` is the
value of the attribute, and ``list`` is the items with that value.

.. sourcecode:: html+jinja

    <ul>{% for group in users|groupby("city") %}
      <li>{{ group.grouper }}: {{ group.list|join(", ") }}
    {% endfor %}</ul>

.. versionchanged:: 2.6
    The attribute supports dot notation for nested access.

◆ do_indent()

def jinja2.filters.do_indent (   s,
  width = 4,
  first = False,
  blank = False,
  indentfirst = None 
)
Return a copy of the string with each line indented by 4 spaces. The
first line and blank lines are not indented by default.

:param width: Number of spaces to indent by.
:param first: Don't skip indenting the first line.
:param blank: Don't skip indenting empty lines.

.. versionchanged:: 2.10
    Blank lines are not indented by default.

    Rename the ``indentfirst`` argument to ``first``.

◆ do_int()

def jinja2.filters.do_int (   value,
  default = 0,
  base = 10 
)
Convert the value into an integer. If the
conversion doesn't work it will return ``0``. You can
override this default using the first parameter. You
can also override the default base (10) in the second
parameter, which handles input with prefixes such as
0b, 0o and 0x for bases 2, 8 and 16 respectively.
The base is ignored for decimal numbers and non-string values.

◆ do_join()

def jinja2.filters.do_join (   eval_ctx,
  value,
  d = u"",
  attribute = None 
)
Return a string which is the concatenation of the strings in the
sequence. The separator between elements is an empty string per
default, you can define it with the optional parameter:

.. sourcecode:: jinja

    {{ [1, 2, 3]|join('|') }}
        -> 1|2|3

    {{ [1, 2, 3]|join }}
        -> 123

It is also possible to join certain attributes of an object:

.. sourcecode:: jinja

    {{ users|join(', ', attribute='username') }}

.. versionadded:: 2.6
   The `attribute` parameter was added.

◆ do_last()

def jinja2.filters.do_last (   environment,
  seq 
)
Return the last item of a sequence.

Note: Does not work with generators. You may want to explicitly
convert it to a list:

.. sourcecode:: jinja

    {{ data | selectattr('name', '==', 'Jinja') | list | last }}

◆ do_list()

def jinja2.filters.do_list (   value)
Convert the value into a list.  If it was a string the returned list
will be a list of characters.

◆ do_lower()

def jinja2.filters.do_lower (   s)
Convert a value to lowercase.

◆ do_map()

def jinja2.filters.do_map ( args,
**  kwargs 
)
Applies a filter on a sequence of objects or looks up an attribute.
This is useful when dealing with lists of objects but you are really
only interested in a certain value of it.

The basic usage is mapping on an attribute.  Imagine you have a list
of users but you are only interested in a list of usernames:

.. sourcecode:: jinja

    Users on this page: {{ users|map(attribute='username')|join(', ') }}

You can specify a ``default`` value to use if an object in the list
does not have the given attribute.

.. sourcecode:: jinja

    {{ users|map(attribute="username", default="Anonymous")|join(", ") }}

Alternatively you can let it invoke a filter by passing the name of the
filter and the arguments afterwards.  A good example would be applying a
text conversion filter on a sequence:

.. sourcecode:: jinja

    Users on this page: {{ titles|map('lower')|join(', ') }}

Similar to a generator comprehension such as:

.. code-block:: python

    (u.username for u in users)
    (u.username or "Anonymous" for u in users)
    (do_lower(x) for x in titles)

.. versionchanged:: 2.11.0
    Added the ``default`` parameter.

.. versionadded:: 2.7

◆ do_mark_safe()

def jinja2.filters.do_mark_safe (   value)
Mark the value as safe which means that in an environment with automatic
escaping enabled this variable will not be escaped.

◆ do_mark_unsafe()

def jinja2.filters.do_mark_unsafe (   value)
Mark a value as unsafe.  This is the reverse operation for :func:`safe`.

◆ do_max()

def jinja2.filters.do_max (   environment,
  value,
  case_sensitive = False,
  attribute = None 
)
Return the largest item from the sequence.

.. sourcecode:: jinja

    {{ [1, 2, 3]|max }}
        -> 3

:param case_sensitive: Treat upper and lower case strings as distinct.
:param attribute: Get the object with the max value of this attribute.

◆ do_min()

def jinja2.filters.do_min (   environment,
  value,
  case_sensitive = False,
  attribute = None 
)
Return the smallest item from the sequence.

.. sourcecode:: jinja

    {{ [1, 2, 3]|min }}
        -> 1

:param case_sensitive: Treat upper and lower case strings as distinct.
:param attribute: Get the object with the min value of this attribute.

◆ do_pprint()

def jinja2.filters.do_pprint (   value,
  verbose = False 
)
Pretty print a variable. Useful for debugging.

With Jinja 1.2 onwards you can pass it a parameter.  If this parameter
is truthy the output will be more verbose (this requires `pretty`)

◆ do_random()

def jinja2.filters.do_random (   context,
  seq 
)
Return a random item from the sequence.

◆ do_reject()

def jinja2.filters.do_reject ( args,
**  kwargs 
)
Filters a sequence of objects by applying a test to each object,
and rejecting the objects with the test succeeding.

If no test is specified, each object will be evaluated as a boolean.

Example usage:

.. sourcecode:: jinja

    {{ numbers|reject("odd") }}

Similar to a generator comprehension such as:

.. code-block:: python

    (n for n in numbers if not test_odd(n))

.. versionadded:: 2.7

◆ do_rejectattr()

def jinja2.filters.do_rejectattr ( args,
**  kwargs 
)
Filters a sequence of objects by applying a test to the specified
attribute of each object, and rejecting the objects with the test
succeeding.

If no test is specified, the attribute's value will be evaluated as
a boolean.

.. sourcecode:: jinja

    {{ users|rejectattr("is_active") }}
    {{ users|rejectattr("email", "none") }}

Similar to a generator comprehension such as:

.. code-block:: python

    (u for user in users if not user.is_active)
    (u for user in users if not test_none(user.email))

.. versionadded:: 2.7

◆ do_replace()

def jinja2.filters.do_replace (   eval_ctx,
  s,
  old,
  new,
  count = None 
)
Return a copy of the value with all occurrences of a substring
replaced with a new one. The first argument is the substring
that should be replaced, the second is the replacement string.
If the optional third argument ``count`` is given, only the first
``count`` occurrences are replaced:

.. sourcecode:: jinja

    {{ "Hello World"|replace("Hello", "Goodbye") }}
        -> Goodbye World

    {{ "aaaaargh"|replace("a", "d'oh, ", 2) }}
        -> d'oh, d'oh, aaargh

◆ do_reverse()

def jinja2.filters.do_reverse (   value)
Reverse the object or return an iterator that iterates over it the other
way round.

◆ do_round()

def jinja2.filters.do_round (   value,
  precision = 0,
  method = "common" 
)
Round the number to a given precision. The first
parameter specifies the precision (default is ``0``), the
second the rounding method:

- ``'common'`` rounds either up or down
- ``'ceil'`` always rounds up
- ``'floor'`` always rounds down

If you don't specify a method ``'common'`` is used.

.. sourcecode:: jinja

    {{ 42.55|round }}
        -> 43.0
    {{ 42.55|round(1, 'floor') }}
        -> 42.5

Note that even if rounded to 0 precision, a float is returned.  If
you need a real integer, pipe it through `int`:

.. sourcecode:: jinja

    {{ 42.55|round|int }}
        -> 43

◆ do_select()

def jinja2.filters.do_select ( args,
**  kwargs 
)
Filters a sequence of objects by applying a test to each object,
and only selecting the objects with the test succeeding.

If no test is specified, each object will be evaluated as a boolean.

Example usage:

.. sourcecode:: jinja

    {{ numbers|select("odd") }}
    {{ numbers|select("odd") }}
    {{ numbers|select("divisibleby", 3) }}
    {{ numbers|select("lessthan", 42) }}
    {{ strings|select("equalto", "mystring") }}

Similar to a generator comprehension such as:

.. code-block:: python

    (n for n in numbers if test_odd(n))
    (n for n in numbers if test_divisibleby(n, 3))

.. versionadded:: 2.7

◆ do_selectattr()

def jinja2.filters.do_selectattr ( args,
**  kwargs 
)
Filters a sequence of objects by applying a test to the specified
attribute of each object, and only selecting the objects with the
test succeeding.

If no test is specified, the attribute's value will be evaluated as
a boolean.

Example usage:

.. sourcecode:: jinja

    {{ users|selectattr("is_active") }}
    {{ users|selectattr("email", "none") }}

Similar to a generator comprehension such as:

.. code-block:: python

    (u for user in users if user.is_active)
    (u for user in users if test_none(user.email))

.. versionadded:: 2.7

◆ do_slice()

def jinja2.filters.do_slice (   value,
  slices,
  fill_with = None 
)
Slice an iterator and return a list of lists containing
those items. Useful if you want to create a div containing
three ul tags that represent columns:

.. sourcecode:: html+jinja

    <div class="columnwrapper">
      {%- for column in items|slice(3) %}
        <ul class="column-{{ loop.index }}">
        {%- for item in column %}
          <li>{{ item }}</li>
        {%- endfor %}
        </ul>
      {%- endfor %}
    </div>

If you pass it a second argument it's used to fill missing
values on the last iteration.

◆ do_sort()

def jinja2.filters.do_sort (   environment,
  value,
  reverse = False,
  case_sensitive = False,
  attribute = None 
)
Sort an iterable using Python's :func:`sorted`.

.. sourcecode:: jinja

    {% for city in cities|sort %}
        ...
    {% endfor %}

:param reverse: Sort descending instead of ascending.
:param case_sensitive: When sorting strings, sort upper and lower
    case separately.
:param attribute: When sorting objects or dicts, an attribute or
    key to sort by. Can use dot notation like ``"address.city"``.
    Can be a list of attributes like ``"age,name"``.

The sort is stable, it does not change the relative order of
elements that compare equal. This makes it is possible to chain
sorts on different attributes and ordering.

.. sourcecode:: jinja

    {% for user in users|sort(attribute="name")
        |sort(reverse=true, attribute="age") %}
        ...
    {% endfor %}

As a shortcut to chaining when the direction is the same for all
attributes, pass a comma separate list of attributes.

.. sourcecode:: jinja

    {% for user users|sort(attribute="age,name") %}
        ...
    {% endfor %}

.. versionchanged:: 2.11.0
    The ``attribute`` parameter can be a comma separated list of
    attributes, e.g. ``"age,name"``.

.. versionchanged:: 2.6
   The ``attribute`` parameter was added.

◆ do_striptags()

def jinja2.filters.do_striptags (   value)
Strip SGML/XML tags and replace adjacent whitespace by one space.

◆ do_sum()

def jinja2.filters.do_sum (   environment,
  iterable,
  attribute = None,
  start = 0 
)
Returns the sum of a sequence of numbers plus the value of parameter
'start' (which defaults to 0).  When the sequence is empty it returns
start.

It is also possible to sum up only certain attributes:

.. sourcecode:: jinja

    Total: {{ items|sum(attribute='price') }}

.. versionchanged:: 2.6
   The `attribute` parameter was added to allow suming up over
   attributes.  Also the `start` parameter was moved on to the right.

◆ do_title()

def jinja2.filters.do_title (   s)
Return a titlecased version of the value. I.e. words will start with
uppercase letters, all remaining characters are lowercase.

◆ do_tojson()

def jinja2.filters.do_tojson (   eval_ctx,
  value,
  indent = None 
)
Dumps a structure to JSON so that it's safe to use in ``<script>``
tags.  It accepts the same arguments and returns a JSON string.  Note that
this is available in templates through the ``|tojson`` filter which will
also mark the result as safe.  Due to how this function escapes certain
characters this is safe even if used outside of ``<script>`` tags.

The following characters are escaped in strings:

-   ``<``
-   ``>``
-   ``&``
-   ``'``

This makes it safe to embed such strings in any place in HTML with the
notable exception of double quoted attributes.  In that case single
quote your attributes or HTML escape it in addition.

The indent parameter can be used to enable pretty printing.  Set it to
the number of spaces that the structures should be indented with.

Note that this filter is for use in HTML contexts only.

.. versionadded:: 2.9

◆ do_trim()

def jinja2.filters.do_trim (   value,
  chars = None 
)
Strip leading and trailing characters, by default whitespace.

◆ do_truncate()

def jinja2.filters.do_truncate (   env,
  s,
  length = 255,
  killwords = False,
  end = "...",
  leeway = None 
)
Return a truncated copy of the string. The length is specified
with the first parameter which defaults to ``255``. If the second
parameter is ``true`` the filter will cut the text at length. Otherwise
it will discard the last word. If the text was in fact
truncated it will append an ellipsis sign (``"..."``). If you want a
different ellipsis sign than ``"..."`` you can specify it using the
third parameter. Strings that only exceed the length by the tolerance
margin given in the fourth parameter will not be truncated.

.. sourcecode:: jinja

    {{ "foo bar baz qux"|truncate(9) }}
        -> "foo..."
    {{ "foo bar baz qux"|truncate(9, True) }}
        -> "foo ba..."
    {{ "foo bar baz qux"|truncate(11) }}
        -> "foo bar baz qux"
    {{ "foo bar baz qux"|truncate(11, False, '...', 0) }}
        -> "foo bar..."

The default leeway on newer Jinja versions is 5 and was 0 before but
can be reconfigured globally.

◆ do_unique()

def jinja2.filters.do_unique (   environment,
  value,
  case_sensitive = False,
  attribute = None 
)
Returns a list of unique items from the given iterable.

.. sourcecode:: jinja

    {{ ['foo', 'bar', 'foobar', 'FooBar']|unique|list }}
        -> ['foo', 'bar', 'foobar']

The unique items are yielded in the same order as their first occurrence in
the iterable passed to the filter.

:param case_sensitive: Treat upper and lower case strings as distinct.
:param attribute: Filter objects with unique values for this attribute.

◆ do_upper()

def jinja2.filters.do_upper (   s)
Convert a value to uppercase.

◆ do_urlencode()

def jinja2.filters.do_urlencode (   value)
Quote data for use in a URL path or query using UTF-8.

Basic wrapper around :func:`urllib.parse.quote` when given a
string, or :func:`urllib.parse.urlencode` for a dict or iterable.

:param value: Data to quote. A string will be quoted directly. A
    dict or iterable of ``(key, value)`` pairs will be joined as a
    query string.

When given a string, "/" is not quoted. HTTP servers treat "/" and
"%2F" equivalently in paths. If you need quoted slashes, use the
``|replace("/", "%2F")`` filter.

.. versionadded:: 2.7

◆ do_urlize()

def jinja2.filters.do_urlize (   eval_ctx,
  value,
  trim_url_limit = None,
  nofollow = False,
  target = None,
  rel = None 
)
Converts URLs in plain text into clickable links.

If you pass the filter an additional integer it will shorten the urls
to that number. Also a third argument exists that makes the urls
"nofollow":

.. sourcecode:: jinja

    {{ mytext|urlize(40, true) }}
        links are shortened to 40 chars and defined with rel="nofollow"

If *target* is specified, the ``target`` attribute will be added to the
``<a>`` tag:

.. sourcecode:: jinja

   {{ mytext|urlize(40, target='_blank') }}

.. versionchanged:: 2.8+
   The *target* parameter was added.

◆ do_wordcount()

def jinja2.filters.do_wordcount (   s)
Count the words in that string.

◆ do_wordwrap()

def jinja2.filters.do_wordwrap (   environment,
  s,
  width = 79,
  break_long_words = True,
  wrapstring = None,
  break_on_hyphens = True 
)
Wrap a string to the given width. Existing newlines are treated
as paragraphs to be wrapped separately.

:param s: Original text to wrap.
:param width: Maximum length of wrapped lines.
:param break_long_words: If a word is longer than ``width``, break
    it across lines.
:param break_on_hyphens: If a word contains hyphens, it may be split
    across lines.
:param wrapstring: String to join each wrapped line. Defaults to
    :attr:`Environment.newline_sequence`.

.. versionchanged:: 2.11
    Existing newlines are treated as paragraphs wrapped separately.

.. versionchanged:: 2.11
    Added the ``break_on_hyphens`` parameter.

.. versionchanged:: 2.7
    Added the ``wrapstring`` parameter.

◆ do_xmlattr()

def jinja2.filters.do_xmlattr (   _eval_ctx,
  d,
  autospace = True 
)
Create an SGML/XML attribute string based on the items in a dict.
All values that are neither `none` nor `undefined` are automatically
escaped:

.. sourcecode:: html+jinja

    <ul{{ {'class': 'my_list', 'missing': none,
            'id': 'list-%d'|format(variable)}|xmlattr }}>
    ...
    </ul>

Results in something like this:

.. sourcecode:: html

    <ul class="my_list" id="list-42">
    ...
    </ul>

As you can see it automatically prepends a space in front of the item
if the filter returned something unless the second parameter is false.

◆ environmentfilter()

def jinja2.filters.environmentfilter (   f)
Decorator for marking environment dependent filters.  The current
:class:`Environment` is passed to the filter as first argument.

◆ evalcontextfilter()

def jinja2.filters.evalcontextfilter (   f)
Decorator for marking eval-context dependent filters.  An eval
context object is passed as first argument.  For more information
about the eval context, see :ref:`eval-context`.

.. versionadded:: 2.4

◆ ignore_case()

def jinja2.filters.ignore_case (   value)
For use as a postprocessor for :func:`make_attrgetter`. Converts strings
to lowercase and returns other types as-is.

◆ make_attrgetter()

def jinja2.filters.make_attrgetter (   environment,
  attribute,
  postprocess = None,
  default = None 
)
Returns a callable that looks up the given attribute from a
passed object with the rules of the environment.  Dots are allowed
to access attributes of attributes.  Integer parts in paths are
looked up as integers.

◆ make_multi_attrgetter()

def jinja2.filters.make_multi_attrgetter (   environment,
  attribute,
  postprocess = None 
)
Returns a callable that looks up the given comma separated
attributes from a passed object with the rules of the environment.
Dots are allowed to access attributes of each attribute.  Integer
parts in paths are looked up as integers.

The value returned by the returned callable is a list of extracted
attribute values.

Examples of attribute: "attr1,attr2", "attr1.inner1.0,attr2.inner2.0", etc.

◆ prepare_map()

def jinja2.filters.prepare_map (   args,
  kwargs 
)

◆ prepare_select_or_reject()

def jinja2.filters.prepare_select_or_reject (   args,
  kwargs,
  modfunc,
  lookup_attr 
)

◆ select_or_reject()

def jinja2.filters.select_or_reject (   args,
  kwargs,
  modfunc,
  lookup_attr 
)

Variable Documentation

◆ FILTERS

FILTERS