3
U'íc7î ã @ s d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z ddlm
Z
ddlm Z ddl m
Z
ddlmZ d d
lmZ d d lmZ d d lmZ d d
lmZ d dlmZ d dlmZ d dlmZ d dlmZ d dlmZ d dlm Z d dlm Z d dlm Z d dlm Z d dlm Z d dlm!Z! d dlm"Z" d dlm#Z# d dlm$Z$ d d lm%Z% d d l&m'Z' d d l&m(Z( d d l&m)Z) d d l&m*Z* d d!l&m+Z+ d d"l,m-Z- d d#l,m.Z. d d$l,m/Z/ d d%lm0Z0 d d&l1m2Z2 d d'l3m4Z4 d d(l3m5Z5 d d)l3m6Z6 d d*l7m8Z8 d d+l7m9Z9 d d,l7m:Z: d d-l7m;Z; d d.l7m<Z< d d/l7m=Z= d d0l7m>Z> ej?r|ddl@ZAd d1lBmCZC d d2lDmEZE d d3lFmGZG ejHd4d5d6ZIe d7d8ejJeI ejKeId9d:d;ZLeMejNejOejPejQeRf d<f d=d>d?ZSejNejO ejNejOejPejQeRf d<f d@dAdBZTd5ejUejVeRejJdC f ejWeRdCf dDdEdFZXd5d5dGdHdIZYG dJd5 d5ZZG dKd< d<Z[G dLdM dMZ\G dNdO dOZ]G dPdQ dQZ^e[eZ__dS )RzKClasses for managing templates and their runtime and compile time
options.
é N)ÚChainMap)Ú lru_cache)Úpartial)Úreduce)ÚCodeType)ÚMarkupé )Únodes)Ú
CodeGenerator)Úgenerate)ÚBLOCK_END_STRING)ÚBLOCK_START_STRING)ÚCOMMENT_END_STRING)ÚCOMMENT_START_STRING)ÚDEFAULT_FILTERS)ÚDEFAULT_NAMESPACE)ÚDEFAULT_POLICIES)Ú
DEFAULT_TESTS)ÚKEEP_TRAILING_NEWLINE)ÚLINE_COMMENT_PREFIX)ÚLINE_STATEMENT_PREFIX)Ú
LSTRIP_BLOCKS)ÚNEWLINE_SEQUENCE)Ú TRIM_BLOCKS)ÚVARIABLE_END_STRING)ÚVARIABLE_START_STRING)ÚTemplateNotFound)ÚTemplateRuntimeError)ÚTemplatesNotFound)ÚTemplateSyntaxError)ÚUndefinedError)Ú get_lexer)ÚLexer)Ú TokenStream)Ú EvalContext)ÚParser)ÚContext)Ú new_context)Ú Undefined)Ú_PassArg)Úconcat)Úconsume)Ú
import_string)Ú internalcode)ÚLRUCache)Úmissing)Ú
BytecodeCache)Ú Extension)Ú
BaseLoaderÚ
_env_boundÚ Environment)Zboundé
)Úmaxsize)ÚclsÚargsÚreturnc G s | | }d|_ |S )a Return a new spontaneous environment. A spontaneous environment
is used for templates created directly rather than through an
existing environment.
:param cls: Environment class to create.
:param args: Positional arguments passed to environment.
T)Úshared)r7 r8 Úenv© r< ú4/tmp/pip-build-gk9425m9/Jinja2/jinja2/environment.pyÚget_spontaneous_environmentC s r> ÚTemplate)Úsizer9 c C s | dkr dS | dk ri S t | S )z*Return the cache class for the given size.r N)r. )r@ r< r< r= Ú create_cacheQ s
rA )Úcacher9 c C s& | dkr dS t | tkr i S t| jS )z(Create an empty copy of the given cache.N)ÚtypeÚdictr. Úcapacity)rB r< r< r= Ú
copy_cache^ s
rF r1 )Ú environmentÚ
extensionsr9 c C sD i }x:|D ]2}t |tr.tjtjd t|}|| ||j< q
W |S )zuLoad the extensions from the list and bind it to the environment.
Returns a dict of instantiated extensions.
r1 )Ú
isinstanceÚstrÚtÚcastÚTyper, Ú
identifier)rG rH ÚresultÚ extensionr< r< r= Úload_extensionsk s
rQ )rG r9 c C sP t | jtstd| j| j ko,| jkn s:td| jdksLtd| S )z*Perform a sanity check on the environment.z5'undefined' must be a subclass of 'jinja2.Undefined'.z<block, variable and comment start strings must be different.ú
ú
Ú
z8'newline_sequence' must be one of '\n', '\r\n', or '\r'.> rT rS rR )Ú
issubclassÚ undefinedr( ÚAssertionErrorÚblock_start_stringÚvariable_start_stringÚcomment_start_stringÚnewline_sequence)rG r< r< r= Ú_environment_config_check} s r\ c @ sH e Zd ZU dZdZdZdZejd dZ e
Z ej d e
Zej e
ej d eeeeeeeeeeeef de dddddddfe e e e e e eje eje e e de ej ej e ej d f e ej e ejej!d
ej"f ej e ej!eje ge f f ejd e#e ejd e d
ddZ$ej e ej d f ddddZ%ej"ddddZ&e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'fe e e e e e eje eje e e ej ej e ej d f e ej e ejej!d
ej"f ej e ej!eje ge f f ejd e#e ejd d dddZ(e)e*dddZ+ej,d dd d Z-ej"ej e ej"f ej ej"e f d d d Z.ej"e ej"d!d"d#Z/ej e e f ej"ejej ej" ejej0e ej"f eje
eje1 e ej"d$d%d&Z2die ej"ejej ej" ejej0e ej"f eje
eje1 ej"d'd(d)Z3dje ej"ejej ej" ejej0e ej"f eje
eje1 ej"d'd*d+Z4e5dke eje eje e6j7d,d-d.Z8e eje eje e6j7d,d/d0Z9dle eje eje ej,ej:e#e e f d,d1d2Z;dme eje eje e d,d3d4Z<dne eje eje eje e=d5d6d7Z>doe6j7eje eje e e d8d9d:Z?e e e@d;d<d=ZAeBjCdpej e e6j7f eje eje d>e e@d?d@dAZDeBjCdqej e e6j7f eje eje dBe e d?dCdAZDe5drej e e6j7f eje eje e e ej e e@f d?dDdAZDdse e dEdFdGdHZEdtej e eFjGf ejejHe ejej!e ge f eje ejej!e gdf e ddJdKdLZIduejejHe ejej!e ge f ejJe dMdNdOZKdveje dPdQdRdSZLe e e dTdUdVZMe5e ejej0e ej"f ddWdXdYZNe5dwej e df eje ejej0e ej"f ddZd[d\ZOe5dxejPej e df eje ejej0e ej"f dd]d^d_ZQe5dyej e dejJej e df f eje ejej0e ej"f dd`dadbZRdzej e e6j7f ejej0e ej"f ejej d ddcdddeZSejej0e ej"f ejTe ej"f dfdgdhZUdS ){r4 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 <jinja-extensions>`.
`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:`~markupsafe.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 using async functions and generators.
FNr
r? Ti z te.Literal['\n', '\r\n', '\r']r1 .r2 r0 )rX Úblock_end_stringrY Úvariable_end_stringrZ Úcomment_end_stringÚline_statement_prefixÚline_comment_prefixÚ trim_blocksÚ
lstrip_blocksr[ Úkeep_trailing_newlinerH Ú optimizedrV ÚfinalizeÚ
autoescapeÚloaderÚ
cache_sizeÚ auto_reloadÚbytecode_cacheÚ enable_asyncc C s || _ || _|| _|| _|| _|| _|| _|| _| | _|
| _ | | _
| | _ || _ || _
|| _|| _tj | _tj | _tj | _|| _t|| _|| _|| _t j | _ t | |
| _ || _ t!| d S )N)"rX r] rY r^ rZ r_ r` ra rb rc r[ rd rV re rf rg r ÚcopyÚfiltersr Útestsr Úglobalsrh rA rB rk rj r ZpoliciesrQ rH Úis_asyncr\ )ÚselfrX r] rY r^ rZ r_ r` ra rb rc r[ rd rH re rV rf rg rh ri rj rk rl r< r< r= Ú__init__# s6 %
zEnvironment.__init__)rP r9 c C s | j jt| |g dS )z\Adds an extension after the environment was created.
.. versionadded:: 2.5
N)rH ÚupdaterQ )rr rP r< r< r= Ú
add_extensiono s zEnvironment.add_extension)Ú
attributesr9 c K s0 x*|j D ] \}}t| |s
t| || q
W dS )zèAdd the items to the instance of the environment if they do not exist
yet. This is used by :ref:`extensions <writing-extensions>` to register
callbacks and configuration values without breaking inheritance.
N)ÚitemsÚhasattrÚsetattr)rr rv ÚkeyÚvaluer< r< r= Úextendv s
zEnvironment.extend)rX r] rY r^ rZ r_ r` ra rb rc rH re rV rf rg rh ri rj rk r9 c C sÜ t t }|d= |d= |d= tj| j}|jj| j d|_| |_x(|j D ] \}}|t
k rLt ||| qLW |t
k rt ||_
n t| j
|_
i |_x&| jj D ]\}}|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.
rr ri rH T)rD ÚlocalsÚobjectÚ__new__Ú __class__Ú__dict__rt Ú overlayedÚ linked_torw r/ ry rA rB rF rH ÚbindrQ r\ )rr rX r] rY r^ rZ r_ r` ra rb rc rH re rV rf rg rh ri rj rk r8 Úrvrz r{ r< r< r= Úoverlay s$ !
zEnvironment.overlay)r9 c C s t | S )z The lexer for this environment.)r! )rr r< r< r= Úlexer¹ s zEnvironment.lexerc C s t t| jj dd dS )z)Iterates over the extensions by priority.c S s | j S )N)Úpriority)Úxr< r< r= Ú<lambda>À s z-Environment.iter_extensions.<locals>.<lambda>)rz )ÚiterÚsortedrH Úvalues)rr r< r< r= Úiter_extensions¾ s zEnvironment.iter_extensions)ÚobjÚargumentr9 c 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.)r ÚnameN)ÚAttributeErrorÚ TypeErrorÚ LookupErrorrI rJ Ú ExceptionÚgetattrrV )rr r r Úattrr< r< r= Úgetitem s
zEnvironment.getitem)r Ú attributer9 c 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 string.
)r r N)r r r r rV )rr r r r< r< r= r Õ s
zEnvironment.getattr)r r{ r8 ÚkwargsÚcontextÚeval_ctxÚ is_filterr9 c C sP |r| j }d} n
| j}d} |j|}
|
d krd| d|d} t|try |j W n2 tk
r } z| d| d} W Y d d } ~ X nX t| |f|d k r |nf }|d k r²|ni }tj |
}
|
tj
krð|d krâtd| d |j d
| nV|
tj kr.|d kr |d k r|j
}nt| }|j d
| n|
tjkrF|j d
| |
||S ) NÚfilterÚtestzNo z named Ú.z (z-; did you forget to quote the callable name?)z Attempted to invoke a context z without context.r )rn ro ÚgetrI r( Ú_fail_with_undefined_errorr r r) Zfrom_objr ÚinsertZ eval_contextr r$ rG )rr r r{ r8 r r r r Zenv_mapÚ type_nameÚfuncÚmsgÚeZpass_argr< r< r= Ú_filter_test_commonâ s>
"
z Environment._filter_test_common)r r{ r8 r r r r9 c C s | j ||||||dS )a/ Invoke a filter on a value the same way the compiler does.
This might return a coroutine if 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
T)r¨ )rr r r{ r8 r r r r< r< r= Ú call_filter s zEnvironment.call_filterc C s | j ||||||dS )aÇ Invoke a test on a value the same way the compiler does.
This might return a coroutine if the test is running from an
environment in async mode and the test supports async execution.
It's your responsibility to await this if needed.
.. versionchanged:: 3.0
Tests support ``@pass_context``, etc. decorators. Added
the ``context`` and ``eval_ctx`` parameters.
.. versionadded:: 2.7
F)r¨ )rr r r{ r8 r r r r< r< r= Ú call_test- s zEnvironment.call_test)Úsourcer Úfilenamer9 c C s4 y| j |||S tk
r. | j|d Y nX 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 Jinja extensions <writing-extensions>`
this gives you a good overview of the node tree generated.
)r« N)Ú_parser Úhandle_exception)rr r« r r¬ r< r< r= ÚparseF s zEnvironment.parsec C s t | |||j S )z8Internal parsing function used by `parse` and `compile`.)r% r¯ )rr r« r r¬ r< r< r= r Z s zEnvironment._parsec C s> t |}y| jj|||S tk
r8 | j|d Y nX 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 <writing-extensions>`
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)rJ r Z tokeniterr r® )rr r« r r¬ r< r< r= Úlex` s
zEnvironment.lexc s t fdd| j t|S )zäPreprocesses 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)Úsr§ )r¬ r r< r= r s z(Environment.preprocess.<locals>.<lambda>)r r rJ )rr r« r r¬ r< )r¬ r r= r± u s
zEnvironment.preprocess)r« r r¬ Ústater9 c 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_streamrI r# )rr r« r r¬ r³ ÚstreamÚextr< r< r= Ú _tokenize
s
zEnvironment._tokenize)r« r r¬ Ú
defer_initr9 c C s t || |||| jdS )z|Internal hook that can be overridden to hook a different generate
method in.
.. versionadded:: 2.5
)r¸ re )r re )rr r« r r¬ r¸ r< r< r= Ú _generate s zEnvironment._generate)r« r¬ r9 c C s t ||dS )z{Internal hook that can be overridden to hook a different compile
method in.
.. versionadded:: 2.5
Úexec)Úcompile)rr r« r¬ r< r< r= Ú_compile¯ s zEnvironment._compilezte.Literal[False])r« r r¬ Úrawr¸ r9 c C s d S )Nr< )rr r« r r¬ r½ r¸ r< r< r= r» · s zEnvironment.compilezte.Literal[True]c C s d S )Nr< )rr r« r r¬ r½ r¸ r< r< r= r» Â s c C sx d}yNt |tr"|}| j|||}| j||||d}|r<|S |dkrHd}| j||S tk
rr | j|d Y nX 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
<template>)r« )rI rJ r r¹ r¼ r r® )rr r« r r¬ r½ r¸ Z source_hintr< r< r= r» Í s
ÚTemplateExpression)r« Úundefined_to_noner9 c
C s t | |dd}y2|j }|jjs4td|jjjdd|j| W n tk
r` | j|d Y nX t j
t j dd|dd g}| j t 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
Úvariable)r³ zchunk after expressionN)r« rO Ústorer )Úlineno)r% Zparse_expressionrµ Zeosr Úcurrentr Zset_environmentr® r ÚAssignÚNameÚ from_stringr? r¾ )rr r« r¿ ÚparserÚexprÚbodyÚtemplater< r< r= Úcompile_expression÷ s z Environment.compile_expressionÚdeflated)ÚtargetrH Ú filter_funcÚzipÚ log_functionÚ
ignore_errorsr9 c s ddl m} |dkr$tdddd}|dk s0t| jdk sBtdttdd fd d
}dk r¦d d lm} m m}
m } | d
t
|
| d |d n$t j j
s¼t j |d z°xª| j||D ]} | jj| | \}
}}y| j|
| |dd}W nB tk
rJ } z$|s$ |d| d| wÚW Y dd}~X nX |j| }||| |d| d| qÚW W drj X |d dS )a3 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.
.. versionadded:: 2.4
r )Ú ModuleLoaderN)r r9 c S s d S )Nr< )r r< r< r= rÐ B s z3Environment.compile_templates.<locals>.log_functionzNo loader configured.)r¬ Údatar9 c
sT r | }d|_ j|| n0ttjj| d}|j|jd W d Q R X d S )Nií é ÚwbÚutf8i í)Ú
external_attrÚwritestrÚopenÚosÚpathÚjoinÚwriteÚencode)r¬ rÓ ÚinfoÚf)ÚZipInforÍ rÏ Úzip_filer< r= Ú
write_fileH s z1Environment.compile_templates.<locals>.write_filer )ÚZipFilerá Ú ZIP_DEFLATEDÚ
ZIP_STOREDÚw)rÌ ZstoredzCompiling into Zip archive zCompiling into folder TzCould not compile "z": z
Compiled "z" as z Finished compiling templates)ÚloadersrÒ rJ rW rh Úzipfilerä rá rå ræ rD rÚ rÛ ÚisdirÚmakedirsÚlist_templatesÚ
get_sourcer» r Zget_module_filenameÚclose)rr rÍ rH rÎ rÏ rÐ rÑ rÒ rã rä rå ræ r r« r¬ Ú_Úcoder§ r< )rá rÍ rÏ râ r= Úcompile_templates$ s<
z Environment.compile_templates)rH rÎ r9 c sf | j dk std| j j } dk rHdk r4tdttd fdd dk rbfdd|D }|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
NzNo loader configured.z<either extensions or filter_func can be passed, but not both)r r9 c s d| ko| j ddd kS )Nr r )Úrsplit)r )rH r< r= rÎ s z/Environment.list_templates.<locals>.filter_funcc s g | ]} |r|qS r< r< )Ú.0r )rÎ r< r= ú
<listcomp> s z.Environment.list_templates.<locals>.<listcomp>)rh rW rì r rJ Úbool)rr rH rÎ Únamesr< )rH rÎ r= rì r s
zEnvironment.list_templatesz te.NoReturn)r« r9 c C s ddl m} ||ddS )zException handling helper. This is used internally to either raise
rewritten exceptions or return a rendered traceback for the template.
r )Úrewrite_traceback_stack)r« N)Údebugr÷ )rr r« r÷ r< r< r= r® s z Environment.handle_exception)rÊ Úparentr9 c 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< )rr rÊ rù r< r< r= Ú join_path s
zEnvironment.join_path)r rp r9 c C s | j d krtdtj| j |f}| jd k rb| jj|}|d k rb| j sN|jrb|r^|jj | |S | j j
| || j |}| jd k r|| j|< |S )Nz(no loader for this environment specified) rh r ÚweakrefÚrefrB r¡ rj Ú
is_up_to_daterp rt ÚloadÚ make_globals)rr r rp Ú cache_keyrÊ r< r< r= Ú_load_template« s
zEnvironment._load_template)r rù rp r9 c C s. t |tr|S |dk r"| j||}| j||S )aÐ Load a template by name with :attr:`loader` and return a
:class:`Template`. If the template does not exist a
:exc:`TemplateNotFound` exception is raised.
:param name: Name of the template to load.
:param parent: The name of the parent template importing this
template. :meth:`join_path` can be used to implement name
transformations with this.
:param globals: Extend the environment :attr:`globals` with
these extra variables available for all renders of this
template. If the template has already been loaded and
cached, its globals are updated with any new items.
.. versionchanged:: 3.0
If a template is loaded from cache, ``globals`` will update
the template's globals instead of ignoring the new values.
.. versionchanged:: 2.4
If ``name`` is a :class:`Template` object it is returned
unchanged.
N)rI r? rú r )rr r rù rp r< r< r= Ú get_templateÄ s
zEnvironment.get_template)rö rù rp r9 c
C s t |tr|j |s tddxT|D ]L}t |tr8|S |dk rL| j||}y | j||S ttfk
rp Y q&X q&W t|dS )aø Like :meth:`get_template`, but tries loading multiple names.
If none of the names can be loaded a :exc:`TemplatesNotFound`
exception is raised.
:param names: List of template names to try loading in order.
:param parent: The name of the parent template importing this
template. :meth:`join_path` can be used to implement name
transformations with this.
:param globals: Extend the environment :attr:`globals` with
these extra variables available for all renders of this
template. If the template has already been loaded and
cached, its globals are updated with any new items.
.. versionchanged:: 3.0
If a template is loaded from cache, ``globals`` will update
the template's globals instead of ignoring the new values.
.. versionchanged:: 2.11
If ``names`` is :class:`Undefined`, an :exc:`UndefinedError`
is raised instead. If no templates were found and ``names``
contains :class:`Undefined`, the message is more helpful.
.. versionchanged:: 2.4
If ``names`` contains a :class:`Template` object it is
returned unchanged.
.. versionadded:: 2.3
z0Tried to select from an empty list of templates.)ÚmessageN) rI r( r¢ r r? rú r r r )rr rö rù rp r r< r< r= Úselect_templateç s #
zEnvironment.select_template)Útemplate_name_or_listrù rp r9 c C s8 t |ttfr | j|||S t |tr*|S | j|||S )z¤Use :meth:`select_template` if an iterable of template names
is given, or :meth:`get_template` if one name is given.
.. versionadded:: 2.3
)rI rJ r( r r? r )rr r rù rp r< r< r= Úget_or_select_template s
z"Environment.get_or_select_template)r« rp Útemplate_classr9 c C s* | j |}|p| j}|j| | j||dS )aý Load a template from a source string without using
:attr:`loader`.
:param source: Jinja source to compile into a template.
:param globals: Extend the environment :attr:`globals` with
these extra variables available for all renders of this
template. If the template has already been loaded and
cached, its globals are updated with any new items.
:param template_class: Return an instance of this
:class:`Template` class.
N)rÿ r Ú from_coder» )rr r« rp r Zgsr7 r< r< r= rÆ 1 s
zEnvironment.from_string)Údr9 c C s |dkr i }t || jS )aS Make the globals map for a template. Any given template
globals overlay the environment :attr:`globals`.
Returns a :class:`collections.ChainMap`. This allows any changes
to a template's globals to only affect that template, while
changes to the environment's globals are still reflected.
However, avoid modifying any globals after a template is loaded.
:param d: Dict of template-specific globals.
.. versionchanged:: 3.0
Use :class:`collections.ChainMap` to always prevent mutating
environment globals.
N)r rp )rr r r< r< r= rÿ F s zEnvironment.make_globals)NNNN)NNNN)NN)NN)NN)NN)F)NNFF)NN.F)NNFF)T)NNrÌ NT)NN)N)NN)NN)NN)NN)VÚ__name__Ú
__module__Ú __qualname__Ú__doc__Z sandboxedr r rK ÚOptionalr: r
Zcode_generator_classrM r& Z
context_classr r
r r r r r r r r r r r r( rJ rõ ÚSequenceÚUnionÚCallableÚAnyÚintrs ru r| r/ r Úpropertyr" r ÚIteratorr r r ÚMappingr$ r¨ r© rª r- r r? r¯ r ÚTupler° r± r# r· r¹ r r¼ ÚtypingZoverloadr» rË rÚ ÚPathLikeÚ
Collectionrñ ÚListrì r® rú r r ÚIterabler r rÆ ÚMutableMappingrÿ r< r< r< r= r4 s"
x
5 % 1 < < $ $ $#. PH $! * 00 < 2c @ s¶ e Zd ZU dZeZeje eej e
ej f ej
e
ej
e
eje
ejegeje
f f ejegeje
f ej
d e
ej
ejg ef eee e e e e e!e"e#e$e%f de&dddfej'e
e(j)f e
e
e
e
e
e
ej
e
ej
e
eedeej*ej'e
ejd f eeje& ej
ejdej f ej'eejej
e
gef f eej d d
d Z+e,d9ee-ej e
ej f ej
ejg ef d d d
dZ.e,eej e
ej f ej e
ej f d dddZ/e,eej e
ej f ej e
ej f d dddZ0ej ej e
dddZ1ej ej e
dddZ2ej ej dddd Z3ej ej eje
dd d Z4ej ej ej5e
dd d Z6d:ej
eje
ej f eej
ej7e
ej f ed!d"d#Z8d;ej
eje
ej f eej
ej7e
ej f dd!d$d%Z9d<ej
eje
ej f eej
ej7e
ej f dd!d&d'Z:e;d=ej
e dd(d)d*Z<d>ej
e dd(d+d,Z=e>dd-d.d/Z?e@e@d0d1d2ZAe>ed-d3d4ZBe>ejCejDe@e@f d-d5d6ZEe
d-d7d8ZFdS )?r? ao A compiled template that can be rendered.
Use the methods on :class:`Environment` to create or load templates.
The environment is used to configure how templates are compiled and
behave.
It is also possible to create a template object directly. This is
not usually recommended. The constructor takes most of the same
arguments as :class:`Environment`. All templates created with the
same environment arguments share the same ephemeral ``Environment``
instance behind the scenes.
A template object should be considered immutable. Modifications on
the object are not supported.
ÚTemplateModuleTNFz te.Literal['\n', '\r\n', '\r']r1 .)r« rX r] rY r^ rZ r_ r` ra rb rc r[ rd rH re rV rf rg rl r9 c C sH t | j|||||||| |
| | |
t|||||d ddd |}|j|| dS )Nr F)r )r> Úenvironment_classÚ frozensetrÆ )r7 r« rX r] rY r^ rZ r_ r` ra rb rc r[ rd rH re rV rf rg rl r; r< r< r= r | s2 zTemplate.__new__)rG rð rp Úuptodater9 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)r7 rG rð rp r! Ú namespacer
r< r< r= r s
zTemplate.from_code)rG Ú module_dictrp r9 c 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$ )r7 rG r' rp r< r< r= Úfrom_module_dict¾ s zTemplate.from_module_dict)rG r& rp r9 c C sh t j| }||_||_|d |_|d |_|d |_|d |_d |_|d |_ d |_
||d< ||d< |S )Nr r" ÚblocksÚrootÚ
debug_inforG Z__jinja_template__) r~ r rG rp r r¬ r) Úroot_render_funcÚ_moduleÚ _debug_infor% )r7 rG r& rp rK r< r< r= r$ Ì s
zTemplate._from_namespace)r8 r r9 c O sº | j jrxddl}d}tjdk r(|j }n.y |j }W n tk
rT |j }d}Y nX z|j | j
||S |rv|j X | j t
||}yt| j|S tk
r´ | j j Y nX 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 a string.
r NFé é T)r/ r0 )rG rq ÚasyncioÚsysÚ version_infoÚget_event_loopZget_running_loopÚ RuntimeErrorZnew_event_loopÚrun_until_completeÚ render_asyncrî r' rD r* r, r r® )rr r8 r r1 rî ÚloopÚctxr< r< r= Úrenderè s&
zTemplate.renderc Ï sb | j jstd| jt||}y"tdd | j|2 dH I dH S tk
r\ | j j S X dS )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')
z8The environment was not created with async mode enabled.c
Ó s. g | y 3 d H }W n
t k
s"X |q Y S )N)ÚStopAsyncIteration)ró Únr< r< r= rô s z)Template.render_async.<locals>.<listcomp>N) rG rq r5 r' rD r* r, r r® )rr r8 r r9 r< r< r= r7
s "zTemplate.render_asyncÚTemplateStreamc O s t | j||S )z[Works exactly like :meth:`generate` but returns a
:class:`TemplateStream`.
)r= r )rr r8 r r< r< r= rµ " s zTemplate.streamc / s° j jrfddl}tjt d fdd }tjdk rL|j }|j | }n |j
| }|E dH dS j t }yj
|E dH W n tk
rª j j V Y nX dS ) ab 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 strings.
It accepts the same arguments as :meth:`render`.
r N)r9 c s dd j 2 d H I d H S )Nc
Ó s. g | y 3 d H }W n
t k
s"X |q Y S )N)r; )ró r r< r< r= rô 4 s z6Template.generate.<locals>.to_list.<locals>.<listcomp>)Úgenerate_asyncr< )r8 r rr r< r= Úto_list3 s z"Template.generate.<locals>.to_listr/ r0 )r/ r0 )rG rq r1 rK r rJ r2 r3 r4 r6 Úrunr' rD r, r r® )rr r8 r r1 r? r8 Úoutr9 r< )r8 r rr r= r ( s
zTemplate.generatec O s | j jstd| jt||}y@x:| j|2 dH y 3 dH }W n
tk
sRX |V q2 Y W W n tk
r | j j V Y nX dS )zsAn async version of :meth:`generate`. Works very similarly but
returns an async iterator instead.
z8The environment was not created with async mode enabled.N) rG rq r5 r' rD r, r; r r® )rr r8 r r9 Úeventr< r< r= r> F s (zTemplate.generate_async)Úvarsr: r} r9 c 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 is to the context without adding the globals.
`locals` can be a dict of local variables for internal usage.
)r' rG r r) rp )rr rC r: r} r< r< r= r' Y s
zTemplate.new_contextc C s | j |||}t| |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.
)r' r )rr rC r: r} r9 r< r< r= Ú make_modulej s zTemplate.make_modulec à s4 | j |||}t| |dd | j|2 dH I dH S )zûAs template module creation can invoke template code for
asynchronous executions this method must be used instead of the
normal :meth:`make_module` one. Likewise the module attribute
becomes unavailable in async mode.
c
Ó s. g | y 3 d H }W n
t k
s"X |q Y S )N)r; )ró r r< r< r= rô s z.Template.make_module_async.<locals>.<listcomp>N)r' r r, )rr rC r: r} r9 r< r< r= Úmake_module_asyncy s zTemplate.make_module_async)r9 r9 c s^ | j jrtd dk rD j| jj }|rD| j fdd|D S | jdkrX| j | _| jS )aO If a context is passed in, this means that the template was
imported. Imported templates have access to the current
template's globals by default, but they can only be accessed via
the context during runtime.
If there are new globals, we need to create a new module because
the cached module is already rendered and will not have access
to globals from the current context. This new module is not
cached because the template can be imported elsewhere, and it
should have access to only the current template's globals.
z&Module is not available in async mode.Nc s i | ]} j | |qS r< )rù )ró Úk)r9 r< r= ú
<dictcomp> s z0Template._get_default_module.<locals>.<dictcomp>)rG rq r5 Ú globals_keysrp ÚkeysrD r- )rr r9 rI r< )r9 r= Ú_get_default_module s
z Template._get_default_modulec sZ d k r: j | jj }|r:| j fdd|D I d H S | jd krT| j I d H | _| jS )Nc s i | ]} j | |qS r< )rù )ró rF )r9 r< r= rG « s z6Template._get_default_module_async.<locals>.<dictcomp>)rH rp rI rE r- )rr r9 rI r< )r9 r= Ú_get_default_module_async¤ s
z"Template._get_default_module_async)r9 c 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.
)rJ )rr r< r< r= Úmodule² s zTemplate.module)r r9 c 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+ )rr r Z
template_lineZ code_liner< r< r= Úget_corresponding_lineno 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% )rr r< r< r= rý Ë s
zTemplate.is_up_to_datec C s | j r dd | j jdD S g S )zThe debug info mapping.c S s g | ]}t tt|jd qS )ú=)ÚtupleÚmapr Úsplit)ró r r< r< r= rô × s z'Template.debug_info.<locals>.<listcomp>ú&)r. rR )rr r< r< r= r+ Ò s zTemplate.debug_infoc C s> | j d kr dt| d}n
t| j }dt| j d| dS )Nzmemory:r ú<ú ú>)r ÚidÚreprrC r
)rr r r< r< r= Ú__repr__Ý s
zTemplate.__repr__)N)NFN)NFN)NFN)N)N)Gr
r r r
r4 r rK rM rG r rJ r rp r r r¬ ÚDictr 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 Ú classmethodr r r( r$ r: r7 rµ r Ú
AsyncIteratorr> r r' rD rE r- rJ rK r rL r rN rý r r r+ rY r< r< r< r= r? ] s
&
% , , ,
c @ s\ e Zd ZdZd
eeejeje ddddZ
e dddZ e dd d
Z
e dd d ZdS )r zÁRepresents an imported template. All the exported names of the
template are available as attributes on this object. Additionally
converting it into a string renders the contents.
N)rÊ r Ú body_streamr9 c C sH |d kr&|j jrtdt|j|}|| _| jj|j |j | _
d S )NztAsync mode requires a body stream to be passed to a template module. Use the async methods of the API you are using.) rG rq r5 Úlistr, Ú _body_streamr rt Z get_exportedr r
)rr rÊ r r] r< r< r= rs ë s zTemplateModule.__init__)r9 c C s t t| jS )N)r r* r_ )rr r< r< r= Ú__html__ÿ s zTemplateModule.__html__c C s
t | jS )N)r* r_ )rr r< r< r= Ú__str__ s zTemplateModule.__str__c C s> | j d kr dt| d}n
t| j }dt| j d| dS )Nzmemory:r rT rU rV )r
rW rX rC )rr r r< r< r= rY s
zTemplateModule.__repr__)N)r
r r r
r? r& rK r r rJ rs r r` ra rY r< r< r< r= r å s r c @ s@ e Zd ZdZeeddddZejejej ej dddZ
dS ) r¾ zÂThe :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.
N)rÊ r¿ r9 c C s || _ || _d S )N)Ú _templateÚ_undefined_to_none)rr rÊ r¿ r< r< r= rs s zTemplateExpression.__init__)r8 r r9 c O sD | j jt||}t| j j| |jd }| jr@t|tr@d }|S )NrO ) rb r' rD r+ r, rC rc rI r( )rr r8 r r r
r< r< r= Ú__call__ s
zTemplateExpression.__call__) r
r r r
r? rõ rs rK r r rd r< r< r< r= r¾
s r¾ c @ s¦ e Zd ZdZeje ddddZdejeej f ej
e ej
e dddd Z dd
d d Z e
eje d
ddZde
dd
ddZd d
ddZed
ddZdS )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 string is yielded.
If buffering is enabled with a buffer size of 5, five items are combined
into a new string. This is mainly useful if you are streaming
big templates to a client via WSGI which flushes after each iteration.
N)Úgenr9 c C s || _ | j d S )N)Ú_genÚdisable_buffering)rr re r< r< r= rs + s zTemplateStream.__init__Ústrict)ÚfpÚencodingÚerrorsr9 c
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 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 )rj rk r< r= ú <genexpr>G s z&TemplateStream.dump.<locals>.<genexpr>Ú
writelines)rI rJ rÙ rx rm rÝ rî )rr ri rj rk rî ÚiterableÚitemr< )rj rk r= Údump/ s
zTemplateStream.dump)r9 c C s t t| j| _d| _dS )z Disable the output buffering.FN)r Únextrf Ú_nextÚbuffered)rr r< r< r= rg T s z TemplateStream.disable_buffering)r@ r9 c c s~ g }d}|j }xjy0x*||k r<t| j}|| |r|d7 }qW W n tk
r\ |sXd S Y nX t|V |d d
= d}qW d S )Nr r )Úappendrq rf Ú
StopIterationr* )rr r@ ÚbufZc_sizeÚpushÚcr< r< r= Ú_buffered_generatorY s
z"TemplateStream._buffered_generatoré c C s, |dkrt dd| _tt| j|| _dS )z<Enable buffering. Buffer `size` items before yielding them.r zbuffer size too smallTN)Ú
ValueErrorrs r rq ry rr )rr r@ r< r< r= Úenable_bufferingl s z TemplateStream.enable_bufferingc C s | S )Nr< )rr r< r< r= Ú__iter__t s zTemplateStream.__iter__c C s | j S )N)rr )rr r< r< r= Ú__next__w s zTemplateStream.__next__)Nrh )rz )r
r r r
rK r rJ rs r ZIOr rp rg r ry r| r} r~ r< r< r< r= r= s r= )`r
rÚ r2 r rK rû Ú collectionsr Ú functoolsr r r Útypesr Z
markupsafer Ú r Úcompilerr
r Údefaultsr r
r r r r r r r r r r r r r r Ú
exceptionsr r r r r r r! r" r# r$ rÇ r% Zruntimer& r' r( Úutilsr) r* r+ r, r- r. r/ Z
TYPE_CHECKINGZtyping_extensionsÚteZbccacher0 r¶ r1 rè r2 ZTypeVarr3 rM r r> r r r r rü rJ rA rF r r rZ rQ r\ r4 r? r r¾ r= r r< r< r< r= Ú<module> s¤ *
* U (]