pin#

scikitplot.cython.pin(key, *, alias, cache_dir=None, overwrite=False, lock_timeout_s=60.0)[source]#

Pin a cache key under a human-friendly alias.

Parameters:
keystr

Cache key (64 hex chars).

aliasstr

Alias name (identifier-like).

cache_dirstr or pathlib.Path or None, default=None

Cache root. If None, uses the default cache location.

overwritebool, default=False

If False, collisions raise ValueError. If True, overwrite existing mapping.

lock_timeout_sfloat, default=60.0

Max seconds to wait for the pin registry lock.

Returns:
str

The pinned key.

Raises:
ValueError

If alias/key are invalid or a collision occurs without overwrite.

Parameters:
Return type:

str