HEX

File: //usr/lib/python3/dist-packages/django/core/cache/backends/__pycache__/base.cpython-310.pyc
o

3�aR(�@s�dZddlZddlZddlmZddlmZGdd�de�ZGdd�de�Z	Gd	d
�d
e
�Ze�Z
dZdd
�Zdd�ZGdd�d�Zdd�ZdS)zBase Cache class.�N)�ImproperlyConfigured)�
import_stringc@�eZdZdS)�InvalidCacheBackendErrorN��__name__�
__module__�__qualname__�r
r
�A/usr/lib/python3/dist-packages/django/core/cache/backends/base.pyr	�rc@r)�CacheKeyWarningNrr
r
r
rr

rr
c@r)�InvalidCacheKeyNrr
r
r
rrrr�cCsd|||fS)z�
    Default function to generate keys.

    Construct the key used by all other methods. By default, prepend
    the `key_prefix`. KEY_FUNCTION can be used to specify an alternate
    function with custom key making behavior.
    z%s:%s:%sr
)�key�
key_prefix�versionr
r
r�default_key_funcsrcCs |durt|�r
|St|�StS)z]
    Function to decide which key function to use.

    Default to ``default_key_func``.
    N)�callablerr)�key_funcr
r
r�get_key_func(s
rc@s�eZdZe�Zdd�Zefdd�Zd-dd�Zedfdd	�Z	d.d
d�Z
edfdd
�Zedfdd�Zd-dd�Z
d-dd�Zedfdd�Zd-dd�Zd/dd�Zd/dd�Zdd�Zedfdd �Zd-d!d"�Zd#d$�Zd%d&�Zd/d'd(�Zd/d)d*�Zd+d,�ZdS)0�	BaseCachec	Cs|�d|�dd��}|dur"zt|�}Wn
ttfy!d}Ynw||_|�di�}|�d|�dd��}zt|�|_WnttfyJd|_Ynw|�d|�dd	��}zt|�|_Wnttfyjd	|_Ynw|�d
d�|_|�dd
�|_t	|�d��|_
dS)N�timeout�TIMEOUTi,�OPTIONS�max_entries�MAX_ENTRIES�cull_frequency�CULL_FREQUENCY��
KEY_PREFIX��VERSION��KEY_FUNCTION)�get�int�
ValueError�	TypeError�default_timeout�_max_entries�_cull_frequencyrrrr)�self�paramsr�optionsrrr
r
r�__init__9s0�
�
�zBaseCache.__init__cCs4|tkr|j}n|dkrd}|durdSt��|S)zj
        Return the timeout value usable by this backend based upon the provided
        timeout.
        r���N)�DEFAULT_TIMEOUTr)�time)r,rr
r
r�get_backend_timeoutSs
zBaseCache.get_backend_timeoutNcCs|dur|j}|�||j|�S)ap
        Construct the key used by all other methods. By default, use the
        key_func to generate a key (which, by default, prepends the
        `key_prefix' and 'version'). A different key function can be provided
        at the time of cache construction; alternatively, you can subclass the
        cache backend to provide custom key making behavior.
        N)rrr�r,rrr
r
r�make_key_szBaseCache.make_keycC�td��)z�
        Set a value in the cache if the key does not already exist. If
        timeout is given, use that timeout for the key; otherwise use the
        default cache timeout.

        Return True if the value was stored, False otherwise.
        z4subclasses of BaseCache must provide an add() method��NotImplementedError�r,r�valuerrr
r
r�addlsz
BaseCache.addcCr6)z�
        Fetch a given key from the cache. If the key does not exist, return
        default, which itself defaults to None.
        z3subclasses of BaseCache must provide a get() methodr7)r,r�defaultrr
r
rr%v�z
BaseCache.getcCr6)z�
        Set a value in the cache. If timeout is given, use that timeout for the
        key; otherwise use the default cache timeout.
        z3subclasses of BaseCache must provide a set() methodr7r9r
r
r�set}r=z
BaseCache.setcCr6)z�
        Update the key's expiry time using timeout. Return True if successful
        or False if the key does not exist.
        z5subclasses of BaseCache must provide a touch() methodr7)r,rrrr
r
r�touch�r=zBaseCache.touchcCr6)zh
        Delete a key from the cache and return whether it succeeded, failing
        silently.
        z6subclasses of BaseCache must provide a delete() methodr7r4r
r
r�delete�r=zBaseCache.deletecCs6i}|D]}|j||j|d�}||jur|||<q|S)a.
        Fetch a bunch of keys from the cache. For certain backends (memcached,
        pgsql) this can be *much* faster when fetching multiple values.

        Return a dict mapping each key in keys to its value. If the given
        key is missing, it will be missing from the response dict.
        �r�r%�_missing_key)r,�keysr�d�k�valr
r
r�get_many�s
�zBaseCache.get_manycCsP|j||j|d�}||jur&t|�r|�}|j||||d�|j|||d�S|S)aU
        Fetch a given key from the cache. If the key does not exist,
        add the key and set it to the default value. The default value can
        also be any callable. If timeout is given, use that timeout for the
        key; otherwise use the default cache timeout.

        Return the value of the key stored or retrieved.
        rA�rr)r%rCrr;)r,rr<rrrGr
r
r�
get_or_set�s	
zBaseCache.get_or_setcCs|j||j|d�|juS)�M
        Return True if the key is in the cache and has not expired.
        rArBr4r
r
r�has_key�szBaseCache.has_keyr#cCsD|j||j|d�}||jurtd|��||}|j|||d�|S)zs
        Add delta to value in the cache. If the key does not exist, raise a
        ValueError exception.
        rA�Key '%s' not found)r%rCr'r>)r,r�deltarr:�	new_valuer
r
r�incr�s
zBaseCache.incrcCs|j|||d�S)zz
        Subtract delta from value in the cache. If the key does not exist, raise
        a ValueError exception.
        rA)rP�r,rrNrr
r
r�decr�szBaseCache.decrcCs
|�|�S)rK)rL)r,rr
r
r�__contains__�s
zBaseCache.__contains__cCs(|��D]
\}}|j||||d�qgS)a�
        Set a bunch of values in the cache at once from a dict of key/value
        pairs.  For certain backends (memcached), this is much more efficient
        than calling set() multiple times.

        If timeout is given, use that timeout for the key; otherwise use the
        default cache timeout.

        On backends that support it, return a list of keys that failed
        insertion, or an empty list if all keys were inserted successfully.
        rI)�itemsr>)r,�datarrrr:r
r
r�set_many�szBaseCache.set_manycCs|D]	}|j||d�qdS)z�
        Delete a bunch of values in the cache at once. For certain backends
        (memcached), this is much more efficient than calling delete() multiple
        times.
        rAN)r@)r,rDrrr
r
r�delete_many�s�zBaseCache.delete_manycCr6)z+Remove *all* values from the cache at once.z5subclasses of BaseCache must provide a clear() methodr7)r,r
r
r�clear�szBaseCache.clearcCst|�D]}t�|t�qdS)z�
        Warn about keys that would not be portable to the memcached
        backend. This encourages (but does not force) writing backend-portable
        cache code.
        N)�memcache_key_warnings�warnings�warnr
)r,r�warningr
r
r�validate_key�s�zBaseCache.validate_keycCs`|dur|j}|j||j|d�}||jurtd|��|j||||d�|j||d�||S)zf
        Add delta to the cache version for the supplied key. Return the new
        version.
        NrArM)rr%rCr'r>r@)r,rrNrr:r
r
r�incr_version�s
zBaseCache.incr_versioncCs|�|||�S)zm
        Subtract delta from the cache version for the supplied key. Return the
        new version.
        )r^rQr
r
r�decr_versionszBaseCache.decr_versioncKsdS)zClose the cache connectionNr
)r,�kwargsr
r
r�closeszBaseCache.close)N)NN)r#N)rrr	�objectrCr/r1r3r5r;r%r>r?r@rHrJrLrPrRrSrVrWrXr]r^r_rar
r
r
rr6s.







	
	
	
rccsR�t|�tkrd|tfV|D]}t|�dkst|�dkr&d|VdSqdS)NzGCache key will cause errors if used with memcached: %r (longer than %s)�!�zOCache key contains characters that will cause errors if used with memcached: %r)�len�MEMCACHE_MAX_KEY_LENGTH�ord)r�charr
r
rrYs�������rY)�__doc__r2rZ�django.core.exceptionsr�django.utils.module_loadingrr�RuntimeWarningr
r'rrbr1rfrrrrYr
r
r
r�<module>sc