file¶
- class litestar.stores.file.FileStore¶
Bases:
NamespacedStore
File based, thread and process safe, asynchronous key/value store.
- path¶
file path
- create_directories¶
flag to create directories in path
- with_namespace(namespace: str) FileStore ¶
Return a new instance of
FileStore
, using a sub-path of the current store’s path.
- async set(key: str, value: str | bytes, expires_in: int | timedelta | None = None) None ¶
Set a value.
- async get(key: str, renew_for: int | timedelta | None = None) bytes | None ¶
Get a value.
- Parameters:
- Returns:
The value associated with
key
if it exists and is not expired, elseNone
- async delete(key: str) None ¶
Delete a value.
If no such key exists, this is a no-op.
- Parameters:
key¶ – Key of the value to delete
- async delete_all() None ¶
Delete all stored values.
Note
This deletes and recreates
FileStore.path