Skip to main content

Cache.expire()

Remove every expired entry, and its value file.

Usage

Source

Cache.expire(
    *,
    timeout=None,
)

Works in chunks and lets other writers in between them.

Parameters

timeout: float | None = None
Seconds each chunk may wait for the write lock (another thread’s or another process’s), for this call only (default: the cache’s timeout). It bounds each wait, not the whole call.

Returns

int
How many entries were removed.

Examples

removed = cache.expire(timeout=10.0)   # from a scheduled job, with its own timeout