Current File : //opt/alt/python37/lib/python3.7/site-packages/beaker/__pycache__/cache.cpython-37.pyc
B
��[�U � @ sr d Z ddlZddlmZ ddlmZmZmZmZ ddl m
Z
ddl m Z ddl
mZ ddlmZmZ ddlmZ ddlm mZ ddlm mZ ddlm mZ ddlm m Z ddl m m Z ddl m m Z ddl!m"Z" i Z#i Z$G d d
� d
e%�Z&e&e
j'e
j(e
j)ej*ej+ej,e j-e j.e j/d � �Z0d d
� Z1dd� Z2G dd� de%�Z3G dd� de%�Z4dd� Z5dd� Z6dS )z�This package contains the "front end" classes and functions
for Beaker caching.
Included are the :class:`.Cache` and :class:`.CacheManager` classes,
as well as the function decorators :func:`.region_decorate`,
:func:`.region_invalidate`.
� N)�chain)�u_� unicode_text�func_signature� bindfuncargs)�sha1)�BeakerException�InvalidCacheBackendError)�
_threading)�wrapsc @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) � _backendsFc C s || _ t�� | _d S )N)�_clsmapr
�Lock�_mutex)�self�clsmap� r �=/opt/alt/python37/lib/python3.7/site-packages/beaker/cache.py�__init__< s z_backends.__init__c C sr y
| j | S tk
rl } zD| jsX| j�� z | jsB| �� d| _| j | S | j�� X |�W d d }~X Y nX d S )NT)r
�KeyError� initializedr �acquire�_init�release)r �key�er r r � __getitem__@ s
z_backends.__getitem__c
C s �ydd l }x�|�d�D ]�}y2|�� }|j}|| jkrBtd| ��|| j|< W q ttfk
rf Y q dd l}ddl m } t
|� � d |�s�dd l }yddl
m
} W n tk
r� ddlm
} Y nX |� } |j| d� t�d|| �� f td � Y qX qW W n tk
�r Y nX d S )
Nr zbeaker.backendsz2NamespaceManager name conflict,'%s' already loaded)�DistributionNotFound� )�StringIO)�filez5Unable to load NamespaceManager entry point: '%s': %s� )�
pkg_resources�iter_entry_points�load�namer
r r � SyntaxError�sysr �
isinstance�exc_info� tracebackr � ImportError�io� print_exc�warnings�warn�getvalue�RuntimeWarning)
r r" Z entry_pointZnamespace_managerr% r' r r* r �tbr r r r Q s<
z_backends._initN)�__name__�
__module__� __qualname__r r r r r r r r r 9 s r ) �memoryZdbmr z
ext:memcachedz ext:databasezext:sqlaz
ext:googlez ext:mongodbz ext:redisc G s t |dd| �S )a�
Decorate a function such that its return result is cached,
using a "region" to indicate the cache arguments.
Example::
from beaker.cache import cache_regions, cache_region
# configure regions
cache_regions.update({
'short_term':{
'expire':60,
'type':'memory'
}
})
@cache_region('short_term', 'load_things')
def load(search_term, limit, offset):
'''Load from a database given a search term, limit, offset.'''
return database.query(search_term)[offset:offset + limit]
The decorator can also be used with object methods. The ``self``
argument is not part of the cache key. This is based on the
actual string name ``self`` being in the first argument
position (new in 1.6)::
class MyThing(object):
@cache_region('short_term', 'load_things')
def load(self, search_term, limit, offset):
'''Load from a database given a search term, limit, offset.'''
return database.query(search_term)[offset:offset + limit]
Classmethods work as well - use ``cls`` as the name of the class argument,
and place the decorator around the function underneath ``@classmethod``
(new in 1.6)::
class MyThing(object):
@classmethod
@cache_region('short_term', 'load_things')
def load(cls, search_term, limit, offset):
'''Load from a database given a search term, limit, offset.'''
return database.query(search_term)[offset:offset + limit]
:param region: String name of the region corresponding to the desired
caching arguments, established in :attr:`.cache_regions`.
:param \*args: Optional ``str()``-compatible arguments which will uniquely
identify the key used by this decorated function, in addition
to the positional arguments passed to the function itself at call time.
This is recommended as it is needed to distinguish between any two functions
or methods that have the same name (regardless of parent class or not).
.. note::
The function being decorated must only be called with
positional arguments, and the arguments must support
being stringified with ``str()``. The concatenation
of the ``str()`` version of each argument, combined
with that of the ``*args`` sent to the decorator,
forms the unique cache key.
.. note::
When a method on a class is decorated, the ``self`` or ``cls``
argument in the first position is
not included in the "key" used for caching. New in 1.6.
N)�_cache_decorate)�region�argsr r r � cache_region� s Dr: c G sT t | �r|s| j}| j} |s&td��nt| }t�| |�}t||�dt j
�|� dS )aB Invalidate a cache region corresponding to a function
decorated with :func:`.cache_region`.
:param namespace: The namespace of the cache to invalidate. This is typically
a reference to the original function (as returned by the :func:`.cache_region`
decorator), where the :func:`.cache_region` decorator applies a "memo" to
the function in order to locate the string name of the namespace.
:param region: String name of the region used with the decorator. This can be
``None`` in the usual case that the decorated function itself is passed,
not the string name of the namespace.
:param args: Stringifyable arguments that are used to locate the correct
key. This consists of the ``*args`` sent to the :func:`.cache_region`
decorator itself, plus the ``*args`` sent to the function itself
at runtime.
Example::
from beaker.cache import cache_regions, cache_region, region_invalidate
# configure regions
cache_regions.update({
'short_term':{
'expire':60,
'type':'memory'
}
})
@cache_region('short_term', 'load_data')
def load(search_term, limit, offset):
'''Load from a database given a search term, limit, offset.'''
return database.query(search_term)[offset:offset + limit]
def invalidate_search(search_term, limit, offset):
'''Invalidate the cached storage for a given search term, limit, offset.'''
region_invalidate(load, 'short_term', 'load_data', search_term, limit, offset)
Note that when a method on a class is decorated, the first argument ``cls``
or ``self`` is not included in the cache key. This means you don't send
it to :func:`.region_invalidate`::
class MyThing(object):
@cache_region('short_term', 'some_data')
def load(self, search_term, limit, offset):
'''Load from a database given a search term, limit, offset.'''
return database.query(search_term)[offset:offset + limit]
def invalidate_search(self, search_term, limit, offset):
'''Invalidate the cached storage for a given search term, limit, offset.'''
region_invalidate(self.load, 'short_term', 'some_data', search_term, limit, offset)
z1Region or callable function namespace is required�
key_lengthN) �callable� _arg_region�_arg_namespacer �
cache_regions�Cache�
_get_cache�_cache_decorator_invalidate�get�util�DEFAULT_CACHE_KEY_LENGTH)� namespacer8 r9 �cacher r r �region_invalidate� s 6
rH c @ s� e Zd ZdZd dd�Zedd� �Zdd � ZeZd
d � Z e Z
d d
� Z e Z dd� Z
e�d�dd� �Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � ZdS ) r@ aE Front-end to the containment API implementing a data cache.
:param namespace: the namespace of this Cache
:param type: type of cache to use
:param expire: seconds to keep cached data
:param expiretime: seconds to keep cached data (legacy support)
:param starttime: time when cache was cache was
r6 Nc K sz yt | }t|t�r|�W n tk
r: td| ��Y nX |d k rLt|�}|| _||f|�| _|pf|| _|| _ || _
d S )Nz Unknown cache implementation %r) r r( r r � TypeError�int�namespace_namerF �
expiretime� starttime�nsargs)r rF �typerL rM ZexpirerN �clsr r r r ! s
zCache.__init__c C sB |t |� }yt| S tk
r< | |f|� t|< }|S X d S )N)�str�cache_managersr )rP rF �kwr rG r r r rA 3 s zCache._get_cachec K s | j |f|��|� d S )N)�
_get_value� set_value)r r �valuerS r r r �put< s z Cache.putc K s | j |f|��� S )z*Retrieve a cached value from the container)rT � get_value)r r rS r r r rC @ s z Cache.getc K s | j |f|�}|�� d S )N)rT Z clear_value)r r rS Z mycontainerr r r � remove_valueE s zCache.remove_valuec K sZ t |t�r|�dd�}d|kr,| j|f|�S |�d| j� |�d| j� tj|| j f|�S )N�ascii�backslashreplacerO rL rM )
r( r �encode�_legacy_get_value�
setdefaultrL rM � container�ValuerF )r r rS r r r rT J s
zCache._get_valuez�Specifying a 'type' and other namespace configuration with cache.get()/put()/etc. is deprecated. Specify 'type' and other namespace configuration to cache_manager.get_cache() and/or the Cache constructor instead.c K sd |� d| j�}|� dd �}|� dd �}| j�� }|�|� t| jjfd|i|��}|j||||d�S )NrL rM �
createfuncrO )rL ra rM )�poprL rN �copy�updater@ rF rT ) r r rO rS rL rM ra �kwargs�cr r r r] V s
zCache._legacy_get_valuec C s | j �� dS )z'Clear all the values from the namespaceN)rF �remove)r r r r �cleard s z Cache.clearc C s
| � |�S )N)rC )r r r r r r i s zCache.__getitem__c C s | � |��� S )N)rT Zhas_current_value)r r r r r � __contains__l s zCache.__contains__c C s || kS )Nr )r r r r r �has_keyo s z
Cache.has_keyc C s | � |� d S )N)rY )r r r r r � __delitem__r s zCache.__delitem__c C s | � ||� d S )N)rW )r r rV r r r � __setitem__u s zCache.__setitem__)r6 NNN)r3 r4 r5 �__doc__r � classmethodrA rW rU rC rX rY rg rT rD Z
deprecatedr] rh r ri rj rk rl r r r r r@ s$
r@ c @ sD e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dS )� CacheManagerc K s$ || _ |�di �| _t�| j� dS )z�Initialize a CacheManager object with a set of options
Options should be parsed with the
:func:`~beaker.util.parse_cache_config_options` function to
ensure only valid options are used.
r? N)re rb �regionsr? rd )r re r r r r z s zCacheManager.__init__c K s | j �� }|�|� t�||�S )N)re rc rd r@ rA )r r% re rS r r r � get_cache� s
zCacheManager.get_cachec C s, || j krtd| ��| j | }t�||�S )Nz Cache region not configured: %s)rp r r@ rA )r r% r8 rS r r r �get_cache_region� s
z CacheManager.get_cache_regionc G s t |f|�� S )aH Decorate a function to cache itself using a cache region
The region decorator requires arguments if there are more than
two of the same named function, in the same module. This is
because the namespace used for the functions cache is based on
the functions name and the module.
Example::
# Assuming a cache object is available like:
cache = CacheManager(dict_of_config_options)
def populate_things():
@cache.region('short_term', 'some_data')
def load(search_term, limit, offset):
return load_the_data(search_term, limit, offset)
return load('rabbits', 20, 0)
.. note::
The function being decorated must only be called with
positional arguments.
)r: )r r8 r9 r r r r8 � s zCacheManager.regionc G s t ||f|�� S )a� Invalidate a cache region namespace or decorated function
This function only invalidates cache spaces created with the
cache_region decorator.
:param namespace: Either the namespace of the result to invalidate, or the
cached function
:param region: The region the function was cached to. If the function was
cached to a single region then this argument can be None
:param args: Arguments that were used to differentiate the cached
function as well as the arguments passed to the decorated
function
Example::
# Assuming a cache object is available like:
cache = CacheManager(dict_of_config_options)
def populate_things(invalidate=False):
@cache.region('short_term', 'some_data')
def load(search_term, limit, offset):
return load_the_data(search_term, limit, offset)
# If the results should be invalidated first
if invalidate:
cache.region_invalidate(load, None, 'some_data',
'rabbits', 20, 0)
return load('rabbits', 20, 0)
)rH )r rF r8 r9 r r r rH � s #z CacheManager.region_invalidatec O s t || |d�S )a Decorate a function to cache itself with supplied parameters
:param args: Used to make the key unique for this function, as in region()
above.
:param kwargs: Parameters to be passed to get_cache(), will override defaults
Example::
# Assuming a cache object is available like:
cache = CacheManager(dict_of_config_options)
def populate_things():
@cache.cache('mycache', expire=15)
def load(search_term, limit, offset):
return load_the_data(search_term, limit, offset)
return load('rabbits', 20, 0)
.. note::
The function being decorated must only be called with
positional arguments.
N)r7 )r r9 re r r r rG � s zCacheManager.cachec O sV |j }| j|f|�}t|d�r8t|j }|�dtj�}n|�dtj�}t |||� dS )a4 Invalidate a cache decorated function
This function only invalidates cache spaces created with the
cache decorator.
:param func: Decorated function to invalidate
:param args: Used to make the key unique for this function, as in region()
above.
:param kwargs: Parameters that were passed for use by get_cache(), note that
this is only required if a ``type`` was specified for the
function
Example::
# Assuming a cache object is available like:
cache = CacheManager(dict_of_config_options)
def populate_things(invalidate=False):
@cache.cache('mycache', type="file", expire=15)
def load(search_term, limit, offset):
return load_the_data(search_term, limit, offset)
# If the results should be invalidated first
if invalidate:
cache.invalidate(load, 'mycache', 'rabbits', 20, 0, type="file")
return load('rabbits', 20, 0)
r= r; N)
r> rq �hasattrr? r= rC rD rE rb rB )r �funcr9 re rF rG �cacheregr; r r r �
invalidate� s !
zCacheManager.invalidateN)
r3 r4 r5 r rq rr r8 rH rG rv r r r r ro y s % ro c s dg� � ����fdd�}|S )z$Return a caching function decorator.Nc
sX t �� ��t �� ��t� ��t� ���� ������f dd��}�|_�d k rT�|_|S )Nc sT �d st�d k rT�t kr$td� ��t � }|�dd�sB�� ��S t��|��d< n �rl�j�f���d< ntd��g }�r�t� � ��\� �dd� ��� D �}� }�
r�� dd � }t d ��
t t t �||���}�r�t � }|�d
t
j�}n��d
t
j�}t|�t�� t|�k�r$t|�d ���� }� ��fd d
�}d�jf |_�d j||d�S )Nr z Cache region not configured: %s�enabledTz3'manager + kwargs' or 'region' argument is requiredc S s* g | ]"\}}t d ��t |�t |�f��qS )�:)r �join)�.0r rV r r r �
<listcomp>A s zE_cache_decorate.<locals>.decorate.<locals>.cached.<locals>.<listcomp>r � r; zutf-8c s
�� ��S )Nr r )r9 rt re r r �goT s z=_cache_decorate.<locals>.decorate.<locals>.cached.<locals>.goz
_cached_%s)ra )r? r rC r@ rA rq � Exceptionr �itemsr ry �mapr rD rE rb �lenrJ r r\ � hexdigestr3 rX ) r9 re ZregZcache_key_kwargsZcache_key_args� cache_keyru r; r} ) rG � deco_argsrt �managerrF �optionsr8 � signature� skip_self)r9 re r �cached+ s:
z1_cache_decorate.<locals>.decorate.<locals>.cached)rD Zfunc_namespaceZ has_self_argr r r> r= )rt r� )rG r� r� r� r8 )rt rF r� r� r �decorate& s
$/z!_cache_decorate.<locals>.decorater )r� r� r� r8 r� r )rG r� r� r� r8 r r7 ! s 8r7 c C sJ t d��tt |��}t|�t| j� |kr<t|�d���� }| �|� dS )z3Invalidate a cache key based on function arguments.r| zutf-8N) r ry r� r� rK r r\ r� rY )rG r; r9 r� r r r rB a s rB )7rm r. � itertoolsr Zbeaker._compatr r r r Zbeaker.containerr_ Z beaker.utilrD Zbeaker.crypto.utilr Zbeaker.exceptionsr r Zbeaker.synchronizationr
Zbeaker.ext.memcached�extZ memcachedZbeaker.ext.databaseZdatabaseZbeaker.ext.sqlaZsqlaZbeaker.ext.googleZgoogleZbeaker.ext.mongodbZmongodbZbeaker.ext.redisnmZredisnm� functoolsr r? rR �objectr ZMemoryNamespaceManagerZDBMNamespaceManagerZFileNamespaceManagerZMemcachedNamespaceManagerZDatabaseNamespaceManagerZSqlaNamespaceManagerZGoogleNamespaceManagerZMongoNamespaceManagerZRedisNamespaceManagerr r: rH r@ ro r7 rB r r r r �<module> sF ? GGf )@
Mini Shell