U Zf9@s*ddlZGdddZGdddeZdS)Nc@sfeZdZdZd)edddZejeedddZe ej d d d Z e e d d d Z e ejej dddZe eje ej fdddZd*e ej ejeeje dddZd+e ej ejee dddZd,eje ej fejeejej dddZe ejej dddZe e d ddZe d d!d"Zd-e eejed$d%d&Zd.e eejed$d'd(ZdS)/ BaseCacheaMBaseclass for the cache systems. All the cache systems implement this API or a superset of it. :param default_timeout: the default timeout (in seconds) that is used if no timeout is specified on :meth:`set`. A timeout of 0 indicates that the cache never expires. ,default_timeoutcCs ||_dSNr)selfrr1/tmp/pip-unpacked-wheel-7m7iy3r0/cachelib/base.py__init__ szBaseCache.__init__)timeoutreturncCs|dkr|j}|Srr)rr rrr _normalize_timeoutszBaseCache._normalize_timeoutkeyr cCsdS)zLook up key in the cache and return the value for it. :param key: the key to be looked up. :returns: The value if it exists and is readable, else ``None``. Nrrrrrr getsz BaseCache.getcCsdS)zDelete `key` from the cache. :param key: the key to delete. :returns: Whether the key existed and has been deleted. :rtype: boolean Trrrrr deleteszBaseCache.delete)keysr csfdd|DS)a<Returns a list of values for the given keys. For each key an item in the list is created:: foo, bar = cache.get_many("foo", "bar") Has the same error handling as :meth:`get`. :param keys: The function accepts multiple keys as positional arguments. csg|]}|qSr)r).0krrr 1sz&BaseCache.get_many..rrrrrr get_many&s zBaseCache.get_manycGstt||j|S)zLike :meth:`get_many` but return a dict:: d = cache.get_dict("foo", "bar") foo = d["foo"] bar = d["bar"] :param keys: The function accepts multiple keys as positional arguments. )dictziprrrrr get_dict3s zBaseCache.get_dictN)rvaluer r cCsdS)akAdd a new key/value to the cache (overwrites value, if key already exists in the cache). :param key: the key to set :param value: the value for the key :param timeout: the cache timeout for the key in seconds (if not specified, it uses the default timeout). A timeout of 0 indicates that the cache never expires. :returns: ``True`` if key has been updated, ``False`` for backend errors. Pickling errors, however, will raise a subclass of ``pickle.PickleError``. :rtype: boolean Trrrrr rrr set?sz BaseCache.setcCsdS)a Works like :meth:`set` but does not overwrite the values of already existing keys. :param key: the key to set :param value: the value for the key :param timeout: the cache timeout for the key in seconds (if not specified, it uses the default timeout). A timeout of 0 indicates that the cache never expires. :returns: Same as :meth:`set`, but also ``False`` for already existing keys. :rtype: boolean Trrrrr addQs z BaseCache.add)mappingr r cCs2g}|D] \}}||||r ||q |S)aSets multiple keys and values from a mapping. :param mapping: a mapping with the keys/values to set. :param timeout: the cache timeout for the key in seconds (if not specified, it uses the default timeout). A timeout of 0 indicates that the cache never expires. :returns: A list containing all keys sucessfuly set :rtype: boolean )itemsrappend)rr!r Zset_keysrrrrr set_many`s  zBaseCache.set_manycGs&g}|D]}||r||q|S)zDeletes multiple keys at once. :param keys: The function accepts multiple keys as positional arguments. :returns: A list containing all sucessfuly deleted keys :rtype: boolean )rr#)rrZ deleted_keysrrrr delete_manyrs   zBaseCache.delete_manycCs tddS)zChecks if a key exists in the cache without returning it. This is a cheap operation that bypasses loading the actual data on the backend. :param key: the key to check z%s doesn't have an efficient implementation of `has`. That means it is impossible to check whether a key exists without fully loading the key's data. Consider using `self.get` explicitly if you don't care about performance.N)NotImplementedErrorrrrr hassz BaseCache.has)r cCsdS)zClears the cache. Keep in mind that not all caches support completely clearing the cache. :returns: Whether the cache has been cleared. :rtype: boolean Trrrrr clearszBaseCache.clear)rdeltar cCs&||p d|}|||r"|SdS)aHIncrements the value of a key by `delta`. If the key does not yet exist it is initialized with `delta`. For supporting caches this is an atomic operation. :param key: the key to increment. :param delta: the delta to add. :returns: The new value or ``None`` for backend errors. rNrrrrr*rrrr incs z BaseCache.inccCs&||p d|}|||r"|SdS)aLDecrements the value of a key by `delta`. If the key does not yet exist it is initialized with `-delta`. For supporting caches this is an atomic operation. :param key: the key to increment. :param delta: the delta to subtract. :returns: The new value or `None` for backend errors. rNr+r,rrr decs z BaseCache.dec)r)N)N)N)r))r))__name__ __module__ __qualname____doc__intr _tOptionalr strAnyrboolrListrDictrrr r$r%r'r(r-r.rrrr rs4        rc@s eZdZdZeedddZdS) NullCachezA cache that doesn't cache. This can be useful for unit testing. :param default_timeout: a dummy parameter that is ignored but exists for API compatibility with other caches. rcCsdS)NFrrrrr r'sz NullCache.hasN)r/r0r1r2r6r8r'rrrr r;sr;)typingr4rr;rrrr s.