3
G\1 @ s d Z ddlmZmZ ddlZddlZddlZddlZddlZddlZddl Z ddl
m Z ddl m
Z
ddlmZmZmZmZ esejZejZndd Zd d
Zd Zd jd
ejed ejejd d> ejd B ZG dd de Z G dd de Z G dd de Z G dd de Z dS )a
jinja2.bccache
~~~~~~~~~~~~~~
This module implements the bytecode cache system Jinja is optionally
using. This is useful if you have very complex template situations and
the compiliation of all those templates slow down your application too
much.
Situations where this is useful are often forking web applications that
are initialized on the first request.
:copyright: (c) 2017 by the Jinja Team.
:license: BSD.
)pathlistdirN)sha1)open_if_exists)BytesIOpicklePY2 text_typec C s, t |trtj| | n|jtj| d S )N)
isinstancefilemarshaldumpwritedumps)codef r /usr/lib/python3.6/bccache.py marshal_dump$ s
r c C s" t | trtj| S tj| j S )N)r
r r loadloadsread)r r r r marshal_load* s
r Zj2ascii c @ s@ e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dS )Bucketau Buckets are used to store the bytecode for one template. It's created
and initialized by the bytecode cache and passed to the loading functions.
The buckets get an internal checksum from the cache assigned and use this
to automatically reject outdated cache material. Individual bytecode
cache subclasses don't have to care about cache invalidation.
c C s || _ || _|| _| j d S )N) environmentkeychecksumreset)selfr r r! r r r __init__E s zBucket.__init__c C s
d| _ dS )z)Resets the bucket (unloads the bytecode).N)r )r# r r r r" K s z Bucket.resetc
C sx |j tt}|tkr"| j dS tj|}| j|krB| j dS yt|| _W n" t t
t fk
rr | j dS X dS )z/Loads bytecode from a file or file like object.N) r lenbc_magicr" r r r! r r EOFError
ValueError TypeError)r# r magicr! r r r
load_bytecodeO s
zBucket.load_bytecodec C s< | j dkrtd|jt tj| j|d t| j | dS )z;Dump the bytecode into the file or file like object passed.Nzcan't write empty bucketr )r r) r r& r r
r! r )r# r r r r write_bytecodeb s
zBucket.write_bytecodec C s | j t| dS )z Load bytecode from a string.N)r+ r )r# stringr r r bytecode_from_stringj s zBucket.bytecode_from_stringc C s t }| j| |j S )z Return the bytecode as string.)r r, getvalue)r# outr r r bytecode_to_stringn s
zBucket.bytecode_to_stringN)
__name__
__module__ __qualname____doc__r$ r" r+ r, r. r1 r r r r r < s r c @ sJ e Zd ZdZdd Zdd Zdd Zdd d
Zd d Zd
d Z dd Z
dS )
BytecodeCachea To implement your own bytecode cache you have to subclass this class
and override :meth:`load_bytecode` and :meth:`dump_bytecode`. Both of
these methods are passed a :class:`~jinja2.bccache.Bucket`.
A very basic bytecode cache that saves the bytecode on the file system::
from os import path
class MyCache(BytecodeCache):
def __init__(self, directory):
self.directory = directory
def load_bytecode(self, bucket):
filename = path.join(self.directory, bucket.key)
if path.exists(filename):
with open(filename, 'rb') as f:
bucket.load_bytecode(f)
def dump_bytecode(self, bucket):
filename = path.join(self.directory, bucket.key)
with open(filename, 'wb') as f:
bucket.write_bytecode(f)
A more advanced version of a filesystem based bytecode cache is part of
Jinja2.
c C s
t dS )zSubclasses have to override this method to load bytecode into a
bucket. If they are not able to find code in the cache for the
bucket, it must not do anything.
N)NotImplementedError)r# bucketr r r r+ s zBytecodeCache.load_bytecodec C s
t dS )zSubclasses have to override this method to write the bytecode
from a bucket back to the cache. If it unable to do so it must not
fail silently but raise an exception.
N)r7 )r# r8 r r r
dump_bytecode s zBytecodeCache.dump_bytecodec C s dS )zClears the cache. This method is not used by Jinja2 but should be
implemented to allow applications to clear the bytecode cache used
by a particular environment.
Nr )r# r r r clear s zBytecodeCache.clearNc C sD t |jd}|dk r )r# sourcer r r get_source_checksum s z!BytecodeCache.get_source_checksumc C s0 | j ||}| j|}t|||}| j| |S )zwReturn a cache bucket for the given template. All arguments are
mandatory but filename may be `None`.
)rB rD r r+ )r# r r? r@ rC r r! r8 r r r
get_bucket s
zBytecodeCache.get_bucketc C s | j | dS )z Put the bucket into the cache.N)r9 )r# r8 r r r
set_bucket s zBytecodeCache.set_bucket)N) r2 r3 r4 r5 r+ r9 r: rB rD rE rF r r r r r6 u s
r6 c @ sB e Zd ZdZdddZdd Zdd Zd
d Zd d
Zdd Z dS )FileSystemBytecodeCachea A bytecode cache that stores bytecode on the filesystem. It accepts
two arguments: The directory where the cache items are stored and a
pattern string that is used to build the filename.
If no directory is specified a default cache directory is selected. On
Windows the user's temp directory is used, on UNIX systems a directory
is created for the user in the system temp directory.
The pattern can be used to have multiple separate caches operate on the
same directory. The default pattern is ``'__jinja2_%s.cache'``. ``%s``
is replaced with the cache key.
>>> bcc = FileSystemBytecodeCache('/tmp/jinja_cache', '%s.cache')
This bytecode cache supports clearing of the cache using the clear method.
N__jinja2_%s.cachec C s |d kr| j }|| _|| _d S )N)_get_default_cache_dir directorypattern)r# rJ rK r r r r$ s z FileSystemBytecodeCache.__init__c C sZ dd }t j }tjdkr |S ttds.| dtj }tjj||}ytj|t j
W n0 t k
r } z|j t j
krz W Y d d }~X nX yPtj|t j
tj|}|jtj kst j|j st j|jt j
kr| W n4 t k
r } z|j t j
kr W Y d d }~X nX tj|}|jtj ksPt j|j sPt j|jt j
krV| |S )Nc S s t dd S )NzJCannot determine safe temp directory. You need to explicitly provide one.) RuntimeErrorr r r r _unsafe_dir s zCFileSystemBytecodeCache._get_default_cache_dir.._unsafe_dirntgetuidz_jinja2-cache-%d)tempfileZ
gettempdirosr? hasattrrO r joinmkdirstatS_IRWXUOSErrorerrnoZEEXISTchmodlstatst_uidS_ISDIRst_modeS_IMODE)r# rM ZtmpdirdirnameZ
actual_direZactual_dir_statr r r rI s:
z.FileSystemBytecodeCache._get_default_cache_dirc C s t j| j| j|j S )N)r rS rJ rK r )r# r8 r r r _get_cache_filename s z+FileSystemBytecodeCache._get_cache_filenamec
C s6 t | j|d}|d k r2z|j| W d |j X d S )Nrb)r ra r+ close)r# r8 r r r r r+ s
z%FileSystemBytecodeCache.load_bytecodec
C s. t | j|d}z|j| W d |j X d S )Nwb)openra r, rc )r# r8 r r r r r9 s z%FileSystemBytecodeCache.dump_bytecodec C sb ddl m} tjt| j| jd }x8|D ]0}y|tj| j| W q* t k
rX Y q*X q*W d S )Nr )remove*)
rQ rf fnmatchfilterr rJ rK r rS rW )r# rf filesr@ r r r r: s
z FileSystemBytecodeCache.clear)NrH )
r2 r3 r4 r5 r$ rI ra r+ r9 r: r r r r rG s
)rG c @ s* e Zd ZdZd ddZdd Zd d
ZdS ) MemcachedBytecodeCacheav This class implements a bytecode cache that uses a memcache cache for
storing the information. It does not enforce a specific memcache library
(tummy's memcache or cmemcache) but will accept any class that provides
the minimal interface required.
Libraries compatible with this class:
- `werkzeug `_.contrib.cache
- `python-memcached `_
- `cmemcache `_
(Unfortunately the django cache interface is not compatible because it
does not support storing binary data, only unicode. You can however pass
the underlying cache client to the bytecode cache which is available
as `django.core.cache.cache._client`.)
The minimal interface for the client passed to the constructor is this:
.. class:: MinimalClientInterface
.. method:: set(key, value[, timeout])
Stores the bytecode in the cache. `value` is a string and
`timeout` the timeout of the key. If timeout is not provided
a default timeout or no timeout should be assumed, if it's
provided it's an integer with the number of seconds the cache
item should exist.
.. method:: get(key)
Returns the value for the cache key. If the item does not
exist in the cache the return value must be `None`.
The other arguments to the constructor are the prefix for all keys that
is added before the actual cache key and the timeout for the bytecode in
the cache system. We recommend a high (or no) timeout.
This bytecode cache does not support clearing of used items in the cache.
The clear method is a no-operation function.
.. versionadded:: 2.7
Added support for ignoring memcache errors through the
`ignore_memcache_errors` parameter.
jinja2/bytecode/NTc C s || _ || _|| _|| _d S )N)clientprefixtimeoutignore_memcache_errors)r# rm rn ro rp r r r r$ Q s z MemcachedBytecodeCache.__init__c C sP y| j j| j|j }W n tk
r8 | js0 d }Y nX |d k rL|j| d S )N)rm getrn r Exceptionrp r. )r# r8 r r r r r+ X s
z$MemcachedBytecodeCache.load_bytecodec C s\ | j |j |j f}| jd k r*|| jf7 }y| jj| W n tk
rV | jsR Y nX d S )N)rn r r1 ro rm setrr rp )r# r8 argsr r r r9 b s
z$MemcachedBytecodeCache.dump_bytecode)rl NT)r2 r3 r4 r5 r$ r+ r9 r r r r rk # s
,
rk )!r5 rQ r r sysrU rX r rP rh Zhashlibr Z jinja2.utilsr Zjinja2._compatr r r r r
r r r Z
bc_versionr< r version_infor& objectr r6 rG rk r r r r s. 9N`