3
sݨ\ @ s d Z ddlZddlZddlZddlmZmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZmZmZmZmZmZ ddlmZm Z ddl m Z ddl m Z dd l!m"Z"m#Z# dd
l$m%Z%m&Z&m'Z' dd l(m)Z)m*Z*m+Z+m,Z, dd l-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5 dd
l6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZA e/dZBdaCdd ZDdd ZEdd ZFdd ZGdd ZHdd ZIG dd d eJZKG d d d eJZLe>G d d d eJZMG d!d" d"eJZNe=G d#d$ d$eJZOeLeK_PdS )%z
jinja2.environment
~~~~~~~~~~~~~~~~~~
Provides a class that holds runtime and parsing time options.
:copyright: (c) 2017 by the Jinja Team.
:license: BSD, see LICENSE for more details.
N)reducepartial)nodes)BLOCK_START_STRINGBLOCK_END_STRINGVARIABLE_START_STRINGVARIABLE_END_STRINGCOMMENT_START_STRINGCOMMENT_END_STRINGLINE_STATEMENT_PREFIXLINE_COMMENT_PREFIX TRIM_BLOCKSNEWLINE_SEQUENCEDEFAULT_FILTERS
DEFAULT_TESTSDEFAULT_NAMESPACEDEFAULT_POLICIESKEEP_TRAILING_NEWLINE
LSTRIP_BLOCKS) get_lexer TokenStream)Parser) EvalContext)generate
CodeGenerator) Undefined new_contextContext)TemplateSyntaxErrorTemplateNotFoundTemplatesNotFoundTemplateRuntimeError)
import_stringLRUCacheMarkupmissingconcatconsume internalcodehave_async_gen) imapifilter string_types iteritems text_typereraiseimplements_iteratorimplements_to_stringencode_filenamePY2PYPY
c G sN yt j| }W n tk
r& t| S X |dk r4|S t| t | < }d|_|S )zReturn a new spontaneous environment. A spontaneous environment is an
unnamed and unaccessible (in theory) environment that is used for
templates generated from a string and not from the file system.
NT)_spontaneous_environmentsget TypeError Environmentshared)argsenv r= !/usr/lib/python3.6/environment.pyget_spontaneous_environment, s
r? c C s | dkr dS | dk ri S t | S )z*Return the cache class for the given size.r N)r# )sizer= r= r> create_cache< s
rA c C s& | dkr dS t | tkr i S t| jS )z(Create an empty copy of the given cache.N)typedictr# Zcapacity)cacher= r= r>
copy_cacheE s
rE c C s6 i }x,|D ]$}t |tr t|}|| ||j< q
W |S )zwLoad the extensions from the list and bind it to the environment.
Returns a dict of instantiated environments.
)
isinstancer, r" Z
identifier) environment
extensionsresult extensionr= r= r> load_extensionsN s
rK c C sZ | | }t |trNy |j W n. tk
rL } zd||f }W Y d d }~X nX t|d S )Nz3%s (%s; did you forget to quote the callable name?))rF r Z_fail_with_undefined_error Exceptionr! )stringnamemsger= r= r> fail_for_missing_callableZ s
rQ c C sP t | jtstd| j| j ko,| jkn s:td| jdksLtd| S )z*Perform a sanity check on the environment.zGundefined must be a subclass of undefined because filters depend on it.z;block, variable and comment start strings must be different
z3newline_sequence set to unknown line ending string.)rR rS rT )
issubclass undefinedr AssertionErrorblock_start_stringvariable_start_stringcomment_start_stringnewline_sequence)rG r= r= r> _environment_sanity_checkd s r\ c @ s e Zd ZdZdZdZdZdZdZdZ e
Z e Z
eeeeeeeeeeeef dedddddddfddZdd Z d
d Z e e e e e e e e e e e e e e e e e e e fd d
Z e e!ddZ"dd Z#dd Z$dd Z%dAddZ&dBddZ'e(dCddZ)d d Z*dDd d Z+dEd d!Z,dFd"d#Z-dGd$d%Z.d&d' Z/e(dHd(d)Z0dId*d+Z1dJd-d.Z2dKd/d0Z3dLd1d2Z4d3d4 Z5e(d5d6 Z6e(dMd7d8Z7e(dNd9d:Z8e(dOd;d<Z9dPd=d>Z:d?d@ Z;dS )Qr9 a The core component of Jinja is the `Environment`. It contains
important shared variables like configuration, filters, tests,
globals and others. Instances of this class may be modified if
they are not shared and if no template was loaded so far.
Modifications on environments after the first template was loaded
will lead to surprising effects and undefined behavior.
Here are the possible initialization parameters:
`block_start_string`
The string marking the beginning of a block. Defaults to ``'{%'``.
`block_end_string`
The string marking the end of a block. Defaults to ``'%}'``.
`variable_start_string`
The string marking the beginning of a print statement.
Defaults to ``'{{'``.
`variable_end_string`
The string marking the end of a print statement. Defaults to
``'}}'``.
`comment_start_string`
The string marking the beginning of a comment. Defaults to ``'{#'``.
`comment_end_string`
The string marking the end of a comment. Defaults to ``'#}'``.
`line_statement_prefix`
If given and a string, this will be used as prefix for line based
statements. See also :ref:`line-statements`.
`line_comment_prefix`
If given and a string, this will be used as prefix for line based
comments. See also :ref:`line-statements`.
.. versionadded:: 2.2
`trim_blocks`
If this is set to ``True`` the first newline after a block is
removed (block, not variable tag!). Defaults to `False`.
`lstrip_blocks`
If this is set to ``True`` leading spaces and tabs are stripped
from the start of a line to a block. Defaults to `False`.
`newline_sequence`
The sequence that starts a newline. Must be one of ``'\r'``,
``'\n'`` or ``'\r\n'``. The default is ``'\n'`` which is a
useful default for Linux and OS X systems as well as web
applications.
`keep_trailing_newline`
Preserve the trailing newline when rendering templates.
The default is ``False``, which causes a single newline,
if present, to be stripped from the end of the template.
.. versionadded:: 2.7
`extensions`
List of Jinja extensions to use. This can either be import paths
as strings or extension classes. For more information have a
look at :ref:`the extensions documentation `.
`optimized`
should the optimizer be enabled? Default is ``True``.
`undefined`
:class:`Undefined` or a subclass of it that is used to represent
undefined values in the template.
`finalize`
A callable that can be used to process the result of a variable
expression before it is output. For example one can convert
``None`` implicitly into an empty string here.
`autoescape`
If set to ``True`` the XML/HTML autoescaping feature is enabled by
default. For more details about autoescaping see
:class:`~jinja2.utils.Markup`. As of Jinja 2.4 this can also
be a callable that is passed the template name and has to
return ``True`` or ``False`` depending on autoescape should be
enabled by default.
.. versionchanged:: 2.4
`autoescape` can now be a function
`loader`
The template loader for this environment.
`cache_size`
The size of the cache. Per default this is ``400`` which means
that if more than 400 templates are loaded the loader will clean
out the least recently used template. If the cache size is set to
``0`` templates are recompiled all the time, if the cache size is
``-1`` the cache will not be cleaned.
.. versionchanged:: 2.8
The cache size was increased to 400 from a low 50.
`auto_reload`
Some loaders load templates from locations where the template
sources may change (ie: file system or database). If
``auto_reload`` is set to ``True`` (default) every time a template is
requested the loader checks if the source changed and if yes, it
will reload the template. For higher performance it's possible to
disable that.
`bytecode_cache`
If set to a bytecode cache object, this object will provide a
cache for the internal Jinja bytecode so that templates don't
have to be parsed if they were not changed.
See :ref:`bytecode-cache` for more information.
`enable_async`
If set to true this enables async template execution which allows
you to take advantage of newer Python features. This requires
Python 3.6 or later.
FNTi c C s || _ || _|| _|| _|| _|| _|| _|| _| | _|
| _ | | _
| | _ || _ || _
|| _|| _tj | _tj | _tj | _|| _t|| _|| _|| _t j | _ t | |
| _ || _ | j ot!| _"t#| d S )N)$rX block_end_stringrY variable_end_stringrZ comment_end_stringline_statement_prefixline_comment_prefix trim_blocks
lstrip_blocksr[ keep_trailing_newlinerV optimizedfinalize
autoescaper copyfiltersr testsr globalsloaderrA rD bytecode_cache auto_reloadr ZpoliciesrK rH enable_asyncr) is_asyncr\ )selfrX r] rY r^ rZ r_ r` ra rb rc r[ rd rH re rV rf rg rl
cache_sizern rm ro r= r= r> __init__ s8 #
zEnvironment.__init__c C s | j jt| |g dS )z\Adds an extension after the environment was created.
.. versionadded:: 2.5
N)rH updaterK )rq rJ r= r= r>
add_extensionT s zEnvironment.add_extensionc K s0 x*t |D ] \}}t| |s
t| || q
W dS )zAdd the items to the instance of the environment if they do not exist
yet. This is used by :ref:`extensions ` to register
callbacks and configuration values without breaking inheritance.
N)r- hasattrsetattr)rq Z
attributeskeyvaluer= r= r> extend[ s
zEnvironment.extendc C s t t }|d= |d= |d= tj| j}|jj| j d|_| |_x(t |D ] \}}|t
k rLt ||| qLW |t
k rt ||_
n t| j
|_
i |_x&t | jD ]\}}|j||j|< qW | t
k r|jjt|| t|S )ag Create a new overlay environment that shares all the data with the
current environment except for cache and the overridden attributes.
Extensions cannot be removed for an overlayed environment. An overlayed
environment automatically gets all the extensions of the environment it
is linked to plus optional extra extensions.
Creating overlays should happen after the initial environment was set
up completely. Not all attributes are truly linked, some are just
copied over so modifications on the original environment may not shine
through.
rq rr rH T)rC localsobject__new__ __class____dict__rt overlayed linked_tor- r% rw rA rD rE rH ZbindrK r\ )rq rX r] rY r^ rZ r_ r` ra rb rc rH re rV rf rg rl rr rn rm r; rvrx ry r= r= r> overlayd s$
zEnvironment.overlayz The lexer for this environment.)docc C s t t| jj dd dS )z)Iterates over the extensions by priority.c S s | j S )N)Zpriority)xr= r= r> s z-Environment.iter_extensions..)rx )itersortedrH values)rq r= r= r> iter_extensions s zEnvironment.iter_extensionsc C s~ y|| S t ttfk
rx t|trjy t|}W n tk
rH Y n"X y
t||S t k
rh Y nX | j||dS X dS )z:Get an item or attribute of an object but prefer the item.)objrN N) AttributeErrorr8 LookupErrorrF r, strrL getattrrV )rq r Zargumentattrr= r= r> getitem s
zEnvironment.getitemc C sR y
t ||S tk
r Y nX y|| S tttfk
rL | j||dS X dS )zGet an item or attribute of an object but prefer the attribute.
Unlike :meth:`getitem` the attribute *must* be a bytestring.
)r rN N)r r r8 r rV )rq r Z attributer= r= r> r s
zEnvironment.getattrc C s | j j|}|dkr td| |gt|p*f }t|ddrZ|dkrLtd|jd| nRt|ddr|dkr|dk r~|j}nt| }|jd| nt|ddr|jd| |||pi S ) aW Invokes a filter on a value the same way the compiler does it.
Note that on Python 3 this might return a coroutine in case the
filter is running from an environment in async mode and the filter
supports async execution. It's your responsibility to await this
if needed.
.. versionadded:: 2.7
Nzno filter named %rZ
contextfilterFz2Attempted to invoke context filter without contextr ZevalcontextfilterZenvironmentfilter) ri r7 rQ listr r! inserteval_ctxr )rq rN ry r; kwargscontextr funcr= r= r> call_filter s"
zEnvironment.call_filterc C s6 | j j|}|dkr td| ||f|p*f |p2i S )zdInvokes a test on a value the same way the compiler does it.
.. versionadded:: 2.7
Nzno test named %r)rj r7 rQ )rq rN ry r; r r r= r= r> call_test s
zEnvironment.call_testc C s> y| j |||S tk
r* tj }Y nX | j||d dS )a Parse the sourcecode and return the abstract syntax tree. This
tree of nodes is used by the compiler to convert the template into
executable source- or bytecode. This is useful for debugging or to
extract information from templates.
If you are :ref:`developing Jinja2 extensions `
this gives you a good overview of the node tree generated.
) source_hintN)_parser sysexc_infohandle_exception)rq sourcerN filenamer r= r= r> parse s
zEnvironment.parsec C s t | ||t|j S )z8Internal parsing function used by `parse` and `compile`.)r r2 r )rq r rN r r= r= r> r s zEnvironment._parsec C sH t |}y| jj|||S tk
r4 tj }Y nX | j||d dS )a Lex the given sourcecode and return a generator that yields
tokens as tuples in the form ``(lineno, token_type, value)``.
This can be useful for :ref:`extension development `
and debugging templates.
This does not perform preprocessing. If you want the preprocessing
of the extensions to be applied you have to filter source through
the :meth:`preprocess` method.
)r N)r. lexerZ tokeniterr r r r )rq r rN r r r= r= r> lex s
zEnvironment.lexc s t fdd| j t|S )zPreprocesses the source with all extensions. This is automatically
called for all parsing and compiling methods but *not* for :meth:`lex`
because there you usually only want the actual source tokenized.
c s |j | S )N)
preprocess)srP )r rN r= r> r s z(Environment.preprocess..)r r r. )rq r rN r r= )r rN r> r s zEnvironment.preprocessc C sV | j |||}| jj||||}x0| j D ]$}|j|}t|ts*t|||}q*W |S )zCalled by the parser to do the preprocessing and filtering
for all the extensions. Returns a :class:`~jinja2.lexer.TokenStream`.
)r r tokenizer Z
filter_streamrF r )rq r rN r statestreamZextr= r= r> _tokenize s
zEnvironment._tokenizec C s t || |||| jdS )z|Internal hook that can be overridden to hook a different generate
method in.
.. versionadded:: 2.5
)
defer_initre )r re )rq r rN r r r= r= r> _generate s zEnvironment._generatec C s t ||dS )z{Internal hook that can be overridden to hook a different compile
method in.
.. versionadded:: 2.5
exec)compile)rq r r r= r= r> _compile! s zEnvironment._compilec C s d}yXt |tr"|}| j|||}| j||||d}|r<|S |dkrJd}nt|}| j||S tk
rx tj }Y nX | j ||d dS )a Compile a node or template source code. The `name` parameter is
the load name of the template after it was joined using
:meth:`join_path` if necessary, not the filename on the file system.
the `filename` parameter is the estimated filename of the template on
the file system. If the template came from a database or memory this
can be omitted.
The return value of this method is a python code object. If the `raw`
parameter is `True` the return value will be a string with python
code equivalent to the bytecode returned otherwise. This method is
mainly used internally.
`defer_init` is use internally to aid the module code generator. This
causes the generated code to be able to import without the global
environment variable to be set.
.. versionadded:: 2.4
`defer_init` parameter added.
N)r z
)r )
rF r, r r r2 r r r r r )rq r rN r rawr r r r= r= r> r ) s
zEnvironment.compilec
C s t | |dd}d}y2|j }|jjs8td|jjjdd|j| W n tk
r` tj }Y nX |dk rx| j
||d t j t j
dd|dd g}| jt j|dd }t||S )
a A handy helper method that returns a callable that accepts keyword
arguments that appear as variables in the expression. If called it
returns the result of the expression.
This is useful if applications want to use the same rules as Jinja
in template "configuration files" or similar situations.
Example usage:
>>> env = Environment()
>>> expr = env.compile_expression('foo == 42')
>>> expr(foo=23)
False
>>> expr(foo=42)
True
Per default the return value is converted to `None` if the
expression returns an undefined value. This can be changed
by setting `undefined_to_none` to `False`.
>>> env.compile_expression('var')() is None
True
>>> env.compile_expression('var', undefined_to_none=False)()
Undefined
.. versionadded:: 2.1
Zvariable)r Nzchunk after expression)r rI Zstore )lineno)r Zparse_expressionr Zeosr Zcurrentr Zset_environmentr r r r ZAssignName from_stringTemplateTemplateExpression)rq r undefined_to_noneparserr exprZbodytemplater= r= r> compile_expressionQ s z Environment.compile_expressiondeflatedc s ddl m} |dkr dd }|rt s*trHddlm} | td d}n:ddl}
ddl} |
j d j
d
} t j dkr| d j
d
7 } fd
d}
dk rddl
m}m m}m} |dt||d |d n"tjjstj |d zx| j||D ]}| jj| |\}}}y| j|||dd}W n@ tk
rz } z"|sV |d||f w W Y dd}~X nX |j |}|r| j |t |}|
|d | | j | d |d||d f n |
||d |d||f q W W dr j X |d dS ) a; Finds all the templates the loader can find, compiles them
and stores them in `target`. If `zip` is `None`, instead of in a
zipfile, the templates will be stored in a directory.
By default a deflate zip algorithm is used. To switch to
the stored algorithm, `zip` can be set to ``'stored'``.
`extensions` and `filter_func` are passed to :meth:`list_templates`.
Each template returned will be compiled to the target folder or
zipfile.
By default template compilation errors are ignored. In case a
log function is provided, errors are logged. If you want template
syntax errors to abort the compilation you can set `ignore_errors`
to `False` and you will get an exception on syntax errors.
If `py_compile` is set to `True` .pyc files will be written to the
target instead of standard .py files. This flag does not do anything
on pypy and Python 3 where pyc files are not picked up by itself and
don't give much benefit.
.. versionadded:: 2.4
r ) ModuleLoaderNc S s d S )Nr= )r r= r= r> r s z/Environment.compile_templates..)warnz,py_compile has no effect on pypy or Python 3Fu ÿÿÿÿz iso-8859-15 z c
sR r | }d|_ j|| n.ttjj| |}z|j| W d |j X d S )Ni i )Z
external_attrZwritestropenospathjoinwriteclose)r datamodeinfof)ZipInfotargetzipzip_filer= r>
write_file s z1Environment.compile_templates..write_file)ZipFiler ZIP_DEFLATED
ZIP_STOREDw)r Zstoredz Compiling into Zip archive "%s"zCompiling into folder "%s"TzCould not compile "%s": %scwbzByte-compiled "%s" as %szCompiled "%s" as %sz Finished compiling templates)r r )!Zjinja2.loadersr r3 r4 warningsr WarningimpmarshalZ get_magicencoder version_infoZzipfiler r r r rC r r isdirmakedirslist_templatesrl
get_sourcer r Zget_module_filenamer r2 dumpsr )rq r rH filter_funcr Z log_function
ignore_errors
py_compiler r r r Z py_headerr r r r rN r r _coderP r r= )r r r r r> compile_templates~ sZ
z Environment.compile_templatesc sH | j j } dk r.|dk r"td fdd}|dk rDtt||}|S )a Returns a list of templates for this environment. This requires
that the loader supports the loader's
:meth:`~BaseLoader.list_templates` method.
If there are other files in the template folder besides the
actual templates, the returned list can be filtered. There are two
ways: either `extensions` is set to a list of file extensions for
templates, or a `filter_func` can be provided which is a callable that
is passed a template name and should return `True` if it should end up
in the result list.
If the loader does not support that, a :exc:`TypeError` is raised.
.. versionadded:: 2.4
Nz r s z,Environment.list_templates..)rl r r8 r r+ )rq rH r r r= )rH r> r s
zEnvironment.list_templatesc C sv |dkrt j }tdkr$ddlma t||}|rF| jdk rF| j|S | jdk rZ| j| |j\}}}t||| dS )zException handling helper. This is used internally to either raise
rewritten exceptions or return a rendered traceback for the template.
Nr )make_traceback) r r _make_tracebackZ jinja2.debugr exception_formatterexception_handlerZstandard_exc_infor/ )rq r Zrenderedr tracebackexc_type exc_valuetbr= r= r> r s
z Environment.handle_exceptionc C s |S )a Join a template with the parent. By default all the lookups are
relative to the loader root so this method returns the `template`
parameter unchanged, but if the paths should be relative to the
parent template, this function can be used to calculate the real
template name.
Subclasses may override this method and implement template path
joining here.
r= )rq r parentr= r= r> join_path s
zEnvironment.join_pathc C sz | j d krtdtj| j |f}| jd k rR| jj|}|d k rR| j sN|jrR|S | j j| ||}| jd k rv|| j|< |S )Nz(no loader for this environment specified) rl r8 weakrefrefrD r7 rn
is_up_to_dateload)rq rN rk Z cache_keyr r= r= r> _load_template s
zEnvironment._load_templatec C s4 t |tr|S |dk r"| j||}| j|| j|S )a Load a template from the loader. If a loader is configured this
method asks the loader for the template and returns a :class:`Template`.
If the `parent` parameter is not `None`, :meth:`join_path` is called
to get the real template name before loading.
The `globals` parameter can be used to provide template wide globals.
These variables are available in the context at render time.
If the template does not exist a :exc:`TemplateNotFound` exception is
raised.
.. versionchanged:: 2.4
If `name` is a :class:`Template` object it is returned from the
function unchanged.
N)rF r r r make_globals)rq rN r rk r= r= r> get_template) s
zEnvironment.get_templatec C sv |st dd| j|}xP|D ]H}t|tr0|S |dk rD| j||}y | j||S tk
rd Y q X q W t |dS )aw Works like :meth:`get_template` but tries a number of templates
before it fails. If it cannot find any of the templates, it will
raise a :exc:`TemplatesNotFound` exception.
.. versionadded:: 2.3
.. versionchanged:: 2.4
If `names` contains a :class:`Template` object it is returned
from the function unchanged.
z0Tried to select from an empty list of templates.)messageN)r r rF r r r r )rq namesr rk rN r= r= r> select_template@ s
zEnvironment.select_templatec C s4 t |tr| j|||S t |tr&|S | j|||S )zDoes a typecheck and dispatches to :meth:`select_template`
if an iterable of template names is given, otherwise to
:meth:`get_template`.
.. versionadded:: 2.3
)rF r, r r r )rq Ztemplate_name_or_listr rk r= r= r> get_or_select_template[ s
z"Environment.get_or_select_templatec C s* | j |}|p| j}|j| | j||dS )zuLoad a template from a string. This parses the source given and
returns a :class:`Template` object.
N)r template_class from_coder )rq r rk r clsr= r= r> r j s
zEnvironment.from_stringc C s |s
| j S t| j f|S )z Return a dict for the globals.)rk rC )rq dr= r= r> r r s zEnvironment.make_globals)NNNN)NN)NN)NN)NN)NN)F)NNFF)T)NNr NTF)NN)NFN)NN)NN)NN)NN)<__name__
__module__ __qualname____doc__Z sandboxedr r r: r r r Zcode_generator_classr Z
context_classr r r r r r
r r r
r r r r rs ru rz r% r propertyr r r r r r r r( r r r r r r r r r r r r r r r r r r r r= r= r= r> r9 q s y 6 %
&
-
]
r9 c @ s e Zd ZdZeeeeee e
e e e
eef dedddfddZed)ddZed d
Zed d Zd
d Zdd Zdd Zdd Zdd Zd*ddZd+ddZ d,dd Z e d d Z e d d Z!d!d" Z"e d#d$ Z#e d%d& Z$d'd( Z%dS )-r a The central template object. This class represents a compiled template
and is used to evaluate it.
Normally the template object is generated from an :class:`Environment` but
it also has a constructor that makes it possible to create a template
instance directly using the constructor. It takes the same arguments as
the environment constructor but it's not possible to specify a loader.
Every template object has a few methods and members that are guaranteed
to exist. However it's important that a template object should be
considered immutable. Modifications on the object are not supported.
Template objects created from the constructor rather than an environment
do have an `environment` attribute that points to a temporary environment
that is probably shared with other templates created with the constructor
and compatible settings.
>>> template = Template('Hello {{ name }}!')
>>> template.render(name='John Doe') == u'Hello John Doe!'
True
>>> stream = template.stream(name='John Doe')
>>> next(stream) == u'Hello John Doe!'
True
>>> next(stream)
Traceback (most recent call last):
...
StopIteration
TNFc C sD t |||||||| |
| | |
t|||||d ddd |}|j|| dS )Nr F)r )r? frozensetr )r r rX r] rY r^ rZ r_ r` ra rb rc r[ rd rH re rV rf rg ro r< r= r= r> r} s zTemplate.__new__c C s. ||j d}t|| | j|||}||_|S )zCreates a template object from compiled code and the globals. This
is used by the loaders and environment to create a template object.
)rG __file__) co_filenamer _from_namespace _uptodate)r rG r rk Zuptodate namespacer r= r= r> r s
zTemplate.from_codec C s | j |||S )zCreates a template object from a module. This is used by the
module loader to create a template object.
.. versionadded:: 2.4
)r )r rG Z module_dictrk r= r= r> from_module_dict s zTemplate.from_module_dictc C sh t j| }||_||_|d |_|d |_|d |_|d |_d |_|d |_ d |_
||d< ||d< |S )NrN r blocksroot
debug_inforG Z__jinja_template__) r| r} rG rk rN r r
root_render_func_module _debug_infor
)r rG r rk tr= r= r> r s
zTemplate._from_namespacec O sJ t ||}yt| j| j|S tk
r: tj }Y nX | jj|dS )a This method accepts the same arguments as the `dict` constructor:
A dict, a dict subclass or some keyword arguments. If no arguments
are given the context will be empty. These two calls do the same::
template.render(knights='that say nih')
template.render({'knights': 'that say nih'})
This will return the rendered template as unicode string.
T) rC r& r r rL r r rG r )rq r; r varsr r= r= r> render s
zTemplate.renderc O s t ddS )a. This works similar to :meth:`render` but returns a coroutine
that when awaited returns the entire rendered template string. This
requires the async feature to be enabled.
Example usage::
await template.render_async(knights='that say nih; asynchronously')
z8This feature is not available for this version of PythonN)NotImplementedError)rq r; r r= r= r> render_async s
zTemplate.render_asyncc O s t | j||S )z[Works exactly like :meth:`generate` but returns a
:class:`TemplateStream`.
)TemplateStreamr )rq r; r r= r= r> r s zTemplate.streamc o sd t ||}y$x | j| j|D ]
}|V q W W n tk
rJ tj }Y nX dS | jj|dV dS )aj For very large templates it can be useful to not render the whole
template at once but evaluate each statement after another and yield
piece for piece. This method basically does exactly that and returns
a generator that yields one item after another as unicode strings.
It accepts the same arguments as :meth:`render`.
NT)rC r r rL r r rG r )rq r; r r Zeventr r= r= r> r s
zTemplate.generatec O s t ddS )zsAn async version of :meth:`generate`. Works very similarly but
returns an async iterator instead.
z8This feature is not available for this version of PythonN)r )rq r; r r= r= r> generate_async s zTemplate.generate_asyncc C s t | j| j| j||| j|S )a^ Create a new :class:`Context` for this template. The vars
provided will be passed to the template. Per default the globals
are added to the context. If shared is set to `True` the data
is passed as it to the context without adding the globals.
`locals` can be a dict of local variables for internal usage.
)r rG rN r
rk )rq r r: r{ r= r= r> r s zTemplate.new_contextc C s t | | j|||S )aJ This method works like the :attr:`module` attribute when called
without arguments but it will evaluate the template on every call
rather than caching it. It's also possible to provide
a dict which is then used as context. The arguments are the same
as for the :meth:`new_context` method.
)TemplateModuler )rq r r: r{ r= r= r> make_module* s zTemplate.make_modulec C s t ddS )zAs template module creation can invoke template code for
asynchronous exections this method must be used instead of the
normal :meth:`make_module` one. Likewise the module attribute
becomes unavailable in async mode.
z8This feature is not available for this version of PythonN)r )rq r r: r{ r= r= r> make_module_async3 s zTemplate.make_module_asyncc C s" | j d k r| j S | j | _ }|S )N)r r )rq r r= r= r> _get_default_module= s
z Template._get_default_modulec C s | j S )a The template as module. This is used for imports in the
template runtime but is also useful if one wants to access
exported template variables from the Python layer:
>>> t = Template('{% macro foo() %}42{% endmacro %}23')
>>> str(t.module)
'23'
>>> t.module.foo() == u'42'
True
This attribute is not available if async mode is enabled.
)r )rq r= r= r> moduleD s zTemplate.modulec C s( x"t | jD ]\}}||kr |S q W dS )zrReturn the source line number of a line number in the
generated bytecode as they are not in sync.
r )reversedr )rq r Z
template_lineZ code_liner= r= r> get_corresponding_linenoT s z!Template.get_corresponding_linenoc C s | j dkrdS | j S )z?If this variable is `False` there is a newer version available.NT)r
)rq r= r= r> r ] s
zTemplate.is_up_to_datec C s dd | j jdD S )zThe debug info mapping.c S s g | ]}t tt|jd qS )=)tupler* intsplit).0r r= r= r>
g s z'Template.debug_info..&)r r$ )rq r= r= r> r d s zTemplate.debug_infoc C s2 | j d krdt| }n
t| j }d| jj|f S )Nz memory:%xz<%s %s>)rN idreprr~ r )rq rN r= r= r> __repr__j s
zTemplate.__repr__)N)NFN)NFN)NFN)&r r r r r r r r r r
r r r
r r r r r} classmethodr r r r r r r r r r r r( r r r r r r r* r= r= r= r> r y sJ
r c @ s2 e Zd ZdZd ddZdd Zdd Zd d
ZdS ) r zRepresents an imported template. All the exported names of the
template are available as attributes on this object. Additionally
converting it into an unicode- or bytestrings renders the contents.
Nc C sH |d kr&|j jrtdt|j|}|| _| jj|j |j | _
d S )NzuAsync mode requires a body stream to be passed to a template module. Use the async methods of the API you are using.) rG rp RuntimeErrorr r _body_streamr rt Z get_exportedrN r )rq r r Z body_streamr= r= r> rs y s zTemplateModule.__init__c C s t t| jS )N)r$ r& r- )rq r= r= r> __html__ s zTemplateModule.__html__c C s
t | jS )N)r& r- )rq r= r= r> __str__ s zTemplateModule.__str__c C s2 | j d krdt| }n
t| j }d| jj |f S )Nz memory:%xz<%s %s>)r r( r) r~ )rq rN r= r= r> r* s
zTemplateModule.__repr__)N)r r r r rs r. r/ r* r= r= r= r> r r s
r c @ s e Zd ZdZdd Zdd ZdS )r zThe :meth:`jinja2.Environment.compile_expression` method returns an
instance of this object. It encapsulates the expression-like access
to the template with an expression it wraps.
c C s || _ || _d S )N) _template_undefined_to_none)rq r r r= r= r> rs s zTemplateExpression.__init__c O sD | j jt||}t| j j| |jd }| jr@t|tr@d }|S )NrI ) r0 r rC r' r r r1 rF r )rq r; r r r r= r= r> __call__ s
zTemplateExpression.__call__N)r r r r rs r2 r= r= r= r> r s r c @ sL e Zd ZdZdd ZdddZdd Zd
d Zdd
dZdd Z dd Z
dS )r a A template stream works pretty much like an ordinary python generator
but it can buffer multiple items to reduce the number of total iterations.
Per default the output is unbuffered which means that for every unbuffered
instruction in the template one unicode string is yielded.
If buffering is enabled with a buffer size of 5, five items are combined
into a new unicode string. This is mainly useful if you are streaming
big templates to a client via WSGI which flushes after each iteration.
c C s || _ | j d S )N)_gendisable_buffering)rq genr= r= r> rs s zTemplateStream.__init__Nstrictc
s d}t |tr( dkrd t|d}d}zT dk rH fdd| D }n| }t|drb|j| nx|D ]}|j| qhW W d|r|j X dS ) a! Dump the complete stream into a file or file-like object.
Per default unicode strings are written, if you want to encode
before writing specify an `encoding`.
Example usage::
Template('Hello {{ name }}!').stream(name='foo').dump('hello.html')
FNzutf-8r Tc 3 s | ]}|j V qd S )N)r )r% r )encodingerrorsr= r> s z&TemplateStream.dump..
writelines)rF r, r rv r: r r )rq fpr7 r8 r iterableitemr= )r7 r8 r> dump s
zTemplateStream.dumpc C s t t| j| _d| _dS )z Disable the output buffering.FN)r nextr3 _nextbuffered)rq r= r= r> r4 s z TemplateStream.disable_bufferingc c s~ g }d}|j }xjy0x*||k r _buffered_generator s
z"TemplateStream._buffered_generator c C s, |dkrt dd| _tt| j|| _dS )z enable_buffering s z TemplateStream.enable_bufferingc C s | S )Nr= )rq r= r= r> __iter__ s zTemplateStream.__iter__c C s | j S )N)r@ )rq r= r= r> __next__ s zTemplateStream.__next__)Nr6 )rF ) r r r r rs r> r4 rE rH rI rJ r= r= r= r> r s
r )Qr r r r functoolsr r Zjinja2r Zjinja2.defaultsr r r r r r
r r r
r r r r r r r Z jinja2.lexerr r Z
jinja2.parserr Z jinja2.nodesr Zjinja2.compilerr r Zjinja2.runtimer r r Zjinja2.exceptionsr r r r! Z jinja2.utilsr" r# r$ r% r& r' r( r) Zjinja2._compatr* r+ r, r- r. r/ r0 r1 r2 r3 r4 r6 r r? rA rE rK rQ r\ r| r9 r r r r r r= r= r= r>
sJ H (4
z U