Module base

django.template.base

This is the Django template system.

How it works:

The Lexer.tokenize() method converts a template string (i.e., a string
containing markup with custom template tags) to tokens, which can be either
plain text (TokenType.TEXT), variables (TokenType.VAR), or block statements
(TokenType.BLOCK).

The Parser() class takes a list of tokens in its constructor, and its parse()
method returns a compiled template -- which is, under the hood, a list of
Node objects.

Each Node is responsible for creating some sort of output -- e.g. simple text
(TextNode), variable values in a given context (VariableNode), results of basic
logic (IfNode), results of looping (ForNode), or anything else. The core Node
types are TextNode, VariableNode, IfNode and ForNode, but plugin modules can
define their own custom node types.

Each Node has a render() method, which takes a Context and returns a string of
the rendered node. For example, the render() method of a Variable Node returns
the variable's value as a string. The render() method of a ForNode returns the
rendered output of whatever was inside the loop, recursively.

The Template class is a convenient wrapper that takes care of template
compilation and rendering.

Usage:

The only thing you should ever use directly in this file is the Template class.
Create a compiled template object with a template_string, then call render()
with a context. In the compilation stage, the TemplateSyntaxError exception
will be raised if the template doesn't have proper syntax.

Sample code:

>>> from django import template
>>> s = '<html>{% if test %}<h1>{{ varvalue }}</h1>{% endif %}</html>'
>>> t = template.Template(s)

(t is now a compiled template, and its render() method can be called multiple
times with multiple contexts)

>>> c = template.Context({'test':True, 'varvalue': 'Hello'})
>>> t.render(c)
'<html><h1>Hello</h1></html>'
>>> c = template.Context({'test':False, 'varvalue': 'Hello'})
>>> t.render(c)
'<html></html>'

source link

Classes

class DebugLexer
class FilterExpression
Parse a variable token and its optional filters (all as a single string), and return a list of tuples of the filter name and arguments. Sample::
class Lexer
class Node
class NodeList
class Origin
class Parser
class Template
class TextNode
class Token
class TokenType
class Variable
A template variable, resolvable against a given context. The variable may be a hard-coded string (if it begins and ends with single or double quote marks)::
class VariableDoesNotExist
class VariableNode

Functions

▷ def linebreak_iter(template_source)
source link
▶ def render_value_in_context(value, context)
Convert any value to a string to become part of a rendered template. This means escaping, if required, and conversion to a string. If value is a string, it's expected to already be translated.
source link
Reexports
- Imported in django.template.defaulttags.
- Imported in django.templatetags.i18n.

▶ def token_kwargs(bits, parser, support_legacy=False)

Parse token keyword arguments and return a dictionary of the arguments retrieved from the ``bits`` token list.

source link

`bits` is a list containing the remainder of the token (split by spaces)
that is to be checked for arguments. Valid arguments are removed from this
list.

`support_legacy` - if True, the legacy format ``1 as foo`` is accepted.
Otherwise, only the standard ``foo=1`` format is allowed.

There is no requirement for all remaining token ``bits`` to be keyword
arguments, so return the dictionary as soon as an invalid argument format
is reached.

Reexports

Imported in django.template.defaulttags.
Imported in django.template.library.
Imported in django.template.loader_tags.
Imported in django.templatetags.i18n.