remove non ascii whitespaces
This commit is contained in:
parent
598a10bc28
commit
5a6d6c4d13
GPG key ID:
901B2ADDF27C2263
117 changed files with 1928 additions and 1928 deletions
|
|
@ -31,12 +31,12 @@ Below is a minimal template that illustrates a few basics using the default Jinj
|
|||
```
|
||||
|
||||
There are a few kinds of delimiters. The default Jinja delimiters are configured as follows:
|
||||
- `{% ... %}` for Statements
|
||||
- `{{ ... }}` for Expressions to print to the template output
|
||||
- `{# ... #}` for Comments not included in the template output
|
||||
- `{% ... %}` for Statements
|
||||
- `{{ ... }}` for Expressions to print to the template output
|
||||
- `{# ... #}` for Comments not included in the template output
|
||||
|
||||
### Comments
|
||||
To comment-out part of a line in a template, use the comment syntax which is by default set to `{# ... #}`. This is useful to comment out parts of the template for debugging or to add information for other template designers or yourself:
|
||||
To comment-out part of a line in a template, use the comment syntax which is by default set to `{# ... #}`. This is useful to comment out parts of the template for debugging or to add information for other template designers or yourself:
|
||||
```
|
||||
{# note: commented-out template because we no longer use this
|
||||
{% for user in users %}
|
||||
|
|
@ -51,19 +51,19 @@ Jinja allows basic expressions everywhere. These work very similarly to regular
|
|||
#### Literals
|
||||
The simplest form of expressions are literals. Literals are representations for [Python](../dev/programming/languages/Python.md) objects such as strings and numbers. The following literals exist:
|
||||
|
||||
`"Hello World"`
|
||||
`"Hello World"`
|
||||
|
||||
Everything between two double or single quotes is a string. They are useful whenever you need a string in the template (e.g. as arguments to function calls and filters, or just to extend or include a template).
|
||||
|
||||
`42` / `123_456`
|
||||
`42` / `123_456`
|
||||
|
||||
Integers are whole numbers without a decimal part. The ‘_’ character can be used to separate groups for legibility.
|
||||
|
||||
`42.23` / `42.1e2` / `123_456.789`
|
||||
`42.23` / `42.1e2` / `123_456.789`
|
||||
|
||||
Floating point numbers can be written using a ‘.’ as a decimal mark. They can also be written in scientific notation with an upper or lower case ‘e’ to indicate the exponent part. The ‘_’ character can be used to separate groups for legibility, but cannot be used in the exponent part.
|
||||
|
||||
`['list', 'of', 'objects']`
|
||||
`['list', 'of', 'objects']`
|
||||
|
||||
Everything between two brackets is a list. Lists are useful for storing sequential data to be iterated over. For example, you can easily create a list of links using lists and tuples for (and with) a for loop:
|
||||
|
||||
|
|
@ -76,34 +76,34 @@ Everything between two brackets is a list. Lists are useful for storing sequenti
|
|||
</ul>
|
||||
```
|
||||
|
||||
`('tuple', 'of', 'values')`
|
||||
`('tuple', 'of', 'values')`
|
||||
|
||||
Tuples are like lists that cannot be modified (“immutable”). If a tuple only has one item, it must be followed by a comma (`('1-tuple',)`). Tuples are usually used to represent items of two or more elements. See the list example above for more details.
|
||||
|
||||
`{'dict': 'of', 'key': 'and', 'value': 'pairs'}`
|
||||
`{'dict': 'of', 'key': 'and', 'value': 'pairs'}`
|
||||
|
||||
A dict in [Python](../dev/programming/languages/Python.md) is a structure that combines keys and values. Keys must be unique and always have exactly one value. Dicts are rarely used in templates; they are useful in some rare cases such as the `xmlattr()` filter.
|
||||
A dict in [Python](../dev/programming/languages/Python.md) is a structure that combines keys and values. Keys must be unique and always have exactly one value. Dicts are rarely used in templates; they are useful in some rare cases such as the `xmlattr()` filter.
|
||||
|
||||
`true` / `false`
|
||||
`true` / `false`
|
||||
|
||||
`true` is always true and `false` is always false.
|
||||
`true` is always true and `false` is always false.
|
||||
|
||||
#### If Expression
|
||||
It is also possible to use inline if expressions. These are useful in some situations. For example, you can use this to extend from one template if a variable is defined, otherwise from the default layout template:
|
||||
It is also possible to use inline if expressions. These are useful in some situations. For example, you can use this to extend from one template if a variable is defined, otherwise from the default layout template:
|
||||
```
|
||||
{% extends layout_template if layout_template is defined else 'default.html' %}
|
||||
```
|
||||
|
||||
The general syntax is `<do something> if <something is true> else <do something else>`.
|
||||
The general syntax is `<do something> if <something is true> else <do something else>`.
|
||||
|
||||
The else part is optional. If not provided, the else block implicitly evaluates into an `Undefined` object (regardless of what `undefined` in the environment is set to):
|
||||
The else part is optional. If not provided, the else block implicitly evaluates into an `Undefined` object (regardless of what `undefined` in the environment is set to):
|
||||
```
|
||||
{{ "[{}]".format(page.title) if page.title }}
|
||||
```
|
||||
|
||||
#### Builtin Filters
|
||||
##### batch(value, linecount: int, fill_with: 'Optional' = 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:
|
||||
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:
|
||||
```
|
||||
<table>
|
||||
{%- for row in items|batch(3, ' ') %}
|
||||
|
|
@ -125,7 +125,7 @@ If the value is undefined it will return the passed default value, otherwise the
|
|||
{{ 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:
|
||||
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:
|
||||
```
|
||||
{{ ''|default('the string was empty', true) }}
|
||||
```
|
||||
|
|
@ -147,18 +147,18 @@ Sort a dict and yield (key, value) pairs. [Python](../dev/programming/languages/
|
|||
```
|
||||
|
||||
##### escape(value)
|
||||
Replace the characters `&`, `<`, `>`, `'`, and `"` in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in [HTML](../internet/HTML.md).
|
||||
Replace the characters `&`, `<`, `>`, `'`, and `"` in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in [HTML](../internet/HTML.md).
|
||||
|
||||
If the object has an `__html__` method, it is called and the return value is assumed to already be safe for [HTML](../internet/HTML.md).
|
||||
If the object has an `__html__` method, it is called and the return value is assumed to already be safe for [HTML](../internet/HTML.md).
|
||||
|
||||
##### filesizeformat(value, binary: bool = 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).
|
||||
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).
|
||||
|
||||
##### first(seq)
|
||||
Return the first item of a sequence.
|
||||
|
||||
##### float(value, default: float = 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.
|
||||
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.
|
||||
|
||||
##### forceescape(value)
|
||||
Enforce [HTML](../internet/HTML.md) escaping. This will probably double escape variables.
|
||||
|
|
@ -177,9 +177,9 @@ In most cases it should be more convenient and efficient to use the `%` operator
|
|||
```
|
||||
|
||||
##### groupby(value, attribute: str | int, default: Any | None = None, case_sensitive: bool = False)
|
||||
Group a sequence of objects by an attribute using [Python](../dev/programming/languages/Python.md)’s `itertools.groupby()`. The attribute can use dot notation for nested access, like `"address.city"`. Unlike [Python](../dev/programming/languages/Python.md)’s `groupby`, the values are sorted first so only one group is returned for each unique value.
|
||||
Group a sequence of objects by an attribute using [Python](../dev/programming/languages/Python.md)’s `itertools.groupby()`. The attribute can use dot notation for nested access, like `"address.city"`. Unlike [Python](../dev/programming/languages/Python.md)’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.
|
||||
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.
|
||||
```
|
||||
<ul>{% for city, items in users|groupby("city") %}
|
||||
<li>{{ city }}
|
||||
|
|
@ -190,14 +190,14 @@ For example, a list of `User` objects with a `city` attribute can be rendere
|
|||
{% 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.
|
||||
`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.
|
||||
```
|
||||
<ul>{% for group in users|groupby("city") %}
|
||||
<li>{{ group.grouper }}: {{ group.list|join(", ") }}
|
||||
{% endfor %}</ul>
|
||||
```
|
||||
|
||||
You can specify a `default` value to use if an object in the list does not have the given attribute.
|
||||
You can specify a `default` value to use if an object in the list does not have the given attribute.
|
||||
```
|
||||
<ul>{% for city, items in users|groupby("city", default="NY") %}
|
||||
<li>{{ city }}: {{ items|map(attribute="name")|join(", ") }}</li>
|
||||
|
|
@ -208,16 +208,16 @@ You can specify a `default` value to use if an object in the list does not hav
|
|||
Return a copy of the string with each line indented by 4 spaces. The first line and blank lines are not indented by default.
|
||||
|
||||
Parameters:
|
||||
- **width** – Number of spaces, or a string, to indent by.
|
||||
- **first** – Don’t skip indenting the first line.
|
||||
- **blank** – Don’t skip indenting empty lines.
|
||||
- **width** – Number of spaces, or a string, to indent by.
|
||||
- **first** – Don’t skip indenting the first line.
|
||||
- **blank** – Don’t skip indenting empty lines.
|
||||
|
||||
##### items(value)
|
||||
Return an iterator over the `(key, value)` items of a mapping.
|
||||
Return an iterator over the `(key, value)` items of a mapping.
|
||||
|
||||
`x|items` is the same as `x.items()`, except if `x` is undefined an empty iterator is returned.
|
||||
`x|items` is the same as `x.items()`, except if `x` is undefined an empty iterator is returned.
|
||||
|
||||
This filter is useful if you expect the template to be rendered with an implementation of Jinja in another programming language that does not have a `.items()` method on its mapping type.
|
||||
This filter is useful if you expect the template to be rendered with an implementation of Jinja in another programming language that does not have a `.items()` method on its mapping type.
|
||||
```
|
||||
<dl>
|
||||
{% for key, value in my_dict|items %}
|
||||
|
|
@ -261,7 +261,7 @@ Return the smallest item from the sequence.
|
|||
Return a random item from the sequence.
|
||||
|
||||
##### replace(s: str, old: str, new: str, count: int | None = 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:
|
||||
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:
|
||||
```
|
||||
{{ "Hello World"|replace("Hello", "Goodbye") }}
|
||||
-> Goodbye World
|
||||
|
|
@ -274,12 +274,12 @@ Return a copy of the value with all occurrences of a substring replaced with a n
|
|||
Reverse the object or return an iterator that iterates over it the other way round.
|
||||
|
||||
##### round(value: float, precision: int = 0, method: Literal\["common", "ceil", "floor"]' = '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
|
||||
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.
|
||||
If you don’t specify a method `'common'` is used.
|
||||
```
|
||||
{{ 42.55|round }}
|
||||
-> 43.0
|
||||
|
|
@ -287,7 +287,7 @@ If you don’t specify a method `'common'` is used.
|
|||
-> 42.5
|
||||
```
|
||||
|
||||
Note that even if rounded to 0 precision, a float is returned. If you need a real integer, pipe it through int:
|
||||
Note that even if rounded to 0 precision, a float is returned. If you need a real integer, pipe it through int:
|
||||
```
|
||||
{{ 42.55|round|int }}
|
||||
-> 43
|
||||
|
|
@ -297,7 +297,7 @@ Note that even if rounded to 0 precision, a float is returned. If you need a rea
|
|||
Strip leading and trailing characters, by default whitespace.
|
||||
|
||||
##### truncate(s: str, length: int = 255, killwords: bool = False, end: str = '...', leeway: int | None = 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.
|
||||
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.
|
||||
```
|
||||
{{ "foo bar baz qux"|truncate(9) }}
|
||||
-> "foo..."
|
||||
|
|
@ -319,8 +319,8 @@ Returns a list of unique items from the given iterable.
|
|||
The unique items are yielded in the same order as their first occurrence in the iterable passed to the filter.
|
||||
|
||||
Parameters:
|
||||
- **case_sensitive** – Treat upper and lower case strings as distinct.
|
||||
- **attribute** – Filter objects with unique values for this attribute.
|
||||
- **case_sensitive** – Treat upper and lower case strings as distinct.
|
||||
- **attribute** – Filter objects with unique values for this attribute.
|
||||
|
||||
##### urlencode(value)
|
||||
Quote data for use in a URL path or query using UTF-8.
|
||||
|
|
@ -339,11 +339,11 @@ Count the words in that string.
|
|||
Wrap a string to the given width. Existing newlines are treated as paragraphs to be wrapped separately.
|
||||
|
||||
Parameters:
|
||||
- **s** – Original text to wrap.
|
||||
- **width** – Maximum length of wrapped lines.
|
||||
- **break_long_words** – If a word is longer than `width`, break it across lines.
|
||||
- **break_on_hyphens** – If a word contains hyphens, it may be split across lines.
|
||||
- **wrapstring** – String to join each wrapped line. Defaults to `Environment.newline_sequence`.
|
||||
- **s** – Original text to wrap.
|
||||
- **width** – Maximum length of wrapped lines.
|
||||
- **break_long_words** – If a word is longer than `width`, break it across lines.
|
||||
- **break_on_hyphens** – If a word contains hyphens, it may be split across lines.
|
||||
- **wrapstring** – String to join each wrapped line. Defaults to `Environment.newline_sequence`.
|
||||
|
||||
#### Builtin Tests
|
||||
##### boolean(value)
|
||||
|
|
@ -359,7 +359,7 @@ Return true if the variable is defined:
|
|||
{% endif %}
|
||||
```
|
||||
|
||||
See the `default()` filter for a simple way to set undefined variables.
|
||||
See the `default()` filter for a simple way to set undefined variables.
|
||||
|
||||
##### divisibleby(value, num: int)
|
||||
Check if a variable is divisible by a number.
|
||||
|
|
@ -375,7 +375,7 @@ Return true if the variable is odd.
|
|||
|
||||
### Statements
|
||||
#### for
|
||||
Loop over each item in a sequence. For example, to display a list of users provided in a variable called users:
|
||||
Loop over each item in a sequence. For example, to display a list of users provided in a variable called users:
|
||||
```
|
||||
<h1>Members</h1>
|
||||
<ul>
|
||||
|
|
@ -403,7 +403,7 @@ Inside of a for-loop block, you can access some special variables:
|
|||
| loop.nextitem | The item from the following iteration of the loop. Undefined during the last iteration. |
|
||||
| loop.changed(*val) | True if previously called with a different value (or not called at all). |
|
||||
|
||||
Within a for-loop, it’s possible to cycle among a list of strings/variables each time through the loop by using the special loop.cycle helper:
|
||||
Within a for-loop, it’s possible to cycle among a list of strings/variables each time through the loop by using the special loop.cycle helper:
|
||||
```
|
||||
{% for row in rows %}
|
||||
<li class="{{ loop.cycle('odd', 'even') }}">{{ row }}</li>
|
||||
|
|
@ -411,7 +411,7 @@ Within a for-loop, it’s possible to cycle among a list of strings/variables ea
|
|||
```
|
||||
|
||||
#### if
|
||||
The if statement in Jinja is comparable with the Python if statement. In the simplest form, you can use it to test if a variable is defined, not empty and not false:
|
||||
The if statement in Jinja is comparable with the Python if statement. In the simplest form, you can use it to test if a variable is defined, not empty and not false:
|
||||
```
|
||||
{% if kenny.sick %}
|
||||
Kenny is sick.
|
||||
|
|
@ -423,7 +423,7 @@ The if statement in Jinja is comparable with the Python if statement. In the s
|
|||
```
|
||||
|
||||
#### include
|
||||
The `include` tag renders another template and outputs the result into the current template.
|
||||
The `include` tag renders another template and outputs the result into the current template.
|
||||
```
|
||||
{% include 'header.html' %}
|
||||
Body goes here.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue