sgXdZddlZddlZddlZddlZddlmZ ddl Z ddl Z ddl Z ddl mZmZmZmZmZddlmZmZGddZej.e_y)z2Fanout cache automatically shards keys and values.N)DEFAULT_SETTINGSENOVALCacheDiskTimeout)DequeIndexc`eZdZdZdddefdZedZdZe jd,dZ d-d Z d Z d.d Zd-d Zd/d Zd/dZ d0dZdZdZdZ d1dZd2dZdZd3dZd2dZdZdZd2dZd2dZd2dZd4dZ d5dZ!dZ"d Z#d!Z$d"Z%d#Z&d$Z'd%Z(d&Z)d'Z*e+fd(Z,d6d)Z-d7d*Z.d+Z/y)8 FanoutCachez"Cache that shards keys and values.Ng{Gz?c tjdttjtj t d}jd||z ||_|_ |_ tfdt|D|_ |jdjj|_i|_i|_i|_y)a6Initialize cache instance. :param str directory: cache directory :param int shards: number of shards to distribute writes :param float timeout: SQLite connection timeout :param disk: `Disk` instance for serialization :param settings: any of `DEFAULT_SETTINGS` Nz diskcache-)prefix size_limitc 3lK|]+}tdtjd|zd-yw)z%03d) directorytimeoutdiskrN)ropjoin).0numrrsettingsrrs C/var/www/html/venv/lib/python3.12/site-packages/diskcache/fanout.py z'FanoutCache.__init__..+sJ    '')Vc\:%       s14r)tempfilemkdtempstrr expanduser expandvarsrpop_count _directory_disktuplerange_shardsrhash_hash_caches_deques_indexes)selfrshardsrrrdefault_size_limitrs ` ``` @r__init__zFanoutCache.__init__s   (( =I N MM), MM), -l;\\,0BCfL  #   V}    \\!_))..    c|jS)zCache directory.)r$r.s rrzFanoutCache.directory:sr2cddh}|tvxs||v}|sJdj|t|jd|S)Nrrzcannot access {} in cache shardr)rformatgetattrr()r.name safe_names valid_names r __getattr__zFanoutCache.__getattr__?sO( --C1C I<CCDIIzt||A--r2c#K|sJdtj5}|jD]%}|jd}|j |'ddddy#1swYyxYww)aContext manager to perform a transaction by locking the cache. While the cache is locked, no other write operation is permitted. Transactions should therefore be as short as possible. Read and write operations performed in a transaction are atomic. Read operations may occur concurrent to a transaction. Transactions may be nested and may not be shared between threads. Blocks until transactions are held on all cache shards by retrying as necessary. >>> cache = FanoutCache() >>> with cache.transact(): # Atomically increment two keys. ... _ = cache.incr('total', 123.4) ... _ = cache.incr('count', 1) >>> with cache.transact(): # Atomically calculate average. ... average = cache['total'] / cache['count'] >>> average 123.4 :return: context manager for use in `with` statement z!retry must be True in FanoutCacheTretryN)cl ExitStackr(transact enter_context)r.r>stackshardshard_transactions rrAzFanoutCache.transactEsm4999u \\^ u 7$)NNN$>!##$56 7     sA.9A" A."A+'A.c|j||jz}|j|} |j||||||S#t$rYywxYw)aSet `key` and `value` item in cache. When `read` is `True`, `value` should be a file-like object opened for reading in binary mode. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param value: value for item :param float expire: seconds until the key expires (default None, no expiry) :param bool read: read value as raw bytes from file (default False) :param str tag: text to associate with key (default None) :param bool retry: retry if database timeout occurs (default False) :return: True if item was set F)r*r#r(setr r.keyvalueexpirereadtagr>indexrDs rrGzFanoutCache.setfsX& 3$++- U# 99S%sEB B  A AAch|j||jz}|j|}|||<y)zSet `key` and `value` item in cache. Calls :func:`FanoutCache.set` internally with `retry` set to `True`. :param key: key for item :param value: value for item Nr*r#r()r.rIrJrNrDs r __setitem__zFanoutCache.__setitem__s1 3$++- U#c r2c|j||jz}|j|} |j|||S#t$rYywxYw)aTouch `key` in cache and update `expire` time. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param float expire: seconds until the key expires (default None, no expiry) :param bool retry: retry if database timeout occurs (default False) :return: True if key was touched F)r*r#r(touchr)r.rIrKr>rNrDs rrTzFanoutCache.touchsR 3$++- U# ;;sFE2 2  sA A Ac|j||jz}|j|} |j||||||S#t$rYywxYw)aAdd `key` and `value` item to cache. Similar to `set`, but only add to cache if key not present. This operation is atomic. Only one concurrent add operation for given key from separate threads or processes will succeed. When `read` is `True`, `value` should be a file-like object opened for reading in binary mode. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param value: value for item :param float expire: seconds until the key expires (default None, no expiry) :param bool read: read value as bytes from file (default False) :param str tag: text to associate with key (default None) :param bool retry: retry if database timeout occurs (default False) :return: True if item was added F)r*r#r(addrrHs rrVzFanoutCache.addsX0 3$++- U# 99S%sEB B  rOc|j||jz}|j|} |j||||S#t$rYywxYw)aIncrement value by delta for item with key. If key is missing and default is None then raise KeyError. Else if key is missing and default is not None then use default for value. Operation is atomic. All concurrent increment operations will be counted individually. Assumes value may be stored in a SQLite column. Most builds that target machines with 64-bit pointer widths will support 64-bit signed integers. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param int delta: amount to increment (default 1) :param int default: value if key is missing (default 0) :param bool retry: retry if database timeout occurs (default False) :return: new value for item on success else None :raises KeyError: if key is not found and default is None N)r*r#r(incrrr.rIdeltadefaultr>rNrDs rrXzFanoutCache.incrsT0 3$++- U# ::c5'59 9  A AAc|j||jz}|j|} |j||||S#t$rYywxYw)aDecrement value by delta for item with key. If key is missing and default is None then raise KeyError. Else if key is missing and default is not None then use default for value. Operation is atomic. All concurrent decrement operations will be counted individually. Unlike Memcached, negative values are supported. Value may be decremented below zero. Assumes value may be stored in a SQLite column. Most builds that target machines with 64-bit pointer widths will support 64-bit signed integers. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param int delta: amount to decrement (default 1) :param int default: value if key is missing (default 0) :param bool retry: retry if database timeout occurs (default False) :return: new value for item on success else None :raises KeyError: if key is not found and default is None N)r*r#r(decrrrYs rr^zFanoutCache.decrsT6 3$++- U# ::c5'59 9  r\c|j||jz}|j|} |j||||||S#tt j f$r|cYSwxYw)aRetrieve value from cache. If `key` is missing, return `default`. If database timeout occurs then returns `default` unless `retry` is set to `True` (default `False`). :param key: key for item :param default: return value if key is missing (default None) :param bool read: if True, return file handle to value (default False) :param float expire_time: if True, return expire_time in tuple (default False) :param tag: if True, return tag in tuple (default False) :param bool retry: retry if database timeout occurs (default False) :return: value for item if key is found else default )r*r#r(getrsqlite3OperationalError) r.rIr[rL expire_timerMr>rNrDs rr`zFanoutCache.getse2 3$++- U# 99S'4c5I I112 N sAA#"A#cf|j||jz}|j|}||S)zReturn corresponding value for `key` from cache. Calls :func:`FanoutCache.get` internally with `retry` set to `True`. :param key: key for item :return: value for item :raises KeyError: if key is not found rQr.rIrNrDs r __getitem__zFanoutCache.__getitem__!s2 3$++- U#Szr2c^|j|tdd}|tur t||S)zReturn file handle corresponding to `key` from cache. :param key: key for item :return: file open for reading in binary mode :raises KeyError: if key is not found T)r[rLr>)r`rKeyError)r.rIhandles rrLzFanoutCache.read/s1#vDE V 3-  r2cd|j||jz}|j|}||vS)zReturn `True` if `key` matching item is found in cache. :param key: key for item :return: True if key is found rQres r __contains__zFanoutCache.__contains__<s2 3$++- U#e|r2c|j||jz}|j|} |j|||||S#t$r|cYSwxYw)aRemove corresponding item for `key` from cache and return value. If `key` is missing, return `default`. Operation is atomic. Concurrent operations will be serialized. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param default: return value if key is missing (default None) :param float expire_time: if True, return expire_time in tuple (default False) :param tag: if True, return tag in tuple (default False) :param bool retry: retry if database timeout occurs (default False) :return: value for item if key is found else default )r*r#r(r"r)r.rIr[rcrMr>rNrDs rr"zFanoutCache.popGsX* 3$++- U# 99S';UC C N sA AAc|j||jz}|j|} |j||S#t$rYywxYw)agDelete corresponding item for `key` from cache. Missing keys are ignored. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param key: key for item :param bool retry: retry if database timeout occurs (default False) :return: True if item was deleted F)r*r#r(deleter)r.rIr>rNrDs rrnzFanoutCache.deletecsP 3$++- U# <<U+ +  sA A  A cd|j||jz}|j|}||=y)zDelete corresponding item for `key` from cache. Calls :func:`FanoutCache.delete` internally with `retry` set to `True`. :param key: key for item :raises KeyError: if key is not found NrQres r __delitem__zFanoutCache.__delitem__ws/ 3$++- U# #Jr2c|fd|jD}tjtj|gS)a3Check database and file system consistency. Intended for use in testing and post-mortem error analysis. While checking the cache table for consistency, a writer lock is held on the database. The lock blocks other cache clients from writing to the database. For caches with many file references, the lock may be held for a long time. For example, local benchmarking shows that a cache with 1,000 file references takes ~60ms to check. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param bool fix: correct inconsistencies :param bool retry: retry if database timeout occurs (default False) :return: list of warnings :raises Timeout: if database timeout occurs c3BK|]}|jywN)check)rrDfixr>s rrz$FanoutCache.check..sFEKKU+Fs)r( functoolsreduceoperatoriadd)r.rur>warningss `` rrtzFanoutCache.checks-(GF x<)_removetimer.r>s rrKzFanoutCache.expires!||HDIIK>|GGr2cF|jD]}|jy)zCreate tag index on cache database. Better to initialize cache with `tag_index=True` than use this. :raises Timeout: if database timeout occurs N)r(create_tag_indexr.rDs rrzFanoutCache.create_tag_indexs#\\ %E  " " $ %r2cF|jD]}|jy)z`Drop tag index on cache database. :raises Timeout: if database timeout occurs N)r(drop_tag_indexrs rrzFanoutCache.drop_tag_indexs# \\ #E  " #r2c,|jd|f|S)aLRemove items with matching `tag` from cache. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param str tag: tag identifying items :param bool retry: retry if database timeout occurs (default False) :return: count of items removed evictr|r~)r.rMr>s rrzFanoutCache.evicts||G3&|>>r2c(|jd|S)a-Cull items from cache until volume is less than size limit. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param bool retry: retry if database timeout occurs (default False) :return: count of items removed cullr=rrs rrzFanoutCache.culls||F%|00r2c(|jd|S)aRemove all items from cache. If database timeout occurs then fails silently unless `retry` is set to `True` (default `False`). :param bool retry: retry if database timeout occurs (default False) :return: count of items removed clearr=rrs rrzFanoutCache.clears||G5|11r2cd}|jD]}t||} ||d|i}||z }|S#t$r}||jdz }Yd}~nd}~wwxYw;)Nrr>)r(r7rr}) r.r8r}r>totalrDmethodcountrs rr~zFanoutCache._removes{\\ EUD)F"D66EUNE  -W\\!_,E- s 1 AAAc|jDcgc]}|j||}}td|D}td|D}||fScc}w)zReturn cache statistics hits and misses. :param bool enable: enable collecting statistics (default True) :param bool reset: reset hits and misses to 0 (default False) :return: (hits, misses) c3&K|] \}}| ywrsr)rhits_s rrz$FanoutCache.stats..s5'$5c3&K|] \}}| ywrsr)rrmissess rrz$FanoutCache.stats..s;ia6;r)r(statssum)r.enableresetrDresults total_hits total_missess rrzFanoutCache.statssX<@<<H%5;;vu-HH5W55 ;7;; <''IsAc:td|jDS)zWReturn estimated total size of cache on disk. :return: size in bytes c3<K|]}|jywrs)volumerrDs rrz%FanoutCache.volume..s.s;UT%[;)r(itchain from_iterabler. iteratorss r__iter__zFanoutCache.__iter__s%;dll; xx%%i00r2cxdt|jD}tjj |S)z6Reverse iterate keys in cache including expired items.c32K|]}t|ywrs)reversedrs rrz+FanoutCache.__reversed__..sIXe_Ir)rr(rrrrs r __reversed__zFanoutCache.__reversed__s*I(4<<2HI xx%%i00r2c:td|jDS)z0Count of items in cache including expired items.c32K|]}t|ywrs)lenrs rrz&FanoutCache.__len__..#s8%3u:8rrr4s r__len__zFanoutCache.__len__!s84<<888r2cp|jD]} |j||}S#t$rYnwxYw')aTReset `key` and `value` item from Settings table. If `value` is not given, it is reloaded from the Settings table. Otherwise, the Settings table is updated. Settings attributes on cache objects are lazy-loaded and read-only. Use `reset` to update the value. Settings with the ``sqlite_`` prefix correspond to SQLite pragmas. Updating the value will execute the corresponding PRAGMA statement. :param str key: Settings key for item :param value: value for item (optional) :return: updated value for item )r(rr)r.rIrJrDresults rrzFanoutCache.reset%sT$\\ E"[[e4F  s ( 44c |j} ||S#t$r]|jd}tj|j dg|}t d||| |jntd|}|||<|cYSwxYw)a{Return Cache with given `name` in subdirectory. If disk is none (default), uses the fanout cache disk. >>> fanout_cache = FanoutCache() >>> cache = fanout_cache.cache('test') >>> cache.set('abc', 123) True >>> cache.get('abc') 123 >>> len(cache) 1 >>> cache.delete('abc') True :param str name: subdirectory name for Cache :param float timeout: SQLite connection timeout :param disk: Disk type or subclass for serialization :param settings: any of DEFAULT_SETTINGS :return: Cache with given name /cache)rrrr) r+rhsplitrrr$rr%r) r.r8rrrr+partsrtemps rrzFanoutCache.cacheAs.,, 4=  JJsOEA5AI##'>> cache = FanoutCache() >>> deque = cache.deque('test') >>> deque.extend('abc') >>> deque.popleft() 'a' >>> deque.pop() 'c' >>> len(deque) 1 :param str name: subdirectory name for Deque :param maxlen: max length (default None, no max) :return: Deque with given name rdequenonerreviction_policy)maxlen) r,rhrrrr$rr%r fromcache)r.r8rr,rrrrs rrzFanoutCache.dequehs$,, 4=  JJsOEA5AI#ZZ &E OOE&9E!GDML sA1BBc|j} ||S#t$ri|jd}tj|j dg|}t ||jd}tj|}|||<|cYSwxYw)aReturn Index with given `name` in subdirectory. >>> cache = FanoutCache() >>> index = cache.index('test') >>> index['abc'] = 123 >>> index['def'] = 456 >>> index['ghi'] = 789 >>> index.popitem() ('ghi', 789) >>> del index['abc'] >>> len(index) 1 >>> index['def'] 456 :param str name: subdirectory name for Index :return: Index with given name rrNrr) r-rhrrrr$rr%r r)r.r8r-rrrrNs rrNzFanoutCache.indexs(== D> ! JJsOEA5AI#ZZ &E OOE*E"HTNL sA/BB)T)NFNF)NF)rrF)NFFFF)NFFF)F)FF)rF)TF)<Nrs)0__name__ __module__ __qualname____doc__rr1propertyrr;r?contextmanagerrArGrRrTrVrXr^r`rfrLrkr"rnrprtrKrrrrrr~rrrrrrrrrrrrrrrNrr2rr r s,QD%N. @4 (>> J  @   FK8( =. H %# ? 1 2  (=M1 1 9 &8%N D"r2r )r contextlibr?rv itertoolsrrxos.pathpathrrarrcorerrrrr persistentr r r memoizerr2rrsD8 @@$\ \ ~mm r2