atproto_identity.cache.base_cache¶
- class atproto_identity.cache.base_cache.AsyncDidBaseCache(stale_ttl: int | None = None, max_ttl: int | None = None)¶
Bases:
_DidBaseCache
,ABC
Asynchronous Abstract DID Cache.
- Parameters:
stale_ttl – Stale TTL in seconds. Default is 1 hour.
max_ttl – Max TTL in seconds. Default is 1 day.
- abstract async clear() None ¶
Clear cached DIDs.
Note
This method is used to clear all cached DIDs.
- abstract async delete(did: str) None ¶
Delete cached DID.
- Parameters:
did – DID.
- abstract async get(did: str) CachedDidResult | None ¶
Get cached DID.
- Parameters:
did – DID.
- Returns:
Cached DID result or
None
if not found.- Return type:
CachedDidResult
- abstract async refresh(did: str, get_doc_callback: Callable[[], Coroutine[Any, Any, DidDocument | None]]) None ¶
Refresh cached DID.
- Parameters:
did – DID.
get_doc_callback – Get DID document callback.
- abstract async set(did: str, document: DidDocument) None ¶
Set cached DID.
- Parameters:
did – DID.
document – DID document.
- class atproto_identity.cache.base_cache.DidBaseCache(stale_ttl: int | None = None, max_ttl: int | None = None)¶
Bases:
_DidBaseCache
,ABC
Abstract DID Cache.
- Parameters:
stale_ttl – Stale TTL in seconds. Default is 1 hour.
max_ttl – Max TTL in seconds. Default is 1 day.
- abstract clear() None ¶
Clear cached DIDs.
Note
This method is used to clear all cached DIDs.
- abstract delete(did: str) None ¶
Delete cached DID.
- Parameters:
did – DID.
- abstract get(did: str) CachedDidResult | None ¶
Get cached DID.
- Parameters:
did – DID.
- Returns:
Cached DID result or
None
if not found.- Return type:
CachedDidResult
- abstract refresh(did: str, get_doc_callback: Callable[[], DidDocument | None]) None ¶
Refresh cached DID.
- Parameters:
did – DID.
get_doc_callback – Get DID document callback.
- abstract set(did: str, document: DidDocument) None ¶
Set cached DID.
- Parameters:
did – DID.
document – DID document.