panel.io.cache module#
Implements memoization for functions with arbitrary arguments
- panel.io.cache.cache(func: Literal[None] = None, hash_funcs: dict[type[Any], Callable[[Any], bytes]] | None = None, max_items: int | None = None, policy: Literal['FIFO', 'LRU', 'LFU'] = 'LRU', ttl: float | None = None, to_disk: bool = False, cache_path: str | PathLike = './cache', per_session: bool = False) Callable[[Callable[_P, _R]], _CachedFunc[Callable[_P, _R]]][source]#
- panel.io.cache.cache(func: Callable[_P, _R], hash_funcs: dict[type[Any], Callable[[Any], bytes]] | None = None, max_items: int | None = None, policy: Literal['FIFO', 'LRU', 'LFU'] = 'LRU', ttl: float | None = None, to_disk: bool = False, cache_path: str | PathLike = './cache', per_session: bool = False) _CachedFunc[Callable[_P, _R]]
Memoizes functions for a user session. Can be used as function annotation or just directly.
For global caching across user sessions use pn.state.as_cached.
- Parameters:
- func: callable
The function to cache.
- hash_funcs: dict or None
A dictionary mapping from a type to a function which returns a hash for an object of that type. If provided this will override the default hashing function provided by Panel.
- max_items: int or None
The maximum items to keep in the cache. Default is None, which does not limit number of items stored in the cache.
- policy: str
- A caching policy when max_items is set, must be one of:
FIFO: First in - First out
LRU: Least recently used
LFU: Least frequently used
- ttl: float or None
The number of seconds to keep an item in the cache, or None if the cache should not expire. The default is None.
- to_disk: bool
Whether to cache to disk using diskcache.
- cache_path: str
Directory to cache to on disk.
- per_session: bool
Whether to cache data only for the current session.
- panel.io.cache.compute_hash(func, hash_funcs, args, kwargs)[source]#
Computes a hash given a function and its arguments.
- Parameters:
- func: callable
The function to cache.
- hash_funcs: dict
A dictionary of custom hash functions indexed by type
- args: tuple
Arguments to hash
- kwargs: dict
Keyword arguments to hash
