Cache.clear()

Remove every entry that existed when the call started.

Usage

Source

Cache.clear(
    *,
    timeout=None,
)

Works in chunks and lets other writers in between them. Writes that land while it runs, including overwrites of existing keys, are kept. Afterwards it sweeps the large-value folders (D-042): a temp file no writer has touched for an hour (left by a process killed mid-write) is removed, and every empty folder goes, for at most 100 ms in all, unless this thread is inside a transaction (any cache’s).

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

cache.clear(timeout=10.0)   # safe while other processes keep writing