← Back
Editing: environment.cpython-37.pyc
B ���a7� � @ 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 ejHd4d5d6�ZIe d7d8�ejJeI ejKeId9�d:d;��ZLeMejNejOejPejQeRf d<f d=�d>d?�ZSejNejO ejNejOejPejQeRf d<f d@�dAdB�ZTd5ejUejVeRejJdC f ejWeRdCf dD�dEdF�ZXd5d5dG�dHdI�ZYG dJd5� d5�ZZG dKd<� d<�Z[G dLdM� dM�Z\G dNdO� dO�Z]G dPdQ� dQ�Z^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)�bound� )�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)r8 r9 �env� r= �C/opt/alt/python37/lib/python3.7/site-packages/jinja2/environment.py�get_spontaneous_environmentC s r? �Template)�sizer: c C s | dkr dS | dk ri S t | �S )z*Return the cache class for the given size.r N)r. )rA r= r= r> � create_cacheQ s rB )�cacher: c C s& | dkr dS t | �tkr i S t| j�S )z(Create an empty copy of the given cache.N)�type�dictr. Zcapacity)rC r= r= r> � copy_cache^ s rF r1 )� environment� extensionsr: c C sD i }x:|D ]2}t |t�r.t�tjd 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 r: c C sN t | jt�std��| j| j kr.| jks8n td��| jdksJtd��| 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'.)� issubclass� undefinedr( �AssertionError�block_start_string�variable_start_string�comment_start_string�newline_sequence)rG r= r= r> �_environment_config_check} s r\ c @ sX e Zd ZU dZdZdZdZejd e d< dZ e Z ej d e d< eZej e e d< ej d e d < eeeeeeeeeeeed d e dddd d ddfe e e e e e eje eje e e d e ej ej e ej d f e ej e ejej!dej"f ej e ej!eje ge f f ejd e#e ejd e d�dd�Z$ej e ej d f dd�dd�Z%ej"dd�dd�Z&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!dej"f ej e ej!eje ge f f ejd e#e ejd d d�d d �Z(e)e*d �d d ��Z+ej,d d �d!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+�Z2dne ej"ejej ej" ejej0e ej"f eje eje1 ej"d,�d-d.�Z3doe ej"ejej ej" ejej0e ej"f eje eje1 ej"d,�d/d0�Z4e5dpe eje eje e6j7d1�d2d3��Z8e eje eje e6j7d1�d4d5�Z9dqe eje eje ej,ej:e#e e f d1�d6d7�Z;dre eje eje e d1�d8d9�Z<dse eje eje eje e=d:�d;d<�Z>dte6j7eje eje e e d=�d>d?�Z?e e e@d@�dAdB�ZAeBjCduej e e6j7f eje eje dCe e@dD�dEdF��ZDeBjCdvej e e6j7f eje eje dGe e dD�dHdF��ZDe5dwej e e6j7f eje eje e e ej e e@f dD�dIdF��ZDdxe e dJdK�dLdM�ZEdyej e eFjGf ejejHe ejej!e ge f eje ejej!e gdf e ddO�dPdQ�ZIdzejejHe ejej!e ge f ejJe dR�dSdT�ZKd{eje dUdV�dWdX�ZLe e e dY�dZd[�ZMe5e ejej0e ej"f dd\�d]d^��ZNe5d|ej e df eje ejej0e ej"f dd_�d`da��ZOe5d}ejPej e df eje ejej0e ej"f ddb�dcdd��ZQe5d~ej e dejJej e df f eje ejej0e ej"f dde�dfdg��ZRdej e e6j7f ejej0e ej"f ejej d ddh�didj�ZSejej0e ej"f ejTe ej"f dk�dldm�ZUdS )�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. FN� linked_tor �code_generator_class� context_classr@ �template_classr= 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� || _ || _|| _|| _|| _|| _|| _|| _| | _| | _ | | _ | | _ || _ || _ || _|| _t�� | _t�� | _t�� | _|| _t|�| _|| _|| _t �� | _ t | | �| _ || _ t!| � d S )N)"rX ra rY rb rZ rc rd re rf rg r[ rh rV ri rj rk r �copy�filtersr �testsr �globalsrl rB rC ro rn r ZpoliciesrQ rH �is_asyncr\ )�selfrX ra rY rb rZ rc rd re rf rg r[ rh rH ri rV rj rk rl rm rn ro rp r= r= r> �__init__# s6 % zEnvironment.__init__)rP r: c C s | j �t| |g�� dS )z\Adds an extension after the environment was created. .. versionadded:: 2.5 N)rH �updaterQ )rv rP r= r= r> � add_extensiono s zEnvironment.add_extension)� attributesr: c K s0 x*|� � 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)rv rz �key�valuer= r= r> �extendv s zEnvironment.extend)rX ra rY rb rZ rc rd re rf rg rH ri rV rj rk rl rm rn ro r: c C s� t t� �}|d= |d= |d= t�| j�}|j�| j� d|_| |_x(|� � D ] \}}|t k rLt |||� qLW |t k r�t |�|_ n t| j �|_ i |_x&| j� � D ]\}}|�|�|j|< q�W | t k r�|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. rv rm rH T)rE �locals�object�__new__� __class__�__dict__rx � overlayedr] r{ r/ r} rB rC rF rH �bindrQ r\ )rv rX ra rY rb rZ rc rd re rf rg rH ri rV rj rk rl rm rn ro r9 �rvr~ r r= r= r> �overlay s$ ! zEnvironment.overlay)r: c C s t | �S )z The lexer for this environment.)r! )rv r= r= r> �lexer� s zEnvironment.lexerc C s t t| j�� dd� d��S )z)Iterates over the extensions by priority.c S s | j S )N)�priority)�xr= r= r> �<lambda>� � z-Environment.iter_extensions.<locals>.<lambda>)r~ )�iter�sortedrH �values)rv r= r= r> �iter_extensions� s zEnvironment.iter_extensions)�obj�argumentr: c C s~ y|| S t ttfk rx t|t�rjy t|�}W n tk rH Y n"X y t||�S t k rh Y nX | j||d�S X dS )z:Get an item or attribute of an object but prefer the item.)r� �nameN)�AttributeError� TypeError� LookupErrorrI rJ � Exception�getattrrV )rv r� r� �attrr= r= r> �getitem� s zEnvironment.getitem)r� � attributer: c C sR y t ||�S tk r Y nX y|| S tttfk rL | j||d�S X dS )z�Get 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 )rv r� r� r= r= r> r� � s zEnvironment.getattr)r� r r9 �kwargs�context�eval_ctx� is_filterr: c C sP |r| j }d} n | j}d} |�|�} | d kr�d| � d|�d�} t|t�r�y |�� W n2 tk r� } z| � d| � d�} W d d } ~ X Y nX t| ��|f|d k r�|nd�}|d k r�|ni }t� | �} | tj kr�|d kr�td | � d ���|� d |� nV| tj k�r.|d k�r |d k �r|j }nt| �}|� d |� n| tjk�rF|� d | � | ||�S ) N�filter�testzNo z named �.z (z-; did you forget to quote the callable name?)r= z Attempted to invoke a context z without context.r )rr rs �getrI r( �_fail_with_undefined_errorr� r r) Zfrom_objr� �insertZ eval_contextr� r$ rG )rv r� r r9 r� r� r� r� Zenv_mapZ type_name�func�msg�eZpass_argr= r= r> �_filter_test_common� s> " z Environment._filter_test_common)r� r r9 r� r� r� r: c C s | � ||||||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 T)r� )rv r� r r9 r� r� r� r= r= r> � call_filter s zEnvironment.call_filterc C s | � ||||||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 F)r� )rv r� r r9 r� r� r� r= r= r> � call_test- s zEnvironment.call_test)�sourcer� �filenamer: c C s4 y| � |||�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)rv r� r� r� r= r= r> �parseF s zEnvironment.parsec C s t | |||��� S )z8Internal parsing function used by `parse` and `compile`.)r% r� )rv r� r� r� r= r= r> r� Z s zEnvironment._parsec C s> t |�}y| j�|||�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� )rv r� r� r� r= r= r> �lex` s zEnvironment.lexc s t � �fdd�| �� 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 |� | �� �S )N)� preprocess)�sr� )r� r� r= r> r� � r� z(Environment.preprocess.<locals>.<lambda>)r r� rJ )rv r� r� r� r= )r� r� r> r� u s zEnvironment.preprocess)r� r� r� �stater: c C sV | � |||�}| j�||||�}x0| �� D ]$}|�|�}t|t�s*t|||�}q*W |S )z�Called 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# )rv r� r� r� r� �stream�extr= r= r> � _tokenize� s zEnvironment._tokenize)r� r� r� � defer_initr: c C s t || |||| jd�S )z|Internal hook that can be overridden to hook a different generate method in. .. versionadded:: 2.5 )r� ri )r ri )rv r� r� r� r� r= r= r> � _generate� s zEnvironment._generate)r� r� r: c C s t ||d�S )z{Internal hook that can be overridden to hook a different compile method in. .. versionadded:: 2.5 �exec)�compile)rv r� r� r= r= r> �_compile� s zEnvironment._compilezte.Literal[False])r� r� r� �rawr� r: c C s d S )Nr= )rv r� r� r� r� r� r= r= r> r� � s zEnvironment.compilezte.Literal[True]c C s d S )Nr= )rv r� r� r� r� r� r= r= r> r� � s c C sx d}yNt |t�r"|}| �|||�}| j||||d�}|r<|S |dkrHd}| �||�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� )rv r� r� r� r� r� Z source_hintr= r= r> r� � s �TemplateExpression)r� �undefined_to_noner: c C s� t | |dd�}y2|�� }|jjs4td|jjjdd��|�| � W n tk r` | j|d� Y nX t j t � dd�|dd �g}| � 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� )rv r� r� �parser�expr�body�templater= r= r> �compile_expression� s z Environment.compile_expression�deflated)�targetrH � filter_func�zip� log_function� ignore_errorsr: c s� ddl m} |dkr$tdd�dd�}|dk s0t�| jdk sBtd��ttdd�� ���fd d � }�dk r�d d lm} m� m} m } | �d t | | d�� ��|d���� n$t j � ��s�t ��� |d���� z�x�| �||�D ]�} | j�| | �\} }}y| �| | |dd�}W nB tk �rJ } z"|�s$� |d| � d|� �� w�W dd}~X Y nX |�| �}|||� |d| � d|� �� q�W W d��r���� 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� r: c S s d S )Nr= )r� r= r= r> r� B s z3Environment.compile_templates.<locals>.log_functionzNo loader configured.)r� �datar: c sT �r � | �}d|_ ��||� n0ttj��| �d��}|�|�d�� W d Q R X d S )Ni ��wb�utf8)� 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 rl �zipfiler� r� r� r� rE r� r� �isdir�makedirs�list_templates� get_sourcer� r Zget_module_filename�close)rv 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� r: c sf | j dk std��| j �� }� dk rH�dk r4td��ttd�� fdd� ��dk rb�fdd�|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� r: c s d| ko| � dd�d � 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>)rl rW r� r� rJ �bool)rv rH r� �namesr= )rH r� r> r� r s zEnvironment.list_templatesz te.NoReturn)r� r: c C s ddl m} ||d��dS )z�Exception 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� )rv r� r� r= r= r> r� � s z Environment.handle_exception)r� �parentr: 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= )rv r� r� r= r= r> � join_path� s zEnvironment.join_path)r� rt r: c C s� | j d krtd��t�| j �|f}| jd k r`| j�|�}|d k r`| jrL|jr`|r\|j� |� |S | j � | || � |��}| jd k r�|| j|< |S )Nz(no loader for this environment specified) rl r� �weakref�refrC r� rn � is_up_to_datert rx �load� make_globals)rv r� rt Z cache_keyr� r= r= r> �_load_template� s zEnvironment._load_template)r� r� rt r: c C s. t |t�r|S |dk r"| �||�}| �||�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 )rv r� r� rt r= r= r> � get_template� s zEnvironment.get_template)r� r� rt r: c C s� t |t�r|�� |s tdd��xT|D ]L}t |t�r8|S |dk rL| �||�}y | �||�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 )rv r� r� rt r� r= r= r> �select_template� s # zEnvironment.select_template)�template_name_or_listr� rt r: c C s8 t |ttf�r | �|||�S t |t�r*|S | �|||�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 )rv r r� rt r= r= r> �get_or_select_template s z"Environment.get_or_select_template)r� rt r` r: c C s* | � |�}|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)r r` � from_coder� )rv r� rt r` Zgsr8 r= r= r> r� 1 s zEnvironment.from_string)�dr: c C s |dkr 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. N)r rt )rv 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 �Optional�__annotations__r; r r^ rM r& r_ r r r r r r r r r r r r r( rJ r� �Sequence�Union�Callable�Any�intrw ry r� r/ r� �propertyr" r� �Iteratorr� r� r� �Mappingr$ r� r� r� r- r r@ r� r� �Tupler� r� r# r� r� r r� �typing�overloadr� 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 ed< eed< ej e ej f ed< ej e ed< ej e ed< ej e ejegeje f f ed< ejegeje f ed< ej d ed < e ed < ej ejg ef ed < eeeeeeeeeee e d 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�dd�Z#e$dDee%ej e ej f ej ejg ef d d�dd��Z&e$eej e ej f ej e ej f d d�dd ��Z'e$eej e ej f ej e ej f d d �d d ��Z(ej ej e d �d!d"�Z)ej ej e d �d#d$�Z*ej ej d%d �d&d'�Z+ej ej eje d �d(d)�Z,ej ej ej-e d �d*d+�Z.dEej ej e ej f eej ej/e ej f ed,�d-d.�Z0dFej ej e ej f eej ej/e ej f d d,�d/d0�Z1dGej ej e ej f eej ej/e ej f d d,�d1d2�Z2e3dHej e d d3�d4d5��Z4dIej e d d3�d6d7�Z5e6d d8�d9d:��Z7e8e8d;�d<d=�Z9e6ed8�d>d?��Z:e6ej;ej<e8e8f d8�d@dA��Z=e d8�dBdC�Z>dS )Jr@ 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_classrG rt r� r� �blocks�root_render_func�TemplateModule�_module� _debug_info� _uptodater= TNFz te.Literal['\n', '\r\n', '\r']r1 .)r� rX ra rY rb rZ rc rd re rf rg r[ rh rH ri rV rj rk rp r: c C sH t | j|||||||| | | | | t|�||||d ddd |�}|j|| d�S )Nr F)r` )r? r � frozensetr� )r8 r� rX ra rY rb rZ rc rd re rf rg r[ rh rH ri rV rj rk rp r< r= r= r> r� | s2 zTemplate.__new__)rG r� rt �uptodater: c C s. ||j d�}t||� | �|||�}||_|S )z�Creates 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_namespacer& )r8 rG r� rt r( � namespacer� r= r= r> r � s zTemplate.from_code)rG � module_dictrt r: c C s | � |||�S )z�Creates a template object from a module. This is used by the module loader to create a template object. .. versionadded:: 2.4 )r+ )r8 rG r- rt r= r= r> �from_module_dict� s zTemplate.from_module_dict)rG r, rt r: c C sh t �| �}||_||_|d |_|d |_|d |_|d |_d |_|d |_ d |_ ||d< ||d< |S )Nr� r) r! �root� debug_inforG Z__jinja_template__) r� r� rG rt r� r� r! r" r$ r% r& )r8 rG r, rt rK r= r= r> r+ � s zTemplate._from_namespace)r9 r� r: c O s� | j jrxddl}d}tjdk r(|�� }n.y |�� }W n tk rT |�� }d}Y nX z|� | j ||��S |rv|� � X | � t ||��}yt| �|��S tk r� | 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)rG ru �asyncio�sys� version_info�get_event_loopZget_running_loop� RuntimeErrorZnew_event_loop�run_until_complete� render_asyncr� r' rE r* r" r� r� )rv r9 r� r3 r� �loop�ctxr= r= r> �render� s& zTemplate.renderc � s^ | j jstd��| �t||��}y tdd� | �|�2 �I dH �S tk rX | 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 ru r7 r' rE r* r" r� r� )rv r9 r� r; r= r= r> r9 s zTemplate.render_async�TemplateStreamc O s t | j||��S )z[Works exactly like :meth:`generate` but returns a :class:`TemplateStream`. )r? r )rv r9 r� r= r= r> r� " s zTemplate.streamc / s� �j jrfddl}tjt d�� ��fdd� }tjdk rL|�� }|� |� �}n |� |� �}|E dH dS �� t � ���}y�� |�E dH W n tk r� �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)r: c � s dd� �j � ��2 �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= )r9 r� rv r= r> �to_list3 s z"Template.generate.<locals>.to_list)r1 r2 )rG ru r3 rK r rJ r4 r5 r6 r8 �runr' rE r" r� r� )rv r9 r� r3 rA r: �outr; r= )r9 r� rv r> r ( s zTemplate.generatec O s� | j jstd��| �t||��}y<x6| �|�2 y 3 dH }W n tk sNX |V q. Y W W n tk r| | 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 ru r7 r' rE r" r= r� r� )rv r9 r� r; �eventr= r= r> r@ F s $zTemplate.generate_async)�varsr; r� r: 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! rt )rv rE r; r� r= r= r> r' Y s zTemplate.new_contextc C s | � |||�}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# )rv rE r; r� r; r= r= r> � make_modulej s zTemplate.make_modulec � s0 | � |||�}t| |dd� | �|�2 �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" )rv rE r; r� r; r= r= r> �make_module_asyncy s zTemplate.make_module_async)r; r: c s^ | j jrtd��� dk rD� j| j�� }|rD| �� fdd�|D ��S | jdkrX| �� | _| 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)r; r= r> � <dictcomp>� s z0Template._get_default_module.<locals>.<dictcomp>)rG ru r7 � globals_keysrt �keysrF r$ )rv r; rK r= )r; r> �_get_default_module� s z Template._get_default_modulec � sZ � d k r:� j | j�� }|r:| �� fdd�|D ��I d H S | jd krT| �� I d H | _| jS )Nc s i | ]}� j | |�qS r= )r� )r� rH )r; r= r> rI � s z6Template._get_default_module_async.<locals>.<dictcomp>)rJ rt rK rG r$ )rv r; rK r= )r; r> �_get_default_module_async� s z"Template._get_default_module_async)r: c C s | � � 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. )rL )rv r= r= r> �module� s zTemplate.module)r� r: c C s( x"t | j�D ]\}}||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 )�reversedr0 )rv r� Z template_lineZ code_liner= r= r> �get_corresponding_lineno� s z!Template.get_corresponding_linenoc C s | j dkrdS | � � S )z?If this variable is `False` there is a newer version available.NT)r& )rv r= r= r> r� � s zTemplate.is_up_to_datec C s | j r dd� | j �d�D �S g S )zThe debug info mapping.c S s g | ]}t tt|�d ����qS )�=)�tuple�mapr �split)r� r� r= r= r> r� � s z'Template.debug_info.<locals>.<listcomp>�&)r% rT )rv r= r= r> r0 � s zTemplate.debug_infoc C s> | j d kr dt| �d��}n t| j �}dt| �j� d|� d�S )Nzmemory:r� �<� �>)r� �id�reprrD r )rv r� r= r= r> �__repr__� s zTemplate.__repr__)N)NFN)NFN)NFN)N)N)?r r r r r4 r rK rM r r rJ r r �Dictr 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< r9 r� r � AsyncIteratorr@ r r' rF rG r- rL rM r rN r rP r� r r r0 r[ r= r= r= r> r@ ] s� $� & % , , , c @ s\ e Zd ZdZd eeejeje dd�dd�Z e d�dd�Z e d�d d �Z e d�d 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_streamr: c C sH |d kr&|j jrtd��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.) rG ru r7 �listr" � _body_streamr� rx Z get_exportedr� r )rv r� r� r_ r= r= r> rw � s zTemplateModule.__init__)r: c C s t t| j��S )N)r r* ra )rv r= r= r> �__html__� s zTemplateModule.__html__c C s t | j�S )N)r* ra )rv r= r= r> �__str__ s zTemplateModule.__str__c C s> | j d kr dt| �d��}n t| j �}dt| �j � d|� d�S )Nzmemory:r� rV rW rX )r rY rZ rD )rv r� r= r= r> r[ s zTemplateModule.__repr__)N)r r r r r@ r& rK r r rJ rw r rb rc r[ r= r= r= r> r# � s r# c @ s@ e Zd ZdZeedd�dd�Zejejej ej d�dd�Z 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� r: c C s || _ || _d S )N)� _template�_undefined_to_none)rv r� r� r= r= r> rw s zTemplateExpression.__init__)r9 r� r: c O sD | j �t||��}t| j �|�� |jd }| jr@t|t�r@d }|S )NrO ) rd r' rE r+ r" rE re rI r( )rv r9 r� r� r� r= r= r> �__call__ s zTemplateExpression.__call__) r r r r r@ r� rw rK r r rf r= r= r= r> r� s r� c @ s� e Zd ZdZeje dd�dd�Zdejeej f ej e ej e dd�dd �Z dd �d d �Z e eje d �dd�Zde dd �dd�Zd d �dd�Zed �dd�ZdS )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)�genr: c C s || _ | �� d S )N)�_gen�disable_buffering)rv rg r= r= r> rw + s zTemplateStream.__init__�strict)�fp�encoding�errorsr: c s� d}t |t�r(� dkrd� t|d�}d}zT� dk rH� �fdd�| D �}n| }t|d�rb|�|� nx|D ]}|�|� qhW W d|r�|�� 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 | ]}|� � ��V qd S )N)r� )r� r� )rl rm r= r> � <genexpr>G s z&TemplateStream.dump.<locals>.<genexpr>� writelines)rI rJ r� r| ro r� r� )rv rk rl rm r� �iterable�itemr= )rl rm r> �dump/ s zTemplateStream.dump)r: c C s t t| j�| _d| _dS )z Disable the output buffering.FN)r �nextrh �_next�buffered)rv r= r= r> ri T s z TemplateStream.disable_buffering)rA r: 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 )�appendrs rh � StopIterationr* )rv rA �bufZc_size�push�cr= r= r> �_buffered_generatorY s z"TemplateStream._buffered_generator� c C s, |dkrt d��d| _tt| �|��| _dS )z<Enable buffering. Buffer `size` items before yielding them.r zbuffer size too smallTN)� ValueErrorru r rs r{ rt )rv rA r= r= r> �enable_bufferingl s z TemplateStream.enable_bufferingc C s | S )Nr= )rv r= r= r> �__iter__t s zTemplateStream.__iter__c C s | � � S )N)rt )rv r= r= r> �__next__w s zTemplateStream.__next__)Nrj )r| )r r r r rK r rJ rw r �IOr rr ri r r{ r~ r r� r= r= r= r> r? s r? )`r r� r4 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/ � TYPE_CHECKINGZtyping_extensions�teZbccacher0 r� r1 r� r2 �TypeVarr3 rM r r? r r r r r� rJ rB rF r r r\ rQ r\ r4 r@ r# r� r? r` r= r= r= r> �<module> s� * * U (]
Save File
Cancel