m 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.l7mZ> ej? rddl@ZAd d1lBmCZC d d2lDmEZE d d3lFmGZG ejH d4d56 ZI e d78 d9ejJ eI d:ejK d;eIfd< ZLd=eMd;ejN ejO ejP ejQ eRf d>f fd?ZSd@ejN ejO d;ejN ejO ejP ejQ eRf d>f fdAZTdBd5dCejU ejV eRejJ dD f d;ejW eRdDf fdEZXdOdFZY G dG d5 ZZ G dH d> Z[ G dI dJ Z\ G dK dL Z] G dM dN Z^e[eZ__ dS )PzKClasses 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) internalcodeLRUCache)missing)
BytecodeCache) Extension)
BaseLoader
_env_bound Environment)bound
)maxsizeclsargsreturnc | | }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)r; r< envs d/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/jinja2/environment.pyget_spontaneous_environmentrB C s #t*CCJ J sizeTemplatec @ | dk rdS | dk ri S t | S )z*Return the cache class for the given size.r Nr0 )rD s rA create_cacherG Q s, qyyt axx D>>rC cachec b | dS t | t u ri S t | j S )z(Create an empty copy of the given cache.N)typedictr1 capacity)rH s rA
copy_cacherM ^ s4
}t E{{d EN # ##rC environment
extensionsr4 c i }|D ]\}t |t r2t j t j d t | } || ||j < ]|S )zuLoad the extensions from the list and bind it to the environment.
Returns a dict of instantiated extensions.
r4 )
isinstancestrtcastTyper.
identifier)rN rO result extensions rA load_extensionsrY k sj F > > i % % Nqvk 2M)4L4LMMI'0y'='=y#$$ MrC c t | j t s
J d | j | j cxk r | j k s n J d | j dv s
J d | S )z*Perform a sanity check on the environment.z5'undefined' must be a subclass of 'jinja2.Undefined'.z
z8'newline_sequence' must be one of '\n', '\r\n', or '\r'.)
issubclass undefinedr* block_start_stringvariable_start_stringcomment_start_stringnewline_sequence)rN s rA _environment_config_checkrd } s y ? ?>? ? & , , , , , + , , , , , F , , , ' , F
rC c - t e Zd ZU dZdZdZdZej d e d< dZ
e Z ej
d e d< eZej
e e d< ej
d e d < eeeeeeeeeeeed
d e dddd d ddfd
e de de de de de dej e dej e de de ddde dej ej e ej
d f d e d ej
e d ej ej! d ej" f d ej e ej! ej e ge f f d!ej d" d#e#d$e d%ej d& d'e f,d(Z$d)ej e ej
d f d*dfd+Z%d,ej" d*dfd-Z&e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'e'fd
e de de de de de dej e dej e de de dej ej e ej
d f d e d ej
e d ej ej! d ej" f d ej e ej! ej e ge f f d!ej d" d#e#d$e d%ej d& d*d f(d.Z(e)d*e*fd/ Z+d*ej, d fd0Z-d1ej" d2ej e ej" f d*ej ej" e f fd3Z.d1ej" d4e d*ej" fd5Z/d6ej e e f d7ej" d8ej ej ej" d9ej ej0 e ej" f d:ej e d;ej e1 dZ3 dkd6e d7ej" d8ej ej ej" d9ej ej0 e ej" f d:ej e d;ej e1 d*ej" fd?Z4e5 dld@e d6ej e dAej e d*e6j7 fdB Z8d@e d6ej e dAej e d*e6j7 fdCZ9 dld@e d6ej e dAej e d*ej, ej: e#e e f fdDZ; dld@e d6ej e dAej e d*e fdEZ< dld@e d6ej e dAej e dFej e d*e=f
dGZ> dmd@e6j7 d6ej e dAej e dHe d*e f
dIZ?d@e dAe d*e@fdJZAeBjC dnd@ej e e6j7 f d6ej e dAej e dKdLdHe d*e@f dM ZDeBjC dod@ej e e6j7 f d6ej e dAej e dKdNdHe d*e f dO ZDe5 dnd@ej e e6j7 f d6ej e dAej e dKe dHe d*ej e e@f f dP ZD dpd@e dQe d*dRfdSZE dqdUej e eFjG f dej ejH e dVej ej! e ge f dWej e dXej ej! e gdf dYe d*dfdZZI dldej ejH e dVej ej! e ge f d*ejJ e fd[ZKdrd@ej e d*d\fd]ZLd^e d_e d*e fd`ZMe5d6e daej ej0 e ej" f d*dfdb ZNe5 dld6ej e df d_ej e daej ej0 e ej" f d*dfdc ZOe5 dlddejP ej e df d_ej e daej ej0 e ej" f d*dfde ZQe5 dldfej e dejJ ej e df f d_ej e daej ej0 e ej" f d*dfdg ZR dld@ej e e6j7 f daej ej0 e ej" f d ej ej
d d*dfdhZSdiej ej0 e ej" f d*ejT e ej" f fdjZUdS )sr7 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:`~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.
FN linked_tor code_generator_class
context_classrE template_class Ti r` block_end_stringra variable_end_stringrb comment_end_stringline_statement_prefixline_comment_prefix trim_blocks
lstrip_blocksrc te.Literal['\n', '\r\n', '\r']keep_trailing_newlinerO r4 optimizedr_ finalize.
autoescapeloaderr5
cache_size auto_reloadbytecode_cacher3 enable_asyncc N || _ || _ || _ || _ || _ || _ || _ || _ | | _ |
| _ | | _
| | _ || _ || _
|| _ || _ t! j | _ t' j | _ t+ j | _ || _ t1 | | _ || _ || _ t9 j | _ t= | |
| _ || _ tC | d S N)"r` rk ra rl rb rm rn ro rp rq rc rs r_ rt ru rv r copyfiltersr testsr globalsrw rG rH rz ry r policiesrY rO is_asyncrd )selfr` rk ra rl rb rm rn ro rp rq rc rs rO rt r_ ru rv rw rx ry rz r{ s rA __init__zEnvironment.__init__# s J #5 0 %:"#6 $8!"4 %:"#6 & * 0 %:" -6"
$ '+-- "'))
(-// !*--
,& )-//
*$
;;$
!$'''''rC rX r= c X | j t | |g dS )z\Adds an extension after the environment was created.
.. versionadded:: 2.5
N)rO updaterY )r rX s rA
add_extensionzEnvironment.add_extensiono s,
ti[ A ABBBBBrC
attributesc | | D ]&\ }}t | | st | || '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)itemshasattrsetattr)r r keyvalues rA extendzEnvironment.extendv sR
%**,, * *JC4%%
*c5))) * *rC c t t }|d= |d= |d= t | j }|j | j d|_ | |_ | D ] \ }}|t urt ||| |t urt | |_
nt | j
|_
i |_ | j D ]"\ }}| | |j |< #| t ur(|j t# || 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.
r rx rO T)rK localsobject__new__ __class____dict__r overlayedrf r r2 r rG rH rM rO bindrY rd )r r` rk ra rl rb rm rn ro rp rq rO rt r_ ru rv rw rx ry rz r< rvr r s rA overlayzEnvironment.overlay sB B FHH~~ L$|,d<.@
^^DN
+
+
4=))) **,, ( (JCG##C''' W $ $#J//BHH!$*--BH
///11 0 0JC!&B BM# W $ $ M Z!@!@ A A A(,,,rC c t | S )z The lexer for this environment.r" r s rA lexerzEnvironment.lexer s rC c n t t | j d S )z)Iterates over the extensions by priority.c | j S r} )priorityxs rA z-Environment.iter_extensions.. s 1: rC )r )itersortedrO valuesr s rA iter_extensionszEnvironment.iter_extensions s/ F4?11339M9MNNNOOOrC objargumentc , || S # t t t f$ rr t |t rC t | } t || cY S # t $ r Y nw xY w# t $ r Y nw xY w| || cY S w xY w)z:Get an item or attribute of an object but prefer the item.r name)AttributeError TypeError LookupErrorrQ rR getattr Exceptionr_ )r r r attrs rA getitemzEnvironment.getitem s
:x= ;7 : : :(C((
x==D &sD 1 1111) ! D >>c>99 9 9 9 :sP
,BA)AB
A&#B%A&&B)
A63B5A66BB attributec t || S # t $ r Y nw xY w || S # t t t f$ r | || cY S w xY w)zGet an item or attribute of an object but prefer the attribute.
Unlike :meth:`getitem` the attribute *must* be a string.
r )r r r r r_ )r r r s rA r zEnvironment.getattr s 3 ** * D ;y> !;7 ; ; ;>>c >:: : : : ;s
+ .A A r r r< kwargscontexteval_ctx is_filterc |r
| j }d} n | j }d} | | }
|
bd| d|d} t |t r5 | n # t $ r} | d| d} Y d } ~ nd } ~ ww xY wt | |g||nd}||ni }t j |
}
|
t j
u r,|t d | d
| d | nd|
t j u r2|||j
}nt | }| d | n$|
t j u r| d | |
|i |S ) NfiltertestzNo z named .z (z-; did you forget to quote the callable name?)rj z Attempted to invoke a context z without context.r )r r getrQ r* _fail_with_undefined_errorr r r+ from_objr insert eval_contextr r& rN )r r r r< r r r r env_map type_namefuncmsgepass_args rA _filter_test_commonz Environment._filter_test_common s lG IIjG I{{4 <3 33$333C$ **
UU335555 U U U TTATTTCCCCCCU 's++ +;!1r;!-2$T** x' ' '*QYQQQ
KK7 # # # #
.
.
. & & /HH *4 0 0H KK8 $ $ $ $
-
-
- KK4 tT$V$$$s A! !
A=+A88A=c 8 | ||||||d S )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
Tr r r r r< r r r s rA call_filterzEnvironment.call_filter s+ " '' %vw$
rC c 8 | ||||||d S )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
Fr r s rA call_testzEnvironment.call_test- s+ * '' %vw%
rC sourcefilenamec | ||| S # t $ r | | Y dS w xY w)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 `
this gives you a good overview of the node tree generated.
r N)_parser handle_exceptionr r r r s rA parsezEnvironment.parseF sX 1;;vtX66 6" 1 1 1 ! ! ! 0 0 0 0 0 0 1s ==c J t | ||| S )z8Internal parsing function used by `parse` and `compile`.)r' r r s rA r zEnvironment._parseZ s$ dFD(3399;;;rC c t | } | j ||| S # t $ r | | Y dS w xY w)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)rR r tokeniterr r r s rA lexzEnvironment.lex` si V 1:''h?? ?" 1 1 1 ! ! ! 0 0 0 0 0 0 1s - AAc n t fd| 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 2 | | S r} )
preprocess)sr r r s rA r z(Environment.preprocess.. s ax88 rC )r r rR r s ``rA r zEnvironment.preprocessu s? 8 8 8 8 8 " " KK
rC statec | ||| }| j |||| }| D ]=}| | }t |t st
||| }>|S )zCalled by the parser to do the preprocessing and filtering
for all the extensions. Returns a :class:`~jinja2.lexer.TokenStream`.
)r r tokenizer
filter_streamrQ r% )r r r r r streamexts rA _tokenizezEnvironment._tokenize s x88$$VT8UCC'')) = =C&&v..F fk22
=$VT8<<
rC
defer_initc 6 t || |||| j S )z|Internal hook that can be overridden to hook a different generate
method in.
.. versionadded:: 2.5
)r rt )r rt )r r r r r s rA _generatezEnvironment._generate s/ !n
rC c $ t ||d S )z{Internal hook that can be overridden to hook a different compile
method in.
.. versionadded:: 2.5
exec)compile)r r r s rA _compilezEnvironment._compile s vx000rC rawzte.Literal[False]c d S r} rj r r r r r r s rA r zEnvironment.compile rC zte.Literal[True]c d S r} rj r s rA r zEnvironment.compile r rC c d} t |t r|}| ||| }| |||| }|r|S |d}| || S # t
$ r | | Y dS w xY w)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 )rQ rR r r r r r )r r r r r r source_hints rA r zEnvironment.compile s 8 6&#&&
= $ VT8<<^^FD(z^RRF
'==22 2" 6 6 6 ! ! ! 5 5 5 5 5 5 6s A
A) A) ) B
B
undefined_to_noneTemplateExpressionc t | |d } | }|j j s!t d|j j j dd | | n&# t $ r | | Y nw xY wt j
t j dd |d g}| t j
|d }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 expressionNr rW storer )lineno)r' parse_expressionr eosr currentr set_environmentr r
AssignName from_stringrE r )r r r parserexprbodytemplates rA compile_expressionz Environment.compile_expression s
< fJ777 1**,,D=$
),fm.C.JDRV
& & & &" 1 1 1 ! ! ! 0 0 0 0 0 1 UZ' : :DKKKL##EN4$B$B$BCC!(,=>>>s AA+ + B
Bdeflatedtarget filter_funczip log_function
ignore_errorsc t ddl m} |
dt ddfd}|J | j
J d dt d t ddffd
}=d d lm} mm}
m} | d
t |
| |d nAt j st j
|d | || D ]} | j | | \ }
}} | |
| |dd }n+# t" $ r }|s |d| d| Y d}~_d}~ww xY w| | } ||| |d| d| r n # r w w xY w |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 ) ModuleLoaderNr r= c d S r} rj r s rA r z3Environment.compile_templates..log_functionB s rC No loader configured.r datac > r* | }d|_ || d S t t j | d 5 }| | d d d d d S # 1 swxY w Y d S )Ni wbutf8)
external_attrwritestropenospathjoinwriteencode)r r infofZipInfor r
zip_files rA
write_filez1Environment.compile_templates..write_fileH s
1 wx((%0"!!$-----"',,vx88$?? 11GGDKK / /0001 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1s )BBBr )ZipFiler ZIP_DEFLATED
ZIP_STOREDw)r storedzCompiling into Zip archive zCompiling into folder TzCould not compile "z": z
Compiled "z" as z Finished compiling templates)loadersr rR rw zipfiler" r r# r$ rK r r isdirmakedirslist_templates
get_sourcer r get_module_filenameclose)r r rO r r
r r r r! r" r# r$ r r r _coder r r s ` ` @@rA compile_templatesz Environment.compile_templates$ s 4 *)))))
'''{&&(?&&& 1 1C 1D 1 1 1 1 1 1 1 1 1 ? J J J J J J J J J J J J wT<
K K KC P H
LAvAA B B B B7==((
$ F### L<&<< = = = ! ++J DD
A
A&*k&<&9F >E6F F*c | j
J d | j }%t d dt dt ffd fd|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
Nr z.filter_func s* axEAHHS!$4$4Q$7:$EErC c * g | ]} |
|S rj rj ).0r r s rA
z.Environment.list_templates.. s( AAAd{{4/@/@ATAAArC )rw r+ r rR bool)r rO r namess `` rA r+ zEnvironment.list_templatesr s ( {&&(?&&& **,, !& R
Fs
Ft
F
F
F
F
F
F "AAAAeAAAE rC z te.NoReturnc & ddl m} || )zException handling helper. This is used internally to either raise
rewritten exceptions or return a rendered traceback for the template.
r )rewrite_traceback_stackr )debugr; )r r r; s rA r z Environment.handle_exception s* 322222%%V4444rC r parentc |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.
rj )r r r= s rA join_pathzEnvironment.join_path s rC r c | j t d t j | j |f}| j H| j | }|,| j r|j r |r|j | |S | j
| || | }| j
|| j |< |S )Nz(no loader for this environment specified) rw r weakrefrefrH r ry
is_up_to_dater r load make_globals)r r r cache_keyr s rA _load_templatezEnvironment._load_template s ; FGG G [--t4 : !z~~i00H#$ $(0(> $
5 $++G444 ;##D$0A0A'0J0JKK : !$,DJy !rC c t |t r|S || || }| || 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.
)rQ rE r? rG )r r r= r s rA get_templatezEnvironment.get_template sJ 8 dH % % K >>$//D""4111rC r9 c ` t |t r| |st d |D ]b}t |t r|c S || || } | || c S # t t f$ r Y _w xY wt | )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.)message) rQ r* r r rE r? rG r r! )r r9 r= r r s rA select_templatezEnvironment.select_template s F eY ' ' / , , . . . #J
D$))
!~~dF33
**499999$n5
&&&s 2B
B B template_name_or_listc t |t t f r| ||| S t |t r|S | ||| S )zUse :meth:`select_template` if an iterable of template names
is given, or :meth:`get_template` if one name is given.
.. versionadded:: 2.3
)rQ rR r* rI rE rL )r rM r= r s rA get_or_select_templatez"Environment.get_or_select_template sg +c9-= > > )$$%:FGLL L
-x
8
8 )( (##$967KKKrC c | | }|p| j }| | | | |d S )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)rE ri from_coder )r r r ri gsr; s rA r zEnvironment.from_string1 sH "
w
'
' 3 3}}T4<<#7#7TBBBrC dc 4 |i }t || j S )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.
)r r )r rS s rA rE zEnvironment.make_globalsF s "
9A4<(((rC )NNNN)NN)F)NNFF)NN.F)T)NNr NTr} )V__name__
__module__ __qualname____doc__ sandboxedr rf rS Optional__annotations__r? r rg rU r( rh r r
r r r r r r r r r r r* rR r8 SequenceUnionCallableAnyintr r r r2 r propertyr$ r Iteratorr r r Mappingr& r r r r/ r
rE r r Tupler r r% r r r r typingoverloadr r r PathLike
Collectionr1 Listr+ r r? rG rI IterablerL rO r MutableMappingrE rj rC rA r7 r7 s4 w wz I I ,0Iqz-(/// F 5B!& 1AAA &-M16'?,,,F:&&&& #5 0%:#6$8"41F/B ' +AQ&;DF '07;IN+/ 6: "/J( J( J( J( # J(
! J( "
J( J( !z#J( Z_J( J( J( ?J( $J( JqwsAF;,?'? @A J( J( 6)$!J(" *QZQU
34#J($ GD!*ajo->-D"E EF%J(&
<('J(( )J(* +J(,
?3-J(. /J( J( J( J(XCqwsAF;4G/G'H CT C C C C*15 *T * * * * #* '%,#*$+")18/6 # %DK!'.7>IP+2! #6=)8- 8- 8- 8- # 8-
! 8- "
8- 8- !z#8- Z_8- 8- 8- JqwsAF;,?'? @A8- 8- 6)$ 8- *QZQU
34 8- GD!*ajo->-D"E EF!8-"
<(#8-$ %8-& '8-(
?3)8-*
+8- 8- 8- 8-t u X PK!8 P P P P:5:$%GCJ$7:
! ": : : :& ;15 ;S ;QU ; ; ; ;4%gc9n%4% u4% jAE*+ 4%
19S!%Z01 4% G$
4% *[)4% 4%
4% 4% 4% 4%t /348'+,0
u
jAE*+
19S!%Z01
G$
*[)
2 /348'+,0
u
jAE*+
19S!%Z01
G$
*[)
2 !%$( 1 11 jo1 *S/ 1
1 1 1 \1&<ej e d'd fd? Z4 dGd>ej e d'd fd@Z5e6dIdA Z7dBe8d'e8fdCZ9e6d'efdD Z:e6d'ej; ej< e8e8f fdE Z=d'e
fdFZ>dS )JrE 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.
environment_classrN r r r blocksroot_render_funcTemplateModule_module _debug_info _uptodaterj TNFr r` rk ra rl rb rm rn ro rp rq rc rr rs rO r4 rt r_ ru .rv r{ r= c t | j |||||||| |
| | |
t | ||||d ddd | }| || S )Nr F)ri )rB rm frozensetr )r; r r` rk ra rl rb rm rn ro rp rq rc rs rO rt r_ ru rv r{ r@ s rA r zTemplate.__new__| s{ , * ! ! ! ! j ! !
/
2 vc:::rC r0 uptodatec v ||j d}t || | ||| }||_ |S )zCreates a template object from compiled code and the globals. This
is used by the loaders and environment to create a template object.
)rN __file__) co_filenamer _from_namespacers )r; rN r0 r rv namespacer s rA rQ zTemplate.from_code sG %0T=MNN T9
i
A
A rC module_dictc 0 | ||| S )zCreates a template object from a module. This is used by the
module loader to create a template object.
.. versionadded:: 2.4
)rz )r; rN r| r s rA from_module_dictzTemplate.from_module_dict s ""; WEEErC r{ c t | }||_ ||_ |d |_ |d |_ |d |_ |d |_ d |_ |d |_ d |_
||d< ||d< |S )Nr rx rn root
debug_inforN __jinja_template__) r r rN r r r rn ro rq rr rs )r; rN r{ r rS s rA rz zTemplate._from_namespace s s++#
6" z*
X& 'v . ",/
$/ - *+ &'rC r< r c h | j j rddl}d}t j dk r| }n< | }n&# t $ r | }d}Y nw xY w | | j
|i | |r| S S # |r| w w xY w| t |i | } t | | S # t $ r | j Y dS w xY w)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)rN r asynciosys version_infoget_event_loopget_running_loop RuntimeErrornew_event_looprun_until_complete render_asyncr. r) rK r, ro r r )r r< r r r. loopctxs rA renderzTemplate.render sn $ ! NNNE &(( --//!"3355DD# ! ! !"1133D EEE!
!../@t/@$/Q&/Q/QRR !JJLLLL!5 !JJLLLL! tT 4V 4 455 0$//4455 5 0 0 0 - - / / / / / / 0s/ A A10A15 B, ,C(!D
#D10D1c 2 K | j j st d | t |i | } t d | | 2 d{V S # t $ r | j cY S w xY w)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')
8The environment was not created with async mode enabled.c " K g | 3 d {V }|
6 S r} rj )r6 ns rA r7 z)Template.render_async.. s. GGGGGGGGq1GGGG N) rN r r r) rK r, ro r r )r r< r r s rA r zTemplate.render_async
s ( J
tT 4V 4 455 7GGD,A,A#,F,FGGGGGGGGGHH H 7 7 7#4466 6 6 6 7s 1A0 0#BBTemplateStreamc 6 t | j |i | S )z[Works exactly like :meth:`generate` but returns a
:class:`TemplateStream`.
)r r )r r< r s rA r zTemplate.stream" s# mdmT .to_list..4 s. NNNNNNNNANNNNr )generate_async)r< r r s rA to_listz"Template.generate..to_list3 s@ NN)<)C %DDc K | j j st d | t |i | } | | 2 3 d{V }|W V
6 dS # t $ r | j W V Y dS w xY w)zsAn async version of :meth:`generate`. Works very similarly but
returns an async iterator instead.
r N)rN r r r) rK ro r r )r r< r r events rA r zTemplate.generate_asyncF s ( J
tT 4V 4 455 6 # 4 4S 9 9
e : 9 9 6 6 6"3355 5 5 5 5 5 5 5 6s A# A A# #&B
B
varsr? r c T 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) rN r rn r )r r r? r s rA r) zTemplate.new_contextY s/ didFDLRX
rC c P | ||| }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) rp r r r? r r s rA make_modulezTemplate.make_modulej s+ tVV44 dC(((rC c K | ||| }t | |d | | 2 d{V S )zAs 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 " K g | 3 d {V }|
6 S r} rj r s rA r7 z.Template.make_module_async.. s. DDDDDDDDADDDDr N)r) rp ro r s rA make_module_asynczTemplate.make_module_asyncy sg tVV44 #DD)>)>s)C)CDDDDDDDDD
rC r c | j j rt d Dj | j z
}|r!| fd|D S | j | | _ | j S )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 , i | ]}|j | S rj r= r6 kr s rA
z0Template._get_default_module.. s! (H(H(HaCJqM(H(H(HrC )rN r r globals_keysr keysr rq r r r s ` rA _get_default_modulez Template._get_default_module s $ I GHH H ?#dl&7&7&9&99D
J''(H(H(H(H4(H(H(HIII < ++--DL|rC c K Jj | j z
}|r'| fd|D d {V S | j | d {V | _ | j S )Nc , i | ]}|j | S rj r r s rA r z6Template._get_default_module_async.. s! 4T4T4T!Q
1
4T4T4TrC )r r r r rq r s ` rA _get_default_module_asyncz"Template._get_default_module_async s ?#dl&7&7&9&99D
V ! 3 34T4T4T4Tt4T4T4T U UUUUUUUU < !%!7!7!9!9999999DL|rC c * | 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 r s rA modulezTemplate.module s '')))rC r c N t | j D ]\ }}||k r|c S dS )zrReturn the source line number of a line number in the
generated bytecode as they are not in sync.
r )reversedr )r r
template_line code_lines rA get_corresponding_linenoz!Template.get_corresponding_lineno sC )1 (A(A % % $M9F""$$$$ #qrC c < | j dS | S )z?If this variable is `False` there is a newer version available.NT)rs r s rA rC zTemplate.is_up_to_date s! > !4~~ rC c \ | j r$d | j d D S g S )zThe debug info mapping.c
x g | ]7}t t t | d 8S )=)tuplemapr` splitr s rA r7 z'Template.debug_info.. sD c#qwws||,,-- rC &)rr r r s rA r zTemplate.debug_info sH )//44
rC c | j dt | d}nt | j }dt | j d| dS Nzmemory:r < >)r idreprrJ rU r r s rA __repr__zTemplate.__repr__ sQ 9 )RXX)))DD ??D04::&000000rC r} )NFN)r= rp )?rU rV rW rX r7 rm rS rU r[ rk rR r_ rZ Dictr^ r( rb r8 r r
r r r r r r r r r r r* r] r
rE r\ r classmethodr rQ r~ rz r r r r
AsyncIteratorr rc r) r r r/ r r ra r r` r rC ri rd r r rj rC rA rE rE ] sT $ .9qvk*888
c15j
))))
*S/jo
F3
G9ajo#=>> ????j'AJsO!;<<<<
Z(
))))z!*RX.////
#5 0%:#6$8"41F/B ' +AQ&;DF '07;IN ")/; /;U^+,/; /; /;
# /; !
/; "/; /; !z#/; Z_/; /; /; ?/; $ /; JqwsAF;,?'? @A /; !/;" 6)$#/;$ *QZQU
34%/;& GD!*ajo->-D"E EF'/;( )/;*
+/; /; /; /;b 6: !#qu*-
*QZD 12
[ F F %c15j1 F !#qu*- F
F F F [ F #CJ/ !#qu*-
[6#0AE #0QU #0s #0 #0 #0 #0J7 7 73 7 7 7 7*>AE >QU >7G > > > > 6ae 6qu 6C 6 6 6 6<6U6&'e6
6 6 6 6* 04 48
jQU
+,
19S!%Z01
& 04 48
)
)jQU
+,
)
)
19S!%Z01
)
)
)
)
)" 04 48
jQU
+,
19S!%Z01
qz'': FV \ 6 *. :g&
*
*
* X
* s s t X AF1738#4 5 X1# 1 1 1 1 1 1rC c ~ e Zd ZdZ d dededej ej e ddfdZ
de fdZ de fd Z
de fd
ZdS ) rp zRepresents 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.
Nr r body_streamr= c |=|j j rt d t | | }|| _ | 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.) rN r r listro _body_streamr r get_exportedr rU )r r r r s rA r zTemplateModule.__init__ s "+
"* x 8 8 A ABBK '
W 1 1 3 3444
rC c D t t | j S r} )r r, r r s rA __html__zTemplateModule.__html__ s fT .//000rC c * t | j S r} )r, r r s rA __str__zTemplateModule.__str__ s d'(((rC c | j dt | d}nt | j }dt | j d| dS r )rU r r rJ r s rA r zTemplateModule.__repr__ sS = )RXX)))DD
&&D04::&000000rC r} )rU rV rW rX rE r( rS rZ rj rR r r r r r rj rC rA rp rp s 48 & && & Z
30 &
& & & &(1& 1 1 1 1) ) ) ) )1# 1 1 1 1 1 1rC rp c n e Zd ZdZdededdfdZdej dej dej ej fd Z
dS )
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.
r r r= Nc " || _ || _ d S r} ) _template_undefined_to_none)r r r s rA r zTemplateExpression.__init__ s !"3 rC r< r c | j t |i | }t | j | |j d }| j rt |t rd }|S )NrW ) r r) rK r- ro r r rQ r* )r r< r r r s rA __call__zTemplateExpression.__call__ st .,,T4-B6-B-BCC//88999
\(
# " z"i'@'@ B rC ) rU rV rW rX rE r8 r rS r_ rZ r rj rC rA r r
s}
4 4d 4t 4 4 4 4ae qu AE9J rC r c e Zd ZdZdej e ddfdZ ddej eej f dej
e d ej
e ddfd
Z dd Z d e
dej e fd
Zdd e
ddfdZddZdefdZdS )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.
genr= Nc < || _ | d S r} )_gendisable_buffering)r r s rA r zTemplateStream.__init__+ s! rC strictfpencodingerrorsc v d}t |t rdt |d }d} fd| D }n| }t |d r| | n|D ]}| | |r| dS dS # |r| w w xY w)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 D K | ]}| V d S r} )r )r6 r r r s rA z&TemplateStream.dump..G s1 EE1AHHXv 6 6EEEEEErC
writelines)rQ rR r r r r r. )r r r r r. iterableitems `` rA dumpzTemplateStream.dump/ s b# "b$ BE
#EEEEEEEE r<((
#
h'''' $ # #DHHTNNNN
u
s AB B8c R t t | j | _ d| _ dS )z Disable the output buffering.FN)r nextr _nextbufferedr s rA r z TemplateStream.disable_bufferingT s T49--
rC rD c # K g }d}|j } ||k r,t | j } || |r|dz
}||k ,n# t $ r |sY d S Y nw xY wt | V |d d = d}b)Nr Tr )appendr r
StopIterationr, )r rD bufc_sizepushcs rA _buffered_generatorz"TemplateStream._buffered_generatorY s z
tmm TYADGGG $ ! tmm
!
FF
++ AAAF s 2A AA c |dk rt d d| _ t t | | | _ dS )zr s
# # # # # # & & & & & & ( ( ( ( ( ( ( ( ( ( ( ( * * * * * * % % % % % % ' ' ' ' ' ' & & & & & & # # # # # # + + + + + + ) ) ) ) ) ) + + + + + + # # # # # # & & & & & & ! ! ! ! ! ! ) ) ) ) ) ) + + + + + + ( ( ( ( ( ( , , , , , , ) ) ) ) ) ) + + + + + + & & & & & & ? $""""&&&&&& ######
QY|=
9
9
9
2
QVJ%7
*
Z c)9!:J!FGH
$ :a& '
$Z c)9!:J!FGH
$
$
$
$
173{(;#;<= VC $ $K) K) K) K) K) K) K) K)\ E1 E1 E1 E1 E1 E1 E1 E1P %1 %1 %1 %1 %1 %1 %1 %1P &X X X X X X X X z & rC