3
U'ícâX ã @ sN d Z ddlZddlZddlZddlZddlZddlZddl m
Z
ddl m Z ddlm
Z
ddlmZ ddlmZ dd lmZ dd
lmZ ejr¦dd lmZ dd lmZ eeje d
ddZG dd dZ G dd de Z G dd de Z G dd de Z G dd de Z G dd de Z!G d d d e Z"G d d d eZ#G d d! d!e Z$dS )"zKAPI and implementations for loading templates from different data
sources.
é N)Úabc)Úsha1)Ú
import_module)Ú
ModuleTypeé )ÚTemplateNotFound)Ú internalcode)Úopen_if_exists)Ú Environment)ÚTemplate)ÚtemplateÚreturnc C sh g }x^| j dD ]P}tjj|ks@tjjr4tjj|ks@|tjjkrJt| q|r|dkr|j| qW |S )zSplit a path into segments and perform a sanity check. If it detects
'..' in the path it will raise a `TemplateNotFound` error.
ú/Ú.)ÚsplitÚosÚpathÚsepÚaltsepÚpardirr Úappend)r ÚpiecesZpiece© r ú0/tmp/pip-build-gk9425m9/Jinja2/jinja2/loaders.pyÚsplit_template_path s
r c @ s e Zd ZdZdZdeejeeje ejej g e
f f dddZ ej e ddd Z
eddeejejeejf d d d
dZd
S )Ú
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 open(path) as f:
source = f.read()
return source, path, lambda: mtime == getmtime(path)
Tr
)Ú environmentr r
c C s& | j stt| j dt|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 a string. 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$ cannot provide access to the sourceN)Úhas_source_accessÚ RuntimeErrorÚtypeÚ__name__r )Úselfr r r r r Ú
get_sourceJ s zBaseLoader.get_source)r
c C s t ddS )zIterates 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_templatesd s zBaseLoader.list_templatesNr )r ÚnameÚglobalsr
c
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 r% r& r' ÚsourceÚfilenameÚuptodateZbccZbucketr r r Úloadj s
zBaseLoader.load)N)r Ú
__module__Ú __qualname__Ú__doc__r ÚstrÚtÚTupleÚOptionalÚCallableÚboolr" ÚListr$ r ÚMutableMappingÚAnyr- r r r r r ) s 0r c @ s e Zd ZdZdejeejej ejeejf f ee
ddddZ deej eeej
g e
f f d d
d Zeje d d
dZdS )ÚFileSystemLoadera Load templates from a directory in the file system.
The path can be relative or absolute. Relative paths are relative to
the current working directory.
.. code-block:: python
loader = FileSystemLoader("templates")
A list of paths can be given. The directories will be searched in
order, stopping at the first matching template.
.. code-block:: python
loader = FileSystemLoader(["/override/templates", "/default/templates"])
:param searchpath: A path, or list of paths, to the directory that
contains the templates.
:param encoding: Use this encoding to read the text from template
files.
:param followlinks: Follow symbolic links in the path.
.. versionchanged:: 2.8
Added the ``followlinks`` parameter.
úutf-8FN)Ú
searchpathÚencodingÚ followlinksr
c C s> t |tj st |tr |g}dd |D | _|| _|| _d S )Nc S s g | ]}t j|qS r )r Úfspath)Ú.0Úpr r r ú
<listcomp>» s z-FileSystemLoader.__init__.<locals>.<listcomp>)Ú
isinstancer ÚIterabler1 r< r= r> )r! r< r= r> r r r Ú__init__² s
zFileSystemLoader.__init__r
)r r r
c
s t |}xz| jD ]p}tjj|f| t }|d kr8qz|j j| j}W d |j X tjj
t d fdd }| |fS W t |d S )N)r
c s* yt jj kS tk
r$ dS X d S )NF)r r ÚgetmtimeÚOSErrorr )r+ Úmtimer r r, Ï s z-FileSystemLoader.get_source.<locals>.uptodate)
r r< r r Újoinr ÚreadÚdecoder= ÚcloserF r6 r )r! r r r r< ÚfÚcontentsr, r )r+ rH r r" ¿ s
zFileSystemLoader.get_source)r
c 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)r> r é z./)
Úsetr< r Úwalkr> r rI ÚlenÚstripr ÚreplaceÚaddÚsorted) r! Úfoundr< Zwalk_dirÚdirpathÚ_Ú filenamesr+ r r r r r$ Ø s
z FileSystemLoader.list_templates)r; F)r r. r/ r0 r2 ÚUnionr1 r ÚPathLikeÚSequencer6 rE r3 r5 r" r7 r$ r r r r r: s ( $r: c @ sh e Zd ZdZdededdddZd eejeeejej g e
f f d
d d Z ej e d
ddZ
dS )Ú
PackageLoaderal Load templates from a directory in a Python package.
:param package_name: Import name of the package that contains the
template directory.
:param package_path: Directory within the imported package that
contains the templates.
:param encoding: Encoding of template files.
The following example looks up templates in the ``pages`` directory
within the ``project.ui`` package.
.. code-block:: python
loader = PackageLoader("project.ui", "pages")
Only packages installed as directories (standard pip behavior) or
zip/egg files (less common) are supported. The Python API for
introspecting data in packages is too limited to support other
installation methods the way this loader requires.
There is limited support for :pep:`420` namespace packages. The
template directory is assumed to only be in one namespace
contributor. Zip files contributing to a namespace are not
supported.
.. versionchanged:: 3.0
No longer uses ``setuptools`` as a dependency.
.. versionchanged:: 3.0
Limited PEP 420 namespace package support.
Ú templatesúutf-8r1 N)Ú package_nameÚ package_pathr= r
c
C sl t jj|jt jj}|t jjkr(d}n(|d d
t jjt jj krP|dd
}|| _|| _|| _t | t
j j |}|d k st
d|j}|d k st
d|| _d | _d }t|tjrÞ|j| _tt|j}t jj||}njg }|jrö|j|j n |jd k r|jt jj |j x0|D ](} t jj| |} t jj | r | }P q W |d krbt d|d|| _ d S )NÚ rO z-An import spec was not found for the package.z'A loader was not found for the package.zThe zC package was not installed in a way that PackageLoader understands.) r r ÚnormpathÚrstripr Úcurdirrb ra r= r Ú importlibÚutilÚ find_specÚAssertionErrorÚloaderÚ_loaderÚ_archiverC Ú zipimportÚ zipimporterÚarchiveÚnextÚiterÚsubmodule_search_locationsrI ÚextendÚoriginr ÚdirnameÚisdirÚ
ValueErrorÚ_template_root)
r! ra rb r= Úspecrk Z
template_rootZpkgdirÚrootsÚrootr r r rE sD
zPackageLoader.__init__r
)r r r
c sÊ t jj| jft| | jd krvt jjs6t|td}|j }W d Q R X t jj
t d fdd }nBy| j j
}W n, tk
r² } zt||W Y d d }~X nX d }|j| j|fS )NÚrb)r
c s t jjot jj kS )N)r r ÚisfilerF r )rH rA r r Ú
up_to_dateV s z,PackageLoader.get_source.<locals>.up_to_date)r r rI ry r rm r~ r ÚopenrJ rF r6 rl Úget_datarG rK r= )r! r r rM r* r Úer )rH rA r r" F s
zPackageLoader.get_source)r
c s g }| j d krdt| j}xÚtj| jD ]8\ }} |d
jtjj |j fdd|D q&W nt | j
dsxt d| jt| j d
jtjjtjj }t|}xL| j
j j
D ]<}|j|r´|d tjjkr´|j||d
jtjjd q´W |j |S )Nc 3 s( | ] }t jj |jt jjd V qdS )r N)r r rI rT r )r@ r% )rX r r ú <genexpr>q s z/PackageLoader.list_templates.<locals>.<genexpr>Ú_fileszFThis zip import does not have the required metadata to list templates.r r éÿÿÿÿ)rm rR ry r rQ Úlstripr r rt Úhasattrrl r# r ÚkeysÚ
startswithr rT Úsort)r! ÚresultsÚoffsetrY rZ Úprefixr% r )rX r r$ g s&
"z PackageLoader.list_templates)r_ r` )r r. r/ r0 r1 rE r2 r3 r4 r5 r6 r" r7 r$ r r r r r^ ê s 7* r^ c @ sf e Zd ZdZejeef ddddZdeejedej g e
f f ddd Z ej e d
d d Z
dS )
Ú
DictLoadera Loads a template from a Python dict mapping template names to
template source. This loader is useful for unittesting:
>>> loader = DictLoader({'index.html': 'source here'})
Because auto reloading is rarely useful this is disabled per default.
N)Úmappingr
c C s
|| _ d S )N)r )r! r r r r rE s zDictLoader.__init__r
)r r r
c s6 j kr* j d fddfS td S )Nc s j jkS )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_source)r
c C s
t | jS )N)rV r )r! r r r r$ s zDictLoader.list_templates)r r. r/ r0 r2 ÚMappingr1 rE r3 r5 r6 r" r7 r$ r r r r r s
$r c @ s e Zd ZdZejegejejeej eeje ejejg e
f f f f ddddZ deej eeje ejejg e
f f ddd Z dS )
Ú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
a 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.
N)Ú load_funcr
c C s
|| _ d S )N)r )r! r r r r rE µ s zFunctionLoader.__init__r
)r r r
c C s2 | j |}|d krt|t|tr.|d d fS |S )N)r r rC r1 )r! r r Úrvr r r r" Â s
zFunctionLoader.get_source)
r r. r/ r0 r2 r5 r1 r4 r[ r3 r6 rE r" r r r r r £ s 0r c @ s¼ e Zd ZdZdejeef eddddZeej eef ddd Z
d
eej eej e ej ej g e
f f d d d
Zedd
eej ejeejf ddddZeje dddZdS )Ú 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 N)r Ú delimiterr
c C s || _ || _d S )N)r r )r! r r r r r rE ß s zPrefixLoader.__init__)r r
c C sZ y |j | jd\}}| j| }W n0 ttfk
rP } zt||W Y d d }~X nX ||fS )Nr )r r r rx ÚKeyErrorr )r! r r r% rk r r r r Ú
get_loaderå s zPrefixLoader.get_loaderr
)r r r
c C sL | j |\}}y |j||S tk
rF } zt||W Y d d }~X nX d S )N)r r" r )r! r r rk r% r r r r r" í s
zPrefixLoader.get_sourcer )r r% r& r
c C sN | j |\}}y|j|||S tk
rH } zt||W Y d d }~X nX d S )N)r r- r )r! r r% r& rk Z
local_namer r r r r- ø s
zPrefixLoader.load)r
c C sF g }x<| j j D ].\}}x$|j D ]}|j|| j | q"W qW |S )N)r Úitemsr$ r r )r! Úresultr rk r r r r r$ s
zPrefixLoader.list_templates)r )N)r r. r/ r0 r2 r r1 r rE r3 r r4 r5 r6 r" r r8 r9 r- r7 r$ r r r r r Ð s
0 r c @ s e Zd ZdZeje ddddZdeej eej
e ej
ej g e f f ddd Z
eddeej
ejeejf d
d d d
Zeje dddZdS )Ú 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.
N)Úloadersr
c C s
|| _ d S )N)r )r! r r r r rE s zChoiceLoader.__init__r
)r r r
c C s> x0| j D ]&}y |j||S tk
r, Y qX qW t|d S )N)r r" r )r! r r rk r r r r" s
zChoiceLoader.get_sourcer )r r% r& r
c C s@ x2| j D ](}y|j|||S tk
r. Y qX qW t|d S )N)r r- r )r! r r% r& rk r r r r- * s
zChoiceLoader.load)r
c C s, t }x | jD ]}|j|j qW t|S )N)rP r Úupdater$ rV )r! rW rk r r r r$ 8 s zChoiceLoader.list_templates)N)r r. r/ r0 r2 r] r rE r1 r3 r4 r5 r6 r" r r8 r9 r- r7 r$ r r r r r s 0r c @ s e Zd ZdZdS )Ú_TemplateModulez9Like a normal module but with support for weak referencesN)r r. r/ r0 r r r r r ? s r c @ s e Zd ZdZdZejeej ej
ejeej f f ddddZ e eeddd Z
e eedd
d Zedd eejejeejf d
dddZdS )Ú 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`.
FN)r r
c sp dt | d t }t|tj s0t|tr6|g}dd |D |_tj| fddt j
< || _ | _ d S )NZ_jinja2_module_templates_Úxc S s g | ]}t j|qS r )r r? )r@ rA r r r rB ^ s z)ModuleLoader.__init__.<locals>.<listcomp>c s t jj d S )N)ÚsysÚmodulesÚpop)r¡ )ra r r r a s z'ModuleLoader.__init__.<locals>.<lambda>)
Úidr rC r rD r1 Ú__path__ÚweakrefÚproxyr¢ r£ Úmodulera )r! r Úmodr )ra r rE R s zModuleLoader.__init__)r% r
c C s dt | jdj S )NZtmpl_zutf-8)r ÚencodeÚ hexdigest)r% r r r Úget_template_keyj s z ModuleLoader.get_template_keyc C s t j| d S )Nz.py)r r )r% r r r Úget_module_filenamen s z ModuleLoader.get_module_filenamer
r )r r% r& r
c C s | j |}| j d| }t| j|d }|d kryt|d d dg}W n, tk
rp } zt||W Y d d }~X nX tjj |d |d kri }|j
j ||j |S )Nr r| )
r ra Úgetattrr© Ú
__import__Ú ImportErrorr r¢ r£ r¤ r) Zfrom_module_dictÚ__dict__)r! r r% r& Úkeyr© rª r r r r r- r s
zModuleLoader.load)N)r r. r/ r0 r r2 r[ r1 r r\ r] rE Ú staticmethodr r® r r4 r8 r9 r- r r r r r C s "r )%r0 Úimportlib.utilrg r r¢ Útypingr2 r§ rn Ú collectionsr Úhashlibr r Útypesr Ú
exceptionsr Úutilsr r Z
TYPE_CHECKINGr r
r r1 r7 r r r: r^ r r r r r r r r r r Ú<module> s6 nS "-?0