gp\UdZddlmZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZddlmZddlZddlmZddlmZddlmZdd lmZmZdd lmZdd lmZm Z m!Z!dd l"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(m)Z)m*Z*m+Z+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4m5Z5m6Z6ddl7m8Z8er ddl9m:Z:ddl;mde?d<e#ejZAe e ddfZBde?d<Gdde ZCGdde5ZDeDZEd#dZFGdd ZGGd!d"eZHy)$z$@st.cache_data: pickle-based caching) annotationsN) TYPE_CHECKINGAnyCallableFinalLiteralTypeVarUnioncastoverload) TypeAlias)runtime)StreamlitAPIException) get_logger) CacheErrorCacheKeyNotFoundError) CacheType)CacheCachedFuncInfomake_cached_func_wrapper)CachedMessageReplayContext CachedResultMsgDatashow_widget_replay_deprecation) CacheStorageCacheStorageContextCacheStorageErrorCacheStorageKeyNotFoundErrorCacheStorageManager)InvalidCacheStorageContext)MemoryCacheStorageManager)gather_metrics) CacheStatCacheStatsProvider group_stats)time_to_seconds) timedelta) HashFuncsDictr_LOGGERdiskr CachePersistTypeceZdZdZ d d fd Zed dZed dZed dZd dZ ddZ xZ S)CachedDataFuncInfoz:Implements the CachedFuncInfo interface for @st.cache_datactt||||||_||_||_|j y)N) show_spinner hash_funcs)super__init__persist max_entriesttlvalidate_params)selffuncr/r3r4r5r0 __class__s ]/var/www/openai/venv/lib/python3.12/site-packages/streamlit/runtime/caching/cache_data_api.pyr2zCachedDataFuncInfo.__init__VsD  %!   & c"tjSN)rDATAr7s r: cache_typezCachedDataFuncInfo.cache_typejs ~~r;ctSr=)CACHE_DATA_MESSAGE_REPLAY_CTXr?s r:cached_message_replay_ctxz,CachedDataFuncInfo.cached_message_replay_ctxns,,r;c`|jjd|jjS)z-A human-readable name for the cached function.)r8 __module__ __qualname__r?s r: display_namezCachedDataFuncInfo.display_namers+))&&'q)?)?(@AAr;ctj||j|j|j|j S)N)keyr3r4r5rH) _data_caches get_cacher3r4r5rH)r7 function_keys r:get_function_cachez%CachedDataFuncInfo.get_function_cachews=%%LL((** &  r;ctj|jj|j|j |j y)z Validate the params passed to @st.cache_data are compatible with cache storage When called, this method could log warnings if cache params are invalid for current storage. ) function_namer3r4r5N)rKvalidate_cache_paramsr8__name__r3r4r5r?s r:r6z"CachedDataFuncInfo.validate_paramss; **)),,LL(( + r;r=) r8ztypes.FunctionTyper/ bool | strr3r+r4 int | Noner5float | timedelta | str | Noner0HashFuncsDict | None)returnr)rWr)rWstr)rMrXrWrrWNone) rRrFrG__doc__r2propertyr@rCrHrNr6 __classcell__r9s@r:r-r-SsD,0 !"    , )(--BB   r;r-ceZdZdZdZ d dZd dZd dZ d dZ ddZ ddZ y ) DataCacheszManages all DataCache instancescDtj|_i|_yr=) threadingLock _caches_lock_function_cachesr?s r:r2zDataCaches.__init__s%NN,68r;c Xt|d}|j5|jj|}|8|j|k(r)|j |k(r|j |k(r |cdddS|3tjd|||||jjtjd|||||j|||||}|j} | j|} t|| ||||}||j|<|cdddS#1swYyxYw)zvReturn the mem cache for the given key. If it doesn't exist, create a new one with the given params. Fcoerce_none_to_infNz}Closing existing DataCache storage (key=%s, persist=%s, max_entries=%s, ttl=%s) before creating new one with different paramszCCreating new DataCache (key=%s, persist=%s, max_entries=%s, ttl=%s)rMrP ttl_secondsr4r3)rJstorager3r4rjrH)r&rdregetrjr4r3r)debugrkclosecreate_cache_storage_contextget_storage_managercreate DataCache) r7rJr3r4r5rHrjcache cache_contextcache_storage_managerrks r:rLzDataCaches.get_cachesF&ceD   ))--c2E!%%4%%4MMW,   D ##% MMU  !== *'' >M%)$<$<$> !+22=AG'') E*/D ! !# &g  sA D 0B&D  D)cB|j5 |jji|_dddy#t$rL|jj D],}|j |jj.YdwxYw#1swYyxYw)z'Clear all in-memory and on-disk caches.N) rdrp clear_allNotImplementedErrorrevaluesclearrkrn)r7 data_caches r:rwzDataCaches.clear_alls    / ((*446 %'D ! ' /"&"7"7">">"@J$$&&&,,.#A / s,B=BABBBBBc|j5|jj}dddg}jD]!}|j |j #t |S#1swYJxYwr=)rdrecopyryextend get_statsr%)r7function_cachesstatsrss r:rzDataCaches.get_statssg   #3388:O "$$++-E LL* +.5!! s A11A:ct|d}|jd||||} |jj|y#t$r}t j d||d}~wwxYw)zValidate that the cache params are valid for given storage. Raises ------ InvalidCacheStorageContext Raised if the cache storage manager is not able to work with provided CacheStorageContext. Frg DUMMY_KEYrizQCache params for function %s are incompatible with current cache storage manager.)exc_infoN)r&rorp check_contextr r)error)r7rPr3r4r5rjrtes r:rQz DataCaches.validate_cache_paramss &ceD 99$'## :    $ $ & 4 4] C)  MM)    sA A,A''A,c"t|||||S)N)rMfunction_display_namerjr4r3)r)r7rMrPr3rjr4s r:roz'DataCaches.create_cache_storage_contexts #%"/##   r;ctjrtjjStj dt S)Nz1No runtime found, using MemoryCacheStorageManager)rexists get_instancerur)warningr!r?s r:rpzDataCaches.get_storage_manager*s9 >> '')?? ? OOO P,. .r;N) rJrXr3r+r4rTr5$int | float | timedelta | str | NonerHrXrWrrrYrWzlist[CacheStat]) rPrXr3r+r4rTr5rrWrZ) rMrXrPrXr3r+rj float | Noner4rTrWr)rWr) rRrFrGr[r2rLrwrrQrorpr;r:r`r`s)9D D"D D 2 D  D DL ' """"" " 2 "  "H   "  "      /r;r`ctS)z:Return the StatsProvider for all @st.cache_data functions.)rKrr;r:get_data_cache_stats_providerr8s r;ceZdZdZddZededefZe ddZ e ddddd dd  dd Z dddddd dd  dd Z ddd  ddZ e dddZ y) CacheDataAPIzjImplements the public st.cache_data API: the @st.cache_data decorator, and st.cache_data.clear(). c:t||j|_y)zCreate a CacheDataAPI instance. Parameters ---------- decorator_metric_name The metric name to record for decorator usage. N)r" _decorator)r7decorator_metric_names r:r2zCacheDataAPI.__init__Bs) !4?? r;F.)boundcyr=r)r7r8s r:__call__zCacheDataAPI.__call__Vs&)r;NTF)r5r4r/r3experimental_allow_widgetsr0cyr=r)r7r5r4r/r3rr0s r:rzCacheDataAPI.__call__Zsr;c 2|j|||||||S)N)r5r4r3r/rr0)r)r7r8r5r4r/r3rr0s r:rzCacheDataAPI.__call__fs/ #%'A!  r;)r0c  |durd n |durd n| dvrtd|d|r td fd }||Sttt t j |  S) a]Decorator to cache functions that return data (e.g. dataframe transforms, database queries, ML inference). Cached objects are stored in "pickled" form, which means that the return value of a cached function must be pickleable. Each caller of the cached function gets its own copy of the cached data. You can clear a function's cache with ``func.clear()`` or clear the entire cache with ``st.cache_data.clear()``. A function's arguments must be hashable to cache it. If you have an unhashable argument (like a database connection) or an argument you want to exclude from caching, use an underscore prefix in the argument name. In this case, Streamlit will return a cached value when all other arguments match a previous function call. Alternatively, you can declare custom hashing functions with ``hash_funcs``. To cache global resources, use ``st.cache_resource`` instead. Learn more about caching at https://docs.streamlit.io/develop/concepts/architecture/caching. Parameters ---------- func : callable The function to cache. Streamlit hashes the function's source code. ttl : float, timedelta, str, or None The maximum time to keep an entry in the cache. Can be one of: - ``None`` if cache entries should never expire (default). - A number specifying the time in seconds. - A string specifying the time in a format supported by `Pandas's Timedelta constructor `_, e.g. ``"1d"``, ``"1.5 days"``, or ``"1h23s"``. - A ``timedelta`` object from `Python's built-in datetime library `_, e.g. ``timedelta(days=1)``. Note that ``ttl`` will be ignored if ``persist="disk"`` or ``persist=True``. max_entries : int or None The maximum number of entries to keep in the cache, or None for an unbounded cache. When a new entry is added to a full cache, the oldest cached entry will be removed. Defaults to None. show_spinner : bool or str Enable the spinner. Default is True to show a spinner when there is a "cache miss" and the cached data is being created. If string, value of show_spinner param will be used for spinner text. persist : "disk", bool, or None Optional location to persist cached data to. Passing "disk" (or True) will persist the cached data to the local disk. None (or False) will disable persistence. The default is None. experimental_allow_widgets : bool Allow widgets to be used in the cached function. Defaults to False. hash_funcs : dict or None Mapping of types or fully qualified names to hash functions. This is used to override the behavior of the hasher inside Streamlit's caching mechanism: when the hasher encounters an object, it will first check to see if its type matches a key in this dict and, if so, will use the provided function to generate a hash for it. See below for an example of how this can be used. .. deprecated:: The cached widget replay functionality was removed in 1.38. Please remove the ``experimental_allow_widgets`` parameter from your caching decorators. This parameter will be removed in a future version. Example ------- >>> import streamlit as st >>> >>> @st.cache_data ... def fetch_and_clean_data(url): ... # Fetch data from URL here, and then clean it up. ... return data >>> >>> d1 = fetch_and_clean_data(DATA_URL_1) >>> # Actually executes the function, since this is the first time it was >>> # encountered. >>> >>> d2 = fetch_and_clean_data(DATA_URL_1) >>> # Does not execute the function. Instead, returns its previously computed >>> # value. This means that now the data in d1 is the same as in d2. >>> >>> d3 = fetch_and_clean_data(DATA_URL_2) >>> # This is a different URL, so the function executes. To set the ``persist`` parameter, use this command as follows: >>> import streamlit as st >>> >>> @st.cache_data(persist="disk") ... def fetch_and_clean_data(url): ... # Fetch data from URL here, and then clean it up. ... return data By default, all parameters to a cached function must be hashable. Any parameter whose name begins with ``_`` will not be hashed. You can use this as an "escape hatch" for parameters that are not hashable: >>> import streamlit as st >>> >>> @st.cache_data ... def fetch_and_clean_data(_db_connection, num_rows): ... # Fetch data from _db_connection here, and then clean it up. ... return data >>> >>> connection = make_database_connection() >>> d1 = fetch_and_clean_data(connection, num_rows=10) >>> # Actually executes the function, since this is the first time it was >>> # encountered. >>> >>> another_connection = make_database_connection() >>> d2 = fetch_and_clean_data(another_connection, num_rows=10) >>> # Does not execute the function. Instead, returns its previously computed >>> # value - even though the _database_connection parameter was different >>> # in both calls. A cached function's cache can be procedurally cleared: >>> import streamlit as st >>> >>> @st.cache_data ... def fetch_and_clean_data(_db_connection, num_rows): ... # Fetch data from _db_connection here, and then clean it up. ... return data >>> >>> fetch_and_clean_data.clear(_db_connection, 50) >>> # Clear the cached entry for the arguments provided. >>> >>> fetch_and_clean_data.clear() >>> # Clear all cached entries for this function. To override the default hashing behavior, pass a custom hash function. You can do that by mapping a type (e.g. ``datetime.datetime``) to a hash function (``lambda dt: dt.isoformat()``) like this: >>> import streamlit as st >>> import datetime >>> >>> @st.cache_data(hash_funcs={datetime.datetime: lambda dt: dt.isoformat()}) ... def convert_to_utc(dt: datetime.datetime): ... return dt.astimezone(datetime.timezone.utc) Alternatively, you can map the type's fully-qualified name (e.g. ``"datetime.datetime"``) to the hash function instead: >>> import streamlit as st >>> import datetime >>> >>> @st.cache_data(hash_funcs={"datetime.datetime": lambda dt: dt.isoformat()}) ... def convert_to_utc(dt: datetime.datetime): ... return dt.astimezone(datetime.timezone.utc) Tr*FN)Nr*zUnsupported persist option 'z#'. Valid values are 'disk' or None. cache_datac 8tt|S)Nr8r3r/r4r5r0)rr-)fr0r4persist_stringr/r5s r:wrapperz(CacheDataAPI._decorator..wrapper7s*+"*!- +)   r;r)rrrr-r types FunctionType) r7r8r5r4r/r3rr0rrs ``` ` @r:rzCacheDataAPI._decorator{sX d?#N  !N$N  /'.wi7Z[  & *< 8   <N' %,,d3&)'%    r;clear_data_cachesc,tjy)z,Clear all in-memory and on-disk data caches.N)rKrwr?s r:rzzCacheDataAPI.clearQs  r;)rrX)r8rrWr)r5rUr4rTr/rSr3CachePersistType | boolrboolr0rVrWzCallable[[F], F]r=)r8zF | Noner5rUr4rTr/rSr3rrrr0rVrY)rRrFrGr[r2r rrrr rrr"rzrr;r:rr=s  " 8CH-.A))/3"&#'+/+0+/ ,   !  ) %) )     /3"&#'+/+0+/  ,    !  ) %) ) .T ,0T T , T  T ! T )T %)T )T l'(!)!r;rcteZdZdZ dfd Zd dZd dZedd dZd d dZ xZ S)rrz:Manages cached values for a single st.cache_data function.cvt|||_||_||_||_||_||_yr=)r1r2rJrHrkrjr4r3)r7rJrkr3r4rjrHr9s r:r2zDataCache.__init__Zs= ( && r;cnt|jtr|jjSgSr=) isinstancerkr$rr?s r:rzDataCache.get_statsks) dll$6 7<<))+ + r;c |jj|} tj|}t|ts%|jj|t|S#t$r}tt ||d}~wt $r}t t ||d}~wwxYw#tj$r}t d||d}~wwxYw)zRead a value and messages from the cache. Raise `CacheKeyNotFoundError` if the value doesn't exist, and `CacheError` if the value exists but can't be unpickled. NzFailed to unpickle ) rkrlrrrXrrpickleloadsrrdeleteUnpicklingError)r7rJ pickled_entryrentryexcs r: read_resultzDataCache.read_resultps  , LL,,S1M CLL/Ee\2 ##C(+--L, 7'A/Q 6  ,SV$! + ,%% C23%89s B Cs;A*A B1* B.3B B.B))B.1CCC_cache_data_objectcL tjj}tjj}t ||||}t j |}|jj||y#t jtf$r}td||d}~wwxYw)zbWrite a value and associated messages to the cache. The value must be pickleable. zFailed to pickle N) st_mainidsidebarrrdumps PicklingError TypeErrorrrkset) r7rJvaluemessagesmain_id sidebar_idrrrs r: write_resultzDataCache.write_results  AhhkkGJ ':FE"LL/M m,$$i0 A067S @ AsAA66B#BB#ct|s|jjy|jj|yr=)rkrzr)r7rJs r:_clearzDataCache._clears' LL   LL   $r;) rJrXrkrr3r+r4rTrjrrHrXr)rJrXrWr)rJrXrrrz list[MsgData]rWrZr=)rJz str | NonerWrZ) rRrFrGr[r2rrr"rrr]r^s@r:rrrrWstD "    " " C.() -* -%%r;rr)rWr$)Ir[ __future__rrrbrtypingrrrrrr r r r typing_extensionsr streamlitrrstreamlit.errorsrstreamlit.loggerr&streamlit.runtime.caching.cache_errorsrr$streamlit.runtime.caching.cache_typer%streamlit.runtime.caching.cache_utilsrrr/streamlit.runtime.caching.cached_message_replayrrrr!streamlit.runtime.caching.storagerrrrr8streamlit.runtime.caching.storage.cache_storage_protocolr 5streamlit.runtime.caching.storage.dummy_cache_storager!streamlit.runtime.metrics_utilr"streamlit.runtime.statsr#r$r%streamlit.time_utilr&datetimer'!streamlit.runtime.caching.hashingr(rRr)__annotations__r>rBr+r-r`rKrrrrrr;r:rs+"     (2'T:  :NN/"?H%% :9>> J$GFOT$9:):9 9 xb/#b/L|  W!W!tB%B%r;