build_lock#

scikitplot.cython.build_lock(lock_dir, *, timeout_s=60.0, poll_s=0.05, stale_after_s=None)[source]#

Acquire an exclusive build lock via atomic directory creation.

Parameters:

lock_dirpathlib.Path: Lock directory path to create atomically.
timeout_sfloat, default=60.0: Maximum seconds to wait for the lock. A value of 0 makes a single acquisition attempt and raises TimeoutError immediately if the lock is already held.
poll_sfloat, default=0.05: Sleep interval in seconds between acquisition retries.
stale_after_sfloat | None, default=None: Age in seconds after which an existing lock may be reclaimed as stale. When None, the effective threshold is max(timeout_s, _DEFAULT_STALE_AFTER_S).

Returns:

Iterator[None]: Context manager that yields once the lock is held.

Raises:

TimeoutError: If the lock cannot be acquired within timeout_s seconds.
ValueError: If timeout_s < 0, poll_s <= 0, or an explicit stale_after_s <= 0.

Parameters:

lock_dir (Path)
timeout_s (float)
poll_s (float)
stale_after_s (float | None)

Return type:

Iterator[None]

Notes

Stale lock recovery: if a lock directory exists but its mtime is older than the effective stale threshold, it is treated as stale (left by a killed process) and removed before the next acquisition attempt. The threshold is stale_after_s when supplied; otherwise it is max(timeout_s, _DEFAULT_STALE_AFTER_S).

Clean release: the lock directory is always removed in the finally block, so normal exceptions inside the with body release the lock correctly.