Redis¶

The utkit.store.redis module provides a singleton-backed Redis client with a simple interface for common cache and store operations, built on top of redis-py.

Installation¶

redis is part of the optional store extras. Install utkit with the store extra:

pip install "utkit[store]"

Or with uv:

uv add "utkit[store]"

Quick start¶

from utkit.store.redis import RedisManager

redis = RedisManager(url="redis://localhost:6379/0")

redis.set("user:1", {"name": "Alice", "role": "admin"}, ttl=3600)

user = redis.get("user:1")
print(user)  # {'name': 'Alice', 'role': 'admin'}

RedisManager¶

A class that wraps a shared redis.Redis client instance. The underlying connection is created once per process (singleton pattern) and reused across all RedisManager instances.

Values are automatically serialised to JSON on write and deserialised on read, so you can store any JSON-compatible Python object.

Constructor¶

RedisManager(url: str)

redis = RedisManager(url="redis://localhost:6379/0")

set¶

Stores a value under the given key, serialised as JSON.

def set(self, key: str, value: Any, ttl: int | None = None) -> bool

Returns: bool — True if the key was set successfully.

Raises: RuntimeError — if the Redis operation fails.

redis.set("session:abc", {"user_id": 42}, ttl=1800)

get¶

Retrieves and deserialises the value stored at a key.

def get(self, key: str) -> Any

Returns: The deserialised Python value, or None if the key does not exist.

Raises: RuntimeError — if the Redis operation fails.

session = redis.get("session:abc")

delete¶

Deletes a key from Redis.

def delete(self, key: str) -> int

Returns: int — the number of keys deleted (1 if found and deleted, 0 if the key did not exist).

Raises: RuntimeError — if the Redis operation fails.

redis.delete("session:abc")

exists¶

Checks whether a key exists in Redis.

def exists(self, key: str) -> bool

Returns: bool — True if the key exists, False otherwise.

if redis.exists("session:abc"):
    print("Session is active")

expire¶

Sets or updates the TTL (time-to-live) of an existing key.

def expire(self, key: str, ttl: int) -> bool

Returns: bool — True if the TTL was set, False if the key does not exist.

redis.expire("session:abc", 600)

Connection URLs¶

# With password
redis = RedisManager(url="redis://:mypassword@localhost:6379/0")

# With TLS
redis = RedisManager(url="rediss://localhost:6380/0")