o ,&]ixQ@sUdZddlmZddlZddlZddlmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZddlZddlmZdd lmZdd lmZdd lmZdd lmZmZmZm Z dd l!m"Z"m#Z#m$Z$ddl%m&Z&ddl'm(Z(m)Z)m*Z*ddl+m,Z,erddl-m.Z.ddl/m0Z0ee1Z2de3d<e"ej4Z5ee ge6fZ7de3d<d+ddZ8Gddde)Z9e9Z:d,d!d"Z;ed#ZGd'd(d(Z?Gd)d*d*ee=Z@dS)-z"@st.cache_resource implementation.) annotationsN)Callable) TYPE_CHECKINGAnyFinal TypeAliasTypeVaroverload)TTLCache) ParamSpec) get_logger) cache_utils)CacheKeyNotFoundError) CacheType)Cache CachedFuncCachedFuncInfomake_cached_func_wrapper)CachedMessageReplayContext CachedResultMsgData)gather_metrics) CacheStatCacheStatsProvider group_stats)time_to_seconds) timedelta) HashFuncsDictr_LOGGERr ValidateFuncaValidateFunc | NonebreturnboolcCs |dur|dup|duo|duS)zTrue if the two validate functions are equal for the purposes of determining whether a given function cache needs to be recreated. N)r r"r%r%j/var/www/html/IGF-ODF-V3/venv/lib/python3.10/site-packages/streamlit/runtime/caching/cache_resource_api.py_equal_validate_funcsDs r'c@s8eZdZdZdddZdddZdddZdddZdS)ResourceCachesz$Manages all ResourceCache instances.r#NonecCst|_i|_dSN) threadingLock _caches_lock_function_cachesselfr%r%r&__init__Ps  zResourceCaches.__init__keystr display_name max_entriesint | float | Nonettlfloat | timedelta | str | Nonevalidater!ResourceCache[Any]cCs|durtj}t|}|jA|j|}|dur2|j|kr2|j|kr2t|j |r2|WdSt d|t |||||d}||j|<|WdS1sRwYdS)zvReturn the mem cache for the given key. If it doesn't exist, create a new one with the given params. Nz#Creating new ResourceCache (key=%s))r2r4r5 ttl_secondsr9) mathinfrr-r.getr;r5r'r9rdebug ResourceCache)r0r2r4r5r7r9r;cacher%r%r& get_cacheTs.       $zResourceCaches.get_cachecCs2|j i|_WddS1swYdS)zClear all resource caches.N)r-r.r/r%r%r& clear_all}s"zResourceCaches.clear_alllist[CacheStat]cCsX|j |j}Wdn1swYg}|D] }||qt|Sr*)r-r.copyvaluesextend get_statsr)r0function_cachesstatsrAr%r%r&rHs  zResourceCaches.get_statsNr#r)) r2r3r4r3r5r6r7r8r9r!r#r:r#rD)__name__ __module__ __qualname____doc__r1rBrCrHr%r%r%r&r(Ms    )r(rcCtS)z>Return the StatsProvider for all @st.cache_resource functions.)_resource_cachesr%r%r%r&!get_resource_cache_stats_providerrSPRcs\eZdZdZ  d#d$fdd Zed%ddZed&ddZed'ddZd(d!d"Z Z S))CachedResourceFuncInfoz?Implements the CachedFuncInfo interface for @st.cache_resource.NFfuncCallable[P, R] show_spinner bool | strr5 int | Noner7r8r9r! hash_funcsHashFuncsDict | None show_timer$r#r)cs*tj||||d||_||_||_dS)N)r]rZr_)superr1r5r7r9)r0rXrZr5r7r9r]r_ __class__r%r&r1s  zCachedResourceFuncInfo.__init__rcCstjSr*)rRESOURCEr/r%r%r& cache_typesz!CachedResourceFuncInfo.cache_typercCrQr*)!CACHE_RESOURCE_MESSAGE_REPLAY_CTXr/r%r%r&cached_message_replay_ctxrTz0CachedResourceFuncInfo.cached_message_replay_ctxr3cCs|jjd|jjS)z.A human-readable name for the cached function..)rXrNrOr/r%r%r&r4sz#CachedResourceFuncInfo.display_name function_keyCache[R]cCstj||j|j|j|jdS)N)r2r4r5r7r9)rRrBr4r5r7r9)r0rhr%r%r&get_function_cachesz)CachedResourceFuncInfo.get_function_cache)NF)rXrYrZr[r5r\r7r8r9r!r]r^r_r$r#r))r#r)r#r)r#r3)rhr3r#ri) rMrNrOrPr1propertyrdrfr4rj __classcell__r%r%rar&rWs    rWc@seZdZdZd(ddZed)d d Zed d ddd d dd*dd Z d+d d ddd d dd,d!d Zdd d"d,d#d$Zed%d-d&d'Z d S).CacheResourceAPIzvImplements the public st.cache_resource API: the @st.cache_resource decorator, and st.cache_resource.clear(). decorator_metric_namer3r#r)cCst||j|_dS)zCreate a CacheResourceAPI instance. Parameters ---------- decorator_metric_name The metric name to record for decorator usage. N)r _decorator)r0rnr%r%r&r1s zCacheResourceAPI.__init__rXrYCachedFunc[P, R]cCdSr*r%)r0rXr%r%r&__call__szCacheResourceAPI.__call__NTFr7r5rZr_r9r]r7r8r5r\rZr[r_r$r9r!r]r^,Callable[[Callable[P, R]], CachedFunc[P, R]]cCrqr*r%)r0r7r5rZr_r9r]r%r%r&rrs Callable[P, R] | None?CachedFunc[P, R] | Callable[[Callable[P, R]], CachedFunc[P, R]]c Cs|j|||||||dS)Nrs)ror0rXr7r5rZr_r9r]r%r%r&rrs )r_r]c s8|durfddStt|dS)a Decorator to cache functions that return global resources (e.g. database connections, ML models). Cached objects are shared across all users, sessions, and reruns. They must be thread-safe because they can be accessed from multiple threads concurrently. If thread safety is an issue, consider using ``st.session_state`` to store resources per session instead. You can clear a function's cache with ``func.clear()`` or clear the entire cache with ``st.cache_resource.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``. Cached values are available to all users of your app. If you need to save results that should only be accessible within a session, use `Session State `_ instead. Within each user session, an ``@st.cache_resource``-decorated function returns the cached instance of the return value (if the value is already cached). Therefore, objects cached by ``st.cache_resource`` act like singletons and can mutate. To cache data and return copies, use ``st.cache_data`` instead. To learn more about caching, see `Caching overview `_. .. warning:: Async objects are not officially supported in Streamlit. Caching async objects or objects that reference async objects may have unintended consequences. For example, Streamlit may close event loops in its normal operation and make the cached object raise an ``Event loop closed`` error. To upvote official ``asyncio`` support, see GitHub issue `#8488 `_. To upvote support for caching async functions, see GitHub issue `#8308 `_. Parameters ---------- func : callable The function that creates the cached resource. 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)``. 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 resource is being created. If string, value of show_spinner param will be used for spinner text. show_time : bool Whether to show the elapsed time next to the spinner text. If this is ``False`` (default), no time is displayed. If this is ``True``, elapsed time is displayed with a precision of 0.1 seconds. The time format is not configurable. validate : callable or None An optional validation function for cached data. ``validate`` is called each time the cached value is accessed. It receives the cached value as its only parameter and it must return a boolean. If ``validate`` returns False, the current cached value is discarded, and the decorated function is called to compute a new value. This is useful e.g. to check the health of database connections. 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. Example ------- >>> import streamlit as st >>> >>> @st.cache_resource ... def get_database_session(url): ... # Create a database session object that points to the URL. ... return session >>> >>> s1 = get_database_session(SESSION_URL_1) >>> # Actually executes the function, since this is the first time it was >>> # encountered. >>> >>> s2 = get_database_session(SESSION_URL_1) >>> # Does not execute the function. Instead, returns its previously computed >>> # value. This means that now the connection object in s1 is the same as in s2. >>> >>> s3 = get_database_session(SESSION_URL_2) >>> # This is a different URL, so the function executes. By default, all parameters to a cache_resource 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_resource ... def get_database_session(_sessionmaker, url): ... # Create a database connection object that points to the URL. ... return connection >>> >>> s1 = get_database_session(create_sessionmaker(), DATA_URL_1) >>> # Actually executes the function, since this is the first time it was >>> # encountered. >>> >>> s2 = get_database_session(create_sessionmaker(), DATA_URL_1) >>> # Does not execute the function. Instead, returns its previously computed >>> # value - even though the _sessionmaker parameter was different >>> # in both calls. A cache_resource function's cache can be procedurally cleared: >>> import streamlit as st >>> >>> @st.cache_resource ... def get_database_session(_sessionmaker, url): ... # Create a database connection object that points to the URL. ... return connection >>> >>> fetch_and_clean_data.clear(_sessionmaker, "https://streamlit.io/") >>> # Clear the cached entry for the arguments provided. >>> >>> get_database_session.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. ``Person``) to a hash function (``str``) like this: >>> import streamlit as st >>> from pydantic import BaseModel >>> >>> class Person(BaseModel): ... name: str >>> >>> @st.cache_resource(hash_funcs={Person: str}) ... def get_person_name(person: Person): ... return person.name Alternatively, you can map the type's fully-qualified name (e.g. ``"__main__.Person"``) to the hash function instead: >>> import streamlit as st >>> from pydantic import BaseModel >>> >>> class Person(BaseModel): ... name: str >>> >>> @st.cache_resource(hash_funcs={"__main__.Person": str}) ... def get_person_name(person: Person): ... return person.name Nc stt|dS)NrXrZr_r5r7r9r]rrW)fr]r5rZr_r7r9r%r&sz-CacheResourceAPI._decorator..rxryrwr%r{r&ros< zCacheResourceAPI._decoratorclear_resource_cachescCs tdS)z Clear all cache_resource caches.N)rRrCr/r%r%r&clears zCacheResourceAPI.clear)rnr3r#r))rXrYr#rp)r7r8r5r\rZr[r_r$r9r!r]r^r#rtr*)rXrur7r8r5r\rZr[r_r$r9r!r]r^r#rvrK) rMrNrOrPr1r rrrorr~r%r%r%r&rms8   UrmcspeZdZdZd#fd d Zed$ddZed$ddZd%ddZe dd&ddZ d'd(ddZ d)d!d"Z Z S)*r@z>Manages cached values for a single st.cache_resource function.r2r3r5floatr;r9r!r4r#r)cs<t||_||_t||tjd|_t |_ ||_ dS)N)maxsizer7timer) r`r1r2r4r r TTLCACHE_TIMER _mem_cacher+r,_mem_cache_lockr9)r0r2r5r;r9r4rar%r&r1s   zResourceCache.__init__cC|jjSr*)rrr/r%r%r&r5zResourceCache.max_entriescCrr*)rr7r/r%r%r&r;rzResourceCache.ttl_secondsCachedResult[R]cCsl|j)||jvr t|j|}|jdur#||js#|j|=t|WdS1s/wYdS)zRead a value and associated messages from the cache. Raise `CacheKeyNotFoundError` if the value doesn't exist. N)rrrr9value)r0r2resultr%r%r& read_results  $zResourceCache.read_result_cache_resource_objectrrVmessages list[MsgData]cCsPtjj}tjj}|jt|||||j|<WddS1s!wYdS)z3Write a value and associated messages to the cache.N)st_mainidsidebarrrr)r0r2rrmain_id sidebar_idr%r%r& write_result s "zResourceCache.write_resultN str | NonecCsr|j,|dur|jn||jvr|j|=WddSWddSWddS1s2wYdSr*)rrr~)r0r2r%r%r&_clears   "zResourceCache._clearrDcsTjtj}Wdn1swYddlmfdd|DS)Nr)asizeofcs g|] }tdj|dqS)st_cache_resource) category_name cache_name byte_length)rr4).0entryrr0r%r& &sz+ResourceCache.get_stats..)rlistrrF streamlit.vendor.pympler.asizeofr)r0 cache_entriesr%rr&rHs  zResourceCache.get_stats) r2r3r5rr;rr9r!r4r3r#r))r#r)r2r3r#r)r2r3rrVrrr#r)r*)r2rr#r)rL)rMrNrOrPr1rkr5r;rrrrrHrlr%r%rar&r@s     r@)r r!r"r!r#r$)r#r)ArP __future__rr<r+collections.abcrtypingrrrrrr cachetoolsr typing_extensionsr streamlitrstreamlit.loggerr streamlit.runtime.cachingr &streamlit.runtime.caching.cache_errorsr$streamlit.runtime.caching.cache_typer%streamlit.runtime.caching.cache_utilsrrrr/streamlit.runtime.caching.cached_message_replayrrrstreamlit.runtime.metrics_utilrstreamlit.runtime.statsrrrstreamlit.time_utilrdatetimer!streamlit.runtime.caching.hashingrrMr__annotations__rcrer$rr'r(rRrSrUrVrWrmr@r%r%r%r&sF               B .