Changes

How to try Client-Side Caching

1. Install redis-py 5.1.0b4
2. Use the following code example to get started:

import redis

# enable csc
r = redis.Redis(
    "localhost", 6379, protocol=3,
    cache_enabled=True, cache_ttl=100, cache_max_size=1000,
    # cache_blacklist=["GET", "LLEN"] # if needed, you can exclude certain commands from caching
)

r.set("foo", "bar")
r.get("foo")
r.get("foo")  # this will be fetched from cache

# manually invalidate key in cache
r.invalidate_key_from_cache("foo")

# or flush the entire cache
r.flush_cache()

🚀 New Features

• Allow setting the minimum SSL version (#3127)
• Add modules support to Async RedisCluster (#3115)

🐛 Bug Fixes

• Client side caching causes unexpected disconnections (#3160) (#3165)
• Fix retry logic for pubsub and pipeline (#3134)
• Ignore TypeError on disconnect (within multiprocess) (#3149)
• Release already acquired connections on ClusterPipeline, when get_connection raises an exception (#3133)

🧰 Maintenance

• Fix incorrect asserts in test and ensure connections are closed (#3004)
• Remove typing-extensions from dependencies (#3146)
• Revert stale issue version update (#3142)
• Docs: Add timeout parameter for get_message example (#3129)
• Bump codecov/codecov-action from 3 to 4 (#3131)
• Bump actions/stale from 3 to 9 (#3132)
• Fix grammar in BlockingConnectionPool class documentation (#3120)

Contributors

We'd like to thank all the contributors who worked on this release!

@AYMENJD, @AniketP04, @BackflipPenguin, @ING-XIAOJIAN, @MrDenkoV, @Pedram-Parsian, @TheBlusky, @ahmedabdou14, @akx, @chayim, @d184230, @danielzhangau, @dependabot, @dependabot[bot], @dmkulazhenko, @dvora-h, @enjoy-binbin, @hongqn, @jakob-keller, @kristjanvalur, @mattwang44, @parmenashp, @poiuj, @r0ro, @sjpotter, @tbbream, @trkwyk, @w-miller, @wKollendorf, @zakaf, @zware and @zxjlm