WIP: Documentation improvement and format change to Google
Some checks failed
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 1m2s
Tests / Build and Test (3.12) (pull_request) Failing after 1m0s
Tests / Build and Test (3.13) (pull_request) Failing after 59s
Some checks failed
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 1m2s
Tests / Build and Test (3.12) (pull_request) Failing after 1m0s
Tests / Build and Test (3.13) (pull_request) Failing after 59s
This commit is contained in:
11
src/libbot/cache/manager/manager.py
vendored
11
src/libbot/cache/manager/manager.py
vendored
@@ -9,6 +9,17 @@ def create_cache_client(
|
||||
prefix: Optional[str] = None,
|
||||
default_ttl_seconds: Optional[int] = None,
|
||||
) -> CacheMemcached | CacheRedis:
|
||||
"""Create a cache client of a provided type.
|
||||
|
||||
Args:
|
||||
config (Dict[str, Any]): Cache client configuration.
|
||||
engine (Literal["memcached", "redis"] | None): Cache engine to use. Defaults to None.
|
||||
prefix (:obj:`str`, optional): Prefix used for each key-value pair. Defaults to None (no prefix).
|
||||
default_ttl_seconds (:obj:`int`, optional): Default TTL for values (in seconds). Defaults to None (does not expire).
|
||||
|
||||
Returns:
|
||||
CacheMemcached | CacheRedis: Cache client.
|
||||
"""
|
||||
if engine not in ["memcached", "redis"] or engine is None:
|
||||
raise KeyError(f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'")
|
||||
|
||||
|
Reference in New Issue
Block a user