v5.3.1: 5.3.1

Compare Source

Changes

🧰 Maintenance

• Allow newer PyJWT versions for branch 5.3 (#​3682)

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

v5.3.0: 5.3.0

Compare Source

Changes

🚀 New Features

Token-based authentication:

• Added StreamingCredentialProvider interface (#​3445)
• Extended CredentialProvider class with get_credentials_async method (#​3445)
• Added event-driven entities (Dispatcher, Listener, Events) (#​3445)

NewStreamingCredentialProvider interface was added with an idea to integrate redis-py with credential providers that stream an events that should be handled by given listeners.

Check thedocumentation for the quick start guide.

CredentialProvider instance creation interface was enhanced. Feel free to check the updateddocumentation

Other features:

• Exponential with jitter backoff (#​3550)
• Adding load balancing strategy configuration to cluster clients(replacement for 'read_from_replicas' config) (#​3563)

⚠️ Deprecations

• Deprecating unused arguments in connection pools's get_connection functions(#​3517#​3625)
• Adding load balancing strategy configuration to cluster clients(replacement for 'read_from_replicas' config) (#​3563)

🐛 Bug Fixes

• When SlotNotCoveredError is raised, the cluster topology should be reinitialized as part of error handling and retrying of the commands. (#​3621)
• Fixed Token-based authentication documentation
• Fixed bug with missing PyJWT dependency (#​3462)
• Fixed flacky TokenManager test (#​3468)
• Fix incorrect attribute reuse in redis.connection.CacheProxyConnection (#​3456)
• Moved self._lock initialisation to Pool constructor (#​3473)
• Remove decreasing of created connections count when releasing not owned by connection pool connection(fixes issue#​2832). (#​3514)

🧰 Maintenance

• Updated CredentialProvider test infrastructure (#​3502)
• Expand type for EncodedT (#​3472)
• DOC-4423: add TCEs for various command pages (#​3476)
• DOC-4345 added testable JSON search examples for home page (#​3407)
• DOC-4796 fixed capped lists example (#​3493)
• Added unit test fix to improve compatibility with MacOS (#​3486)
• Added missing type hints (#​3494#​3495#​3496#​3357)
• Replacing the redis and redis-stack-server images with redis-libs-tests image in test infrastructure (#​3505)

Contributors

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

@​uglide@​woutdenolf@​vladvildanov@​hauntsaninja@​dwdougherty@​patrick91@​Vulwsztyn@​JimNero009@​andy-stark-redis@​petyaslavova

v5.2.1: 5.2.1

Compare Source

Changes

🐛 Bug Fixes

• Fixed unsecured tempfile.mktemp() command usage (#​3446)
• Fixed bug with SLOWLOG GET response parsing on Redis Software (#​3441)
• Fixed issue with invoking _close() on closed event loop (#​3438)

🧰 Maintenance

• Migrate test infrastructure to new custom docker images (#​3415)
• Fixed flacky test with HEXPIREAT command (#​3437)

Contributors

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

@​IlianIliev@​uglide@​vladvildanov@​teodorfn@​akx

v5.2.0: 5.2.0

Compare Source

Changes

🚀 New Features

• Extend AggregateRequest with scorer argument (#​3409)

🧰 Maintenance

• Pin pytest-profiling version due to the bug (#​3417)

Contributors

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

@​uglide@​rbs333@​vladvildanov@​dwdougherty

v5.1.1: 5.1.1

Compare Source

Changes

5.1.1

🐛 Bug Fixes

• Fixed return type for Redis Set commands to be Set instead of List (#​3399)
• Fixed bug with partial Hiredis availability (#​3400)
• Fixed bug with async pipeline and cluster fails with some commands (#​3402)

5.1.0

🚀 New Features

• Client-side caching (#​3350,#​3110,#​3102,#​3099,#​3089,#​3038)

How to start with Client-side caching?

1. Install redis-py 5.1.0
2. Use the following code snippet:

r=Redis(protocol=3,cache_config=CacheConfig())cache=r.get_cache()r.set("foo","bar")### get key from redis and save in local cacheprint(r.get("foo"))### get key from local cacheprint(cache.get(CacheKey(command="GET",redis_keys=("foo",))).cache_value)### change key in redis (cause invalidation)r.set("foo","barbar")### Retrieves a new value from server and cache itprint(r.get("foo"))### Make sure that new value was cachedprint(cache.get(CacheKey(command="GET",redis_keys=("foo",))).cache_value)

Checkdocumentation to get more examples

🔥 Breaking Changes

• Timeseries insertion filters for close samples (#​3228)
• Enhanced classes string representation (#​3001)
• Partial clean up of Python 3.7 compatibility (#​2928)
• Handle Redis Set data type as Python list to avoid a limitations with nested dictionaries (#​3324)

Contributors

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

@​vladvildanov@​dmaier-redislabs@​vineethvkumar@​ramchandra-st@​RafalBielickiIM@​jules-ch

v5.1.0: 5.1.0

Compare Source

Changes

🚀 New Features

• Client-side caching (#​3350,#​3110,#​3102,#​3099,#​3089,#​3038)

How to start with Client-side caching?

1. Install redis-py 5.1.0
2. Use the following code snippet:

r=Redis(protocol=3,cache_config=CacheConfig())cache=r.get_cache()r.set("foo","bar")### get key from redis and save in local cacheprint(r.get("foo"))### get key from local cacheprint(cache.get(CacheKey(command="GET",redis_keys=("foo",))).cache_value)### change key in redis (cause invalidation)r.set("foo","barbar")### Retrieves a new value from server and cache itprint(r.get("foo"))### Make sure that new value was cachedprint(cache.get(CacheKey(command="GET",redis_keys=("foo",))).cache_value)

Checkdocumentation to get more examples

🔥 Breaking Changes

• Timeseries insertion filters for close samples (#​3228)
• Enhanced classes string representation (#​3001)
• Partial clean up of Python 3.7 compatibility (#​2928)
• Handle RESP3 sets as Python lists (#​3324)

🐛 Bug Fixes

• Handle RESP3 sets as Python lists (#​3324)
• Prevent async ClusterPipeline instances from becoming "false-y" (#​3068)
• Add hostname field to _parse_node_line (#​3343)
• More docs fixes (#​3326)
• Delete the first-defined (and thus "duplicate") Script class (#​3333)
• Catch a known DeprecationWarning when calling .close() (#​3335)
• Add missed redismod at test_commands.py (#​3369)

🧰 Maintenance

• Update README.md - mentioning redis 7.4 support (#​3375)
• Update PyPy 3.8 to 3.10 in CI (#​3370)
• Updated commands from docker-compose to docker compose (#​3352)
• Added version restrictions for pytest-asyncio (#​3362)
• Documentation examples (#​3361,#​3372,#​3374,#​3377,#​3378)

Contributors

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

@​AYMENJD,@​AniketP04,@​BackflipPenguin,@​ING-XIAOJIAN,@​MrDenkoV,@​Pedram-Parsian,@​TheBlusky,@​TomerHekmati,@​Wh1isper,@​Zaczero,@​ahmedabdou14,@​akx,@​andy-stark-redis,@​catap,@​chayim,@​d184230,@​danielzhangau,@​daveisfera,@​dependabot,@​dependabot[bot],@​dkuser,@​dmaier-redislabs,@​dmkulazhenko,@​dudizimber,@​dvora-h,@​dwdougherty,@​enjoy-binbin,@​gerzse,@​hongqn,@​jakob-keller,@​kristjanvalur,@​kurtmckee,@​matrey,@​mattwang44,@​max-muoto,@​parmenashp,@​poiuj,@​r0ro,@​sjpotter,@​tbbream,@​trkwyk,@​uglide,@​vladvildanov,@​w-miller,@​wKollendorf,@​willfrey,@​willianmrs,@​zakaf,@​zware and@​zxjlm

v5.0.8: 5.0.8

Compare Source

Changes

• Resolve some docs warnings (#​3322)
• Add missing type hints for retry.py (#​3250)

🔥 Breaking Changes

• Timeseries insertion filters for close samples (#​3228)

🚀 New Features

• Hash field expiration commands (#​3218)
• Support the MAXAGE option for CLIENT KILL (#​3187)
• Support NOVALUES parameter for HSCAN (#​3157)
• Document XREAD of last message (+) (#​3187)
• Support missing/empty values in search (#​3231)
• Timeseries insertion filters for close samples (#​3228)

🧰 Maintenance

• Add extra tests for GEO search (#​3244)
• Test special characters escaping in search (#​3276)

🐛 Bug Fixes

• Decode search results at field level (#​3309)