Skip to content

Redis Adapter

Module: Caching — Module Guide Package: pyfly.cache.adapters.redis Backend: redis 7.4+ (with hiredis C parser)

Quick Start

Installation

uv add "pyfly[cache]"

# Or just the Redis client
uv add "pyfly[redis]"

Minimal Configuration

# pyfly.yaml
pyfly:
  cache:
    enabled: true
    provider: "redis"
    redis:
      url: "redis://localhost:6379/0"

Minimal Example

from pyfly.cache import cacheable, cache_evict
from pyfly.cache.adapters.redis import RedisCacheAdapter

cache = RedisCacheAdapter(url="redis://localhost:6379/0")

@cacheable(backend=cache, key="order:{id}")
async def find_by_id(self, id: int) -> Order:
    return await self._repo.find_by_id(id)

@cache_evict(backend=cache, key="order:{id}")
async def delete_order(self, id: int) -> None:
    await self._repo.delete(id)

Configuration Reference

Key Type Default Description
pyfly.cache.enabled bool false Enable caching
pyfly.cache.provider str "memory" Adapter selection (auto, redis, memory)
pyfly.cache.redis.url str "redis://localhost:6379/0" Redis connection URL
pyfly.cache.ttl int 300 Default TTL in seconds

When provider is "auto", PyFly uses Redis if the redis library is installed, otherwise falls back to InMemoryCache.

Adapter-Specific Features

RedisCacheAdapter

Implements CacheAdapter using redis.asyncio.Redis.

  • Serialization: Values are JSON-serialized before storage and deserialized on retrieval
  • TTL: Supports per-key TTL via timedelta or the global default
  • Connection validation: Calls ping() on start() to verify connectivity

Operations

Method Description
get(key) Retrieve and deserialize a cached value
put(key, value, ttl) Serialize and store a value with optional TTL
evict(key) Remove a key from the cache
exists(key) Check if a key exists
clear() Flush all keys (uses flushdb)

In-Memory Fallback

When Redis is not available, InMemoryCache (pyfly.cache.adapters.memory) provides the same CacheAdapter interface using an in-process dict with TTL support. This is auto-configured when the redis library is not installed.

Testing

Use the in-memory adapter for tests — no Redis server needed:

# pyfly-test.yaml
pyfly:
  cache:
    provider: "memory"

See Also