3
aG�\�C � @ s d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddl m
Z
ddl m Z m
Z
ddlmZmZ d d
� ZG d d � d e�ZG d
d� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd � d e�ZdS ) z�
jinja2.loaders
~~~~~~~~~~~~~~
Jinja loader classes.
:copyright: (c) 2017 by the Jinja Team.
:license: BSD, see LICENSE for more details.
� N)�
ModuleType)�path)�sha1)�TemplateNotFound)�open_if_exists� internalcode)� string_types� iteritemsc C s` g }xV| j d�D ]H}tj|ks8tjr.tj|ks8|tjkrBt| ��q|r|dkr|j|� qW |S )z�Split a path into segments and perform a sanity check. If it detects
'..' in the path it will raise a `TemplateNotFound` error.
�/�.)�splitr �sep�altsep�pardirr �append)�template�piecesZpiece� r � /usr/lib/python3.6/loaders.py�split_template_path s
r c @ s2 e Zd ZdZdZdd� Zdd� Zed
dd ��ZdS ) �
BaseLoadera� Baseclass for all loaders. Subclass this and override `get_source` to
implement a custom loading mechanism. The environment provides a
`get_template` method that calls the loader's `load` method to get the
:class:`Template` object.
A very basic example for a loader that looks up templates on the file
system could look like this::
from jinja2 import BaseLoader, TemplateNotFound
from os.path import join, exists, getmtime
class MyLoader(BaseLoader):
def __init__(self, path):
self.path = path
def get_source(self, environment, template):
path = join(self.path, template)
if not exists(path):
raise TemplateNotFound(template)
mtime = getmtime(path)
with file(path) as f:
source = f.read().decode('utf-8')
return source, path, lambda: mtime == getmtime(path)
Tc C s" | j std| jj ��t|��dS )a� Get the template source, filename and reload helper for a template.
It's passed the environment and template name and has to return a
tuple in the form ``(source, filename, uptodate)`` or raise a
`TemplateNotFound` error if it can't locate the template.
The source part of the returned tuple must be the source of the
template as unicode string or a ASCII bytestring. The filename should
be the name of the file on the filesystem if it was loaded from there,
otherwise `None`. The filename is used by python for the tracebacks
if no loader extension is used.
The last item in the tuple is the `uptodate` function. If auto
reloading is enabled it's always called to check if the template
changed. No arguments are passed so the function must store the
old state somewhere (for example in a closure). If it returns `False`
the template will be reloaded.
z&%s cannot provide access to the sourceN)�has_source_access� RuntimeError� __class__�__name__r )�self� environmentr r r r �
get_sourceF s zBaseLoader.get_sourcec C s t d��dS )z�Iterates over all templates. If the loader does not support that
it should raise a :exc:`TypeError` which is the default behavior.
z-this loader cannot iterate over all templatesN)� TypeError)r r r r �list_templates] s zBaseLoader.list_templatesNc
C s� d}|dkri }| j ||�\}}}|j}|dk rF|j||||�} | j}|dkr\|j|||�}|dk r~| jdkr~|| _|j| � |jj||||�S )ac Loads a template. This method looks up the template in the cache
or loads one by calling :meth:`get_source`. Subclasses should not
override this method as loaders working on collections of other
loaders (such as :class:`PrefixLoader` or :class:`ChoiceLoader`)
will not call this method but `get_source` directly.
N)r Zbytecode_cacheZ
get_bucket�code�compileZ
set_bucket�template_classZ from_code)
r r �name�globalsr �source�filename�uptodateZbccZbucketr r r �loadc s
zBaseLoader.load)N) r �
__module__� __qualname__�__doc__r r r r r( r r r r r % s r c @ s* e Zd ZdZd dd�Zdd� Zdd � Zd
S ) �FileSystemLoadera" Loads templates from the file system. This loader can find templates
in folders on the file system and is the preferred way to load them.
The loader takes the path to the templates as string, or if multiple
locations are wanted a list of them which is then looked up in the
given order::
>>> loader = FileSystemLoader('/path/to/templates')
>>> loader = FileSystemLoader(['/path/to/templates', '/other/path'])
Per default the template encoding is ``'utf-8'`` which can be changed
by setting the `encoding` parameter to something else.
To follow symbolic links, set the *followlinks* parameter to ``True``::
>>> loader = FileSystemLoader('/path/to/templates', followlinks=True)
.. versionchanged:: 2.8+
The *followlinks* parameter was added.
�utf-8Fc C s* t |t�r|g}t|�| _|| _|| _d S )N)�
isinstancer �list�
searchpath�encoding� followlinks)r r0 r1 r2 r r r �__init__� s
zFileSystemLoader.__init__c s� t |�}xp| jD ]f}tj|f|�� � t� �}|d kr6qz|j� j| j�}W d |j� X tj � ��� �fdd�}|� |fS W t
|��d S )Nc s( yt j� ��kS tk
r" dS X d S )NF)r �getmtime�OSErrorr )r& �mtimer r r' � s z-FileSystemLoader.get_source.<locals>.uptodate) r r0 r �joinr �read�decoder1 �closer4 r )r r r r r0 �f�contentsr' r )r& r6 r r � s
zFileSystemLoader.get_sourcec C s� t � }x�| jD ]�}tj|| jd�}x~|D ]v\}}}xj|D ]b}tjj||�t|�d � jtjj �j
tjj d�}|d d� dkr�|dd � }||kr8|j |� q8W q(W qW t |�S )N)r2 r
� z./)
�setr0 �os�walkr2 r r7 �len�stripr
�replace�add�sorted) r �foundr0 Zwalk_dir�dirpathZdirnames� filenamesr& r r r r r � s
z FileSystemLoader.list_templatesN)r- F)r r) r* r+ r3 r r r r r r r, � s
r, c @ s* e Zd ZdZd dd�Zdd� Zdd � Zd
S ) �
PackageLoadera, Load templates from python eggs or packages. It is constructed with
the name of the python package and the path to the templates in that
package::
loader = PackageLoader('mypackage', 'views')
If the package path is not given, ``'templates'`` is assumed.
Per default the template encoding is ``'utf-8'`` which can be changed
by setting the `encoding` parameter to something else. Due to the nature
of eggs it's only possible to reload templates if the package was loaded
from the file system and not a zip file.
� templates�utf-8c C sF ddl m}m}m} ||�}|| _|� | _t||�| _|| _|| _ d S )Nr )�DefaultProvider�ResourceManager� get_provider)
Z
pkg_resourcesrL rM rN r1 �managerr. �filesystem_bound�provider� package_path)r � package_namerR r1 rL rM rN rQ r r r r3 � s zPackageLoader.__init__c s� t |�}dj| jft|� �}| jj|�s2t|��d � }| jrh| jj| j |�� t
j � ��� �fdd�}| jj | j |�}|j
| j�� |fS )Nr
c s( yt j� ��kS tk
r" dS X d S )NF)r r4 r5 r )r& r6 r r r' � s z*PackageLoader.get_source.<locals>.uptodate)r r7 rR �tuplerQ Z has_resourcer rP Zget_resource_filenamerO r r4 Zget_resource_stringr9 r1 )r r r r �pr' r% r )r& r6 r r � s
zPackageLoader.get_sourcec sb �j }|d d� dkr$|dd � }n |dkr0d}t|��g �� ���fdd�� � |� �j� �S )Nr= z./r � c sT xN�j j| �D ]>}| d | }�j j|�r4� |� q�j|�d � jd�� qW d S )Nr
)rQ Zresource_listdirZresource_isdirr �lstrip)r r& �fullname)�_walk�offset�resultsr r r rY s
z+PackageLoader.list_templates.<locals>._walk)rR rA �sort)r r r )rY rZ r[ r r r � s z PackageLoader.list_templatesN)rJ rK )r r) r* r+ r3 r r r r r r rI � s
rI c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
DictLoadera Loads a template from a python dict. It's passed a dict of unicode
strings bound to template names. This loader is useful for unittesting:
>>> loader = DictLoader({'index.html': 'source here'})
Because auto reloading is rarely useful this is disabled per default.
c C s
|| _ d S )N)�mapping)r r^ r r r r3 s zDictLoader.__init__c s6 �� j kr*� j � ��d � ��fdd�fS t���d S )Nc s �� j j��kS )N)r^ �getr )r r% r r r �<lambda> s z'DictLoader.get_source.<locals>.<lambda>)r^ r )r r r r )r r% r r r s
zDictLoader.get_sourcec C s
t | j�S )N)rE r^ )r r r r r s zDictLoader.list_templatesN)r r) r* r+ r3 r r r r r r r] s r] c @ s e Zd ZdZdd� Zdd� ZdS )�FunctionLoadera� A loader that is passed a function which does the loading. The
function receives the name of the template and has to return either
an unicode string with the template source, a tuple in the form ``(source,
filename, uptodatefunc)`` or `None` if the template does not exist.
>>> def load_template(name):
... if name == 'index.html':
... return '...'
...
>>> loader = FunctionLoader(load_template)
The `uptodatefunc` is a function that is called if autoreload is enabled
and has to return `True` if the template is still up to date. For more
details have a look at :meth:`BaseLoader.get_source` which has the same
return value.
c C s
|| _ d S )N)� load_func)r rb r r r r3 6 s zFunctionLoader.__init__c C s4 | j |�}|d kr t|��nt|t�r0|d d fS |S )N)rb r r. r )r r r �rvr r r r 9 s
zFunctionLoader.get_sourceN)r r) r* r+ r3 r r r r r ra $ s ra c @ s@ e Zd ZdZddd�Zdd� Zdd� Zedd
d ��Zd d
� Z d S )� PrefixLoadera A loader that is passed a dict of loaders where each loader is bound
to a prefix. The prefix is delimited from the template by a slash per
default, which can be changed by setting the `delimiter` argument to
something else::
loader = PrefixLoader({
'app1': PackageLoader('mypackage.app1'),
'app2': PackageLoader('mypackage.app2')
})
By loading ``'app1/index.html'`` the file from the app1 package is loaded,
by loading ``'app2/index.html'`` the file from the second.
r
c C s || _ || _d S )N)r^ � delimiter)r r^ re r r r r3 Q s zPrefixLoader.__init__c C sJ y |j | jd�\}}| j| }W n ttfk
r@ t|��Y nX ||fS )N� )r re r^ �
ValueError�KeyErrorr )r r �prefixr# �loaderr r r �
get_loaderU s zPrefixLoader.get_loaderc C s< | j |�\}}y |j||�S tk
r6 t|��Y nX d S )N)rk r r )r r r rj r# r r r r ] s
zPrefixLoader.get_sourceNc C s> | j |�\}}y|j|||�S tk
r8 t|��Y nX d S )N)rk r( r )r r r# r$ rj Z
local_namer r r r( f s
zPrefixLoader.loadc C sF g }x<t | j�D ].\}}x$|j� D ]}|j|| j | � q"W qW |S )N)r r^ r r re )r �resultri rj r r r r r p s
zPrefixLoader.list_templates)r
)N)
r r) r* r+ r3 rk r r r( r r r r r rd B s
rd c @ s6 e Zd ZdZdd� Zdd� Zed dd��Zd d
� ZdS ) � ChoiceLoadera� This loader works like the `PrefixLoader` just that no prefix is
specified. If a template could not be found by one loader the next one
is tried.
>>> loader = ChoiceLoader([
... FileSystemLoader('/path/to/user/templates'),
... FileSystemLoader('/path/to/system/templates')
... ])
This is useful if you want to allow users to override builtin templates
from a different location.
c C s
|| _ d S )N)�loaders)r rn r r r r3 � s zChoiceLoader.__init__c C s> x0| j D ]&}y |j||�S tk
r, Y qX qW t|��d S )N)rn r r )r r r rj r r r r � s
zChoiceLoader.get_sourceNc C s@ x2| j D ](}y|j|||�S tk
r. Y qX qW t|��d S )N)rn r( r )r r r# r$ rj r r r r( � s
zChoiceLoader.loadc C s, t � }x | jD ]}|j|j� � qW t|�S )N)r> rn �updater rE )r rF rj r r r r � s zChoiceLoader.list_templates)N) r r) r* r+ r3 r r r( r r r r r rm x s rm c @ s e Zd ZdZdS )�_TemplateModulez9Like a normal module but with support for weak referencesN)r r) r* r+ r r r r rp � s rp c @ sB e Zd ZdZdZdd� Zedd� �Zedd� �Ze d d
d ��Z
d S )
� ModuleLoadera6 This loader loads templates from precompiled templates.
Example usage:
>>> loader = ChoiceLoader([
... ModuleLoader('/path/to/compiled/templates'),
... FileSystemLoader('/path/to/templates')
... ])
Templates can be precompiled with :meth:`Environment.compile_templates`.
Fc s^ dt | � � t� �}t|t�r&|g}nt|�}||_tj|� fdd��tj � < || _
� | _ d S )Nz_jinja2_module_templates_%xc s t jj� d �S )N)�sys�modules�pop)�x)rS r r r` � s z'ModuleLoader.__init__.<locals>.<lambda>) �idrp r. r r/ �__path__�weakref�proxyrr rs �modulerS )r r �modr )rS r r3 � s
zModuleLoader.__init__c C s dt | jd��j� S )NZtmpl_zutf-8)r �encodeZ hexdigest)r# r r r �get_template_key� s z ModuleLoader.get_template_keyc C s t j| �d S )Nz.py)rq r} )r# r r r �get_module_filename� s z ModuleLoader.get_module_filenameNc C s� | j |�}d| j|f }t| j|d �}|d krnyt|d d dg�}W n tk
r^ t|��Y nX tjj |d � |j
j ||j |�S )Nz%s.%s�root)
r} rS �getattrrz �
__import__� ImportErrorr rr rs rt r" Zfrom_module_dict�__dict__)r r r# r$ �keyrz r{ r r r r( � s
zModuleLoader.load)N) r r) r* r+ r r3 � staticmethodr} r~ r r( r r r r rq � s rq ) r+ r? rr rx �typesr r Zhashlibr Zjinja2.exceptionsr Z jinja2.utilsr r Zjinja2._compatr r r �objectr r, rI r] ra rd rm rp rq r r r r �<module>
s& eCA 6)