Repository navigation
Releases: redis/redis-py
Release list
8.1.0
Changes
β¨ Highlights
Async maintenance notifications
redis-py now supports server-pushed maintenance notifications in the asyncio stack for both
standalone and cluster clients, bringing the async client to parity with the sync implementation.
When a Redis deployment signals maintenance events (such as node migration or failover windows), the
async client reacts through the maintenance-notifications handler (redis/maint_notifications.py and
its async integration under redis/asyncio/), allowing applications to adapt connection handling
during maintenance without downtime. (#4177)
Expanded command coverage
This release adds a batch of new command surfaces across core data types and modules:
- Lists β
LMOVEM/BLMOVEMfor moving multiple elements between lists (#4174). - Sets β
SDIFFCARDandSUNIONCARDcardinality commands (#4171). - Streams β
MAXCOUNT/MAXSIZEoptions forXREADandXREADGROUP(#4173). - Time Series β
TS.READ(#4170),TS.QUERYLABELS(#4197),TS.NRANGE/TS.NREVRANGE(#4163),
and anexclude_empty(EXCLUDEEMPTY) option forTS.MRANGE/TS.MREVRANGE(#4188). - Search β
FT.ALIASLIST(#4198) and aCOLLECTreducer for aggregations (#4179). - Sentinel β replica sentinel aliases (#4127).
π New Features
- Add replica sentinel aliases (#4127)
- Add TS.NRANGE and TS.NREVRANGE support to the timeseries command surface (#4163)
- feat: add TS.READ command support to the timeseries module (#4170)
- feat: add SDIFFCARD and SUNIONCARD command support (#4171)
- feat: add MAXCOUNT/MAXSIZE support to XREAD and XREADGROUP (#4173)
- feat: add LMOVEM and BLMOVEM commands for moving multiple list elements (#4174)
- feat: add async maintenance-notifications support for standalone and cluster clients (#4177)
- feat: add COLLECT reducer support to search aggregations (#4179)
- feat: add exclude_empty (EXCLUDEEMPTY) option to TS.MRANGE and TS.MREVRANGE (#4188)
- feat: add TS.QUERYLABELS support to the timeseries command surface (#4197)
- feat: add FT.ALIASLIST support (#4198)
β οΈ Experimental
- feat: add client-side HIMPORT fieldset support for standalone and cluster clients (#4205)
The feature considered unstable and public API might be changed in the future minor version
π Bug Fixes
- fix: detect closed pooled connection without consuming pending push data (RESP3 + hiredis) (#4156)
- Fix Sentinel pool capacity loss after failover (#4193)
- fix: Restore NEVER_DECODE option for FT.SEARCH with protocol=3 (#4196)
- Decode ACL LOG string values on the default RESP3 legacy callback (#4201)
- fix: Fixed double decoding issue with unquote() (#4222)
- Fix lat/lon swap in search querystring geo() helper (#4223)
- Fix FIELDNAME alias dropping first character of un-prefixed fields (#4224)
π§° Maintenance
- ci: report test duration metrics to Grafana Cloud (PAWS) (#4132)
- fix(hiredis): raise ConnectionError instead of AttributeError on concurrent disconnect (#4136)
- docs: consolidate AI-agent guidance into root AGENTS.md and portable agents/skills (#4159)
- Bump actions/checkout from 6 to 7 (#4160)
- Bump rojopolis/spellcheck-github-actions from 0.60.0 to 0.62.0 (#4161)
- test(search): add multi-language RediSearch coverage, re-enable search module pipeline tests, add 8.10 to CI matrix (#4162)
- Remove stale "connection" arg from get_resolved_ip docstring (#4164)
- Add context manager support to ConnectionPool (#4167)
- test: add unit tests for cluster key_slot hash-tag logic (#4168)
- Add unit tests for string helper utilities (#4180)
- test: add unit tests for decode_field_value (#4181)
- Add unit tests for extract_expire_flags and truncate_text (#4183)
- fix: add close()/aclose() to Sentinel to release sentinel client pools (#4184)
- test: add FT.SEARCH server-timeout coverage for return and fail policies (#4186)
- test: run the standard suite against an external Redis Enterprise database (#4189)
- build: bump Read the Docs build.os from ubuntu-20.04 to ubuntu-24.04 (#4190)
- fix: add missing type annotations to LockError and RedisClusterException (#4194)
- test: add VectorField RERANK serialization tests for sync and async search (#4202)
We'd like to thank all the contributors who worked on this release!
@LOGESHWAR123 @kiryazovi-redis @Stunned1 @eeshsaxena @sean-kim05 @Brumbelow @Sanjays2402 @nazarli-shabnam @chuenchen309 @petyaslavova
8.0.1
Changes
π Bug Fixes
- Fix Unix socket maintenance notification handling and tests (#4097)
- Fix async cluster node connection release on write errors (#4111)
- Fixed async MultiDBClient with underlying RedisCluster (#4108)
- Fix hiredis readiness checks for high file descriptors (#4115)
- fix(search): parse RESP3 FT.SEARCH responses with bytes-typed keys (#4109)
- Fixing pubsub's listen method to be blocking. (#4119)
- fix(asyncio): release pooled connection when Pipeline.reset() is cancelled (#4123)
- Avoid per-check fd allocation in hiredis _socket_can_read() β use poll() instead of a per-call selector (#4118)
π§° Maintenance
- Updating PyJWT dependency. (#4100)
- Update CI badge in README.md (#4099)
- Add missing url query argument parser for ssl_min_version (#4047)
- ci: least-privilege permissions on spellcheck (read) and stale-issues (job-level write for actions/stale) (#4080)
- Bumping github-versions actions (#4102)
- Updating lib version + supported Redis versions in README.md + updating the Redis versions in CI test matrix (#4092)
We'd like to thank all the contributors who worked on this release!
@violuke @mokashang @arpitjain099 @coredumperror @elena-kolevska @vladvildanov @petyaslavova
7.4.1
Changes
π Bug Fixes
- Preserve explicit None for client metadata config (#4081)
π§° Maintenance
- Updating PyJWT dependency. (#4100)
- Addressing dependency vulnerabilities and flaky test fixes (source diff)
We'd like to thank all the contributors who worked on this release!
@elena-kolevska @vladvildanov @petyaslavova
7.3.1
Changes
π Bug Fixes
- Preserve explicit None for client metadata config (#4081)
π§° Maintenance
- Updating PyJWT dependency. (#4100)
- Addressing dependency vulnerabilities and flaky test fixes (source diff)
We'd like to thank all the contributors who worked on this release!
@elena-kolevska @vladvildanov @petyaslavova
7.2.2
Changes
π Bug Fixes
- Preserve explicit None for client metadata config (#4081)
π§° Maintenance
- Updating PyJWT dependency. (#4100)
- Addressing dependency vulnerabilities and flaky test fixes (source diff)
We'd like to thank all the contributors who worked on this release!
@elena-kolevska @vladvildanov @petyaslavova
8.0.0
Changes
π Highlights
Async Cluster PubSub
This release introduces full asyncio Cluster PubSub support, bringing shard-channel capabilities (SSUBSCRIBE, SUNSUBSCRIBE, SPUBLISH) to the async RedisCluster client. The new ClusterPubSub class in redis.asyncio.cluster automatically routes shard-channel subscriptions to the correct cluster node based on key-slot hashing, manages per-node PubSub connections, and supports round-robin message retrieval across nodes. Users can create a cluster pubsub instance via RedisCluster.pubsub() and use ssubscribe(), sunsubscribe(), and get_sharded_message() just as they would with the sync cluster client.
Keyspace and subkey notifications
Redis Keyspace Notifications are now supported for standalone and cluster deployments in both sync and async modes. New classes β KeyspaceNotifications, ClusterKeyspaceNotifications, AsyncKeyspaceNotifications, and AsyncClusterKeyspaceNotifications β provide a high-level API for keyspace/keyevent subscriptions and subkey notification families: subkeyspace, subkeyevent, subkeyspaceitem, and subkeyspaceevent. Convenience methods like subscribe_keyspace(), subscribe_keyevent(), subscribe_subkeyspace(), subscribe_subkeyevent(), subscribe_subkeyspaceitem(), and subscribe_subkeyspaceevent() simplify common patterns, with channel classes for both key and subkey channels.
In cluster mode, subscriptions are managed across primary nodes because each node emits notifications only for keys it owns, with built-in topology-change handling. Sync run_in_thread() and async listen() workflows are supported.
Redis Array commands(https://redis.io/docs/latest/develop/data-types/arrays/)
redis-py now supports Redis Arrays, a preview Redis data type for sparse, index-addressable sequences of strings. New AR* command helpers cover indexed reads/writes, range scans, deletion, cursor-based insertion, ring-buffer writes, metadata, text search, and aggregation, including ARGET, ARSET, ARMGET, ARMSET, ARSCAN, ARGREP, ARRING, and AROP.
Type Hints Improvements (breaking changes)
The @overload pattern has been applied systematically across core commands (core.py), VectorSet commands, and module commands (Search, JSON, TimeSeries, Bloom filters) to provide distinct return types for sync and async clients. Previously, methods returned a combined ResponseT (i.e., Union[Awaitable[Any], Any]), which caused static analysis tools like mypy and Pyright to flag false positives. Now, sync clients see concrete return types (e.g., int, bool, list[str]) while async clients see Awaitable[...] wrappers. This is a breaking change for type-checking onlyβruntime behavior is unchanged, but code relying on the old union return types in type annotations may need updates. Two new protocol types, SyncClientProtocol and AsyncClientProtocol, are used in overload signatures to enable this distinction.
RESP3 by default with opt-in unified responses
redis-py 8.0.0 now uses RESP3 on the wire by default while preserving legacy RESP2-compatible Python response shapes for existing applications (#4052). Protocol-independent unified response shapes are available by setting legacy_responses=False, so affected commands return the same Python structure with RESP2 or RESP3.
Use protocol=2 to force RESP2 on the wire, protocol=3 to opt into native RESP3 response shapes, or legacy_responses=False to migrate to unified responses. See docs/unified_responses.rst and specs/unified_responses_migration_guide.md for the affected commands and migration details.
Connection and retry defaults
Default connection settings were updated: socket_timeout and socket_connect_timeout now default to 5 seconds, TCP keepalive is enabled by default, socket reads use a 32 KB buffer, connection pools default to max_connections=100, and retry defaults now use 10 attempts with exponential jitter backoff.
Note: socket_timeout can affect blocking commands such as BLPOP/BRPOP; if a command blocks longer than the client socket timeout, it may raise TimeoutError before the command timeout elapses (#2807).
π§ͺ Experimental Features
- Added support for new array commands (#4055)
π New Features
- Support Cluster PubSub in asyncio (#3736)
- Add Redis Keyspace Notifications Support for Redis Cluster (#3962)
- Add random load balancing strategy which allows for use of the primary (#4027)
- Add FPHA (floating-point homogeneous array) arg support to JSON.SET (#4011)
- Added custom Claude command + XNACK command support (#4030)
- Adding Time Series Multiple Aggregators support (#4035)
- Adding support for new COUNT aggregator for some sorted set commands - ZINTER, ZINTERSTORE, ZUNION, ZUNIONSTORE (#4034)
- Adding support for new INCREX command (#4067 #4077)
- Add support for PubSub subscriptions with binary channel names and handlers (#4068)
π₯ Breaking changes
- Type hints improvements - fixing static code analysis issues related to combined sync and async return types(vectorsets + commands in core.py) (#3991)
- Type hints improvements - fixing static code analysis issues related to combined sync and async return types - modules (#4005)
- Add Redis Keyspace Notifications Support for Redis Cluster (#3962)
- Added support for subkey notifications (#4040)
- Changing the default protocol used to RESP3, keeping the responses for the default config compatible with the current RESP2 shape. Adding the possibility to opt-in for unified responses for both protocols. (#4025 #4031 #4052 #4046)
- Type Lock.extend and Lock.reacquire as Literal[True] (#4045)
- Handle cluster slot migration in ClusterPubSub (shard subscription reconciliation) (#4044)
- Avoid zero-timeout async reads in hiredis connections readiness checks and replace async's can_read_destructive with non-destructive can_read. (#4063)
- Updates in default connection and retry settings (#4082)
π Bug Fixes
- fix: guard disconnect() against RuntimeError on Python 3.13+ (#3856) (#4013)
- Fix CacheProxyConnection hang when invalidation arrives on another connection (#3600) (#4014)
- fix: handle scientific notation in score_cast_func for RESP2 (#4016)
- Fix TypeError in CacheProxyConnection when cached response is non-bytes (#4017)
- Fix async cluster connection cleanup on topology refresh (#4057)
- Normalize scalar prefixes in IndexDefinition (#3983)
- Avoid zero-timeout async reads in hiredis connections readiness checks and replace async's can_read_destructive with non-destructive can_read. (#4063)
- Preserve explicit None for client metadata config (#4081)
β οΈ Deprecations
- Align deprecation of lib_name/lib_version in async cluster (#3995)
- Add deprecation notice to setex() method documentation (#4051)
- Avoid zero-timeout async reads in hiredis connections readiness checks and replace async's can_read_destructive with non-destructive can_read. (#4063)
π§° Maintenance
- Adding unstable 8.8 build to pipeline test matrix. Updating the lib version in master. (#4004)
- Fix type hints for register_script to support RedisCluster (#3876)
- Updating dependencies to fix reported vulnerabilities (#4012)
- Bump release-drafter/release-drafter from 6 to 7 (#4019)
- Bump rojopolis/spellcheck-github-actions from 0.58.0 to 0.60.0 (#4018)
- Reorganize unit tests grouping - extracting the tests that define their hardcoded client configuration separately (#4029)
- Update home_json.py - this will make the docs examples interactive (#4020)
- Fix Sync ClusterPubSub.disconnect() β Potential AttributeError (#4036)
- Refactor ClusterPubSub to reuse NodesManager-managed connections. (#4037)
- Fix CROSSSLOT on sharded pubsub resubscription by grouping channels per slot (#4038)
- fix(cluster): enable health check in ClusterNode command execution (#4043)
- Add Python version '3.14t' to CI matrix (#4058)
- docs: fix typos in messages, docstrings, and comments (#4062)
- Updating hash commands type hints and jsonget return type hints (#4054)
- Fix flaky tests (#4071)
- Add CLAUDE.md and /sync-claude-md skill for managing (#4066)
- Randomize cluster startup node order during topology refresh (#4060)
We'd like to thank all the contributors who worked on this release!
@hydroblaze @Br1an67 @mokashang @swoutch @armorbreak001 @Brumbelow @paoloredis @Pack-Yak1 @abersheeran @alisaifee @majiayu000 @uglide @dmaier-redislabs @vladvildanov @petyaslavova
8.0.0b2
Changes
Unified command response types across RESP2 and RESP3 protocols
In this release, the command response types across RESP2 and RESP3 protocols are unified, ensuring that the same command returns the same Python type and structure regardless of which protocol version is in use β eliminating the need for protocol-specific branching in application code (#4025). Approximately 84 commands are affected across core Redis, Search, JSON, TimeSeries, and Probabilistic modules. Additionally, the default protocol has been changed from RESP2 to RESP3 for all Redis clients and connections, enabling richer native types (maps, sets, doubles, booleans) and improved performance out of the box (#4031).
These changes are breaking relative to redis-py 7.x and earlier, so users upgrading should carefully review the migration guide. For a complete list of affected commands and updated response formats, see docs/resp_unification.rst and the detailed migration guide at specs/resp2_resp3_migration_guide.md.
Users who need to retain the previous default protocol configuration can explicitly set protocol=2 when creating their client or connection.
π New Features
- Add random load balancing strategy which allows for use of the primary (#4027)
π₯ Breaking changes
- RESP2 and RESP3 response unification (#4025)
- Changing the default RESP protocol configurations for Redis clients and connections to 3 (#4031)
π§° Maintenance
- Reorganize unit tests grouping - extracting the tests that define their hardcoded client configuration separately (#4029)
We'd like to thank all the contributors who worked on this release!
@Pack-Yak1 @petyaslavova
8.0.0b1
Changes
Async Cluster PubSub & Keyspace Notifications
This release introduces full asyncio Cluster PubSub support, bringing shard-channel capabilities (SSUBSCRIBE, SUNSUBSCRIBE, SPUBLISH) to the async RedisCluster client. The new ClusterPubSub class in redis.asyncio.cluster automatically routes shard-channel subscriptions to the correct cluster node based on key-slot hashing, manages per-node PubSub connections, and supports round-robin message retrieval across nodes. Users can create a cluster pubsub instance via RedisCluster.pubsub() and use ssubscribe(), sunsubscribe(), and get_sharded_message() just as they would with the sync cluster client.
Alongside this, Redis Keyspace Notifications are now supported for both standalone and cluster deployments, in both sync and async modes. New classesβKeyspaceNotifications, ClusterKeyspaceNotifications, AsyncKeyspaceNotifications, and AsyncClusterKeyspaceNotificationsβprovide a high-level API for subscribing to keyspace and keyevent channels. In cluster mode, notifications are automatically subscribed across all primary nodes (since each node only emits notifications for keys it owns), with built-in topology-change handling. Convenience methods like subscribe_keyspace(), subscribe_keyevent(), and channel classes (KeyspaceChannel, KeyeventChannel) simplify common subscription patterns. Both sync run_in_thread() and async listen() workflows are supported.
Type Hints Improvements (breaking changes)
The @overload pattern has been applied systematically across core commands (core.py), VectorSet commands, and module commands (Search, JSON, TimeSeries, Bloom filters) to provide distinct return types for sync and async clients. Previously, methods returned a combined ResponseT (i.e., Union[Awaitable[Any], Any]), which caused static analysis tools like mypy and Pyright to flag false positives. Now, sync clients see concrete return types (e.g., int, bool, list[str]) while async clients see Awaitable[...] wrappers. This is a breaking change for type-checking onlyβruntime behavior is unchanged, but code relying on the old union return types in type annotations may need updates. Two new protocol types, SyncClientProtocol and AsyncClientProtocol, are used in overload signatures to enable this distinction.
π New Features
- Support Cluster PubSub in asyncio (#3736)
- Add Redis Keyspace Notifications Support for Redis Cluster (#3962)
π₯ Breaking changes
- Type hints improvements - fixing static code analyses issues related to combined sync and async return types(vectorsets + commands in core.py) (#3991)
- Type hints improvements - fixing static code analyses issues related to combined sync and async return types - modules (#4005)
- Add Redis Keyspace Notifications Support for Redis Cluster (#3962)
π Bug Fixes
- fix: guard disconnect() against RuntimeError on Python 3.13+ (#3856) (#4013)
- Fix CacheProxyConnection hang when invalidation arrives on another connection (#3600) (#4014)
- fix: handle scientific notation in score_cast_func for RESP2 (#4016)
- Fix TypeError in CacheProxyConnection when cached response is non-bytes (#4017)
β οΈ Deprecations
- Align deprecation of lib_name/lib_version in async cluster (#3995)
π§° Maintenance
- Adding unstable 8.8 build to pipeline test matrix. Updating the lib version in master. (#4004)
- Fix type hints for register_script to support RedisCluster (#3876)
- Updating dependencies to fix reported vulnerabilities (#4012)
- Bump release-drafter/release-drafter from 6 to 7 (#4019)
- Bump rojopolis/spellcheck-github-actions from 0.58.0 to 0.60.0 (#4018)
We'd like to thank all the contributors who worked on this release!
@abersheeran @alisaifee @majiayu000 @dmaier-redislabs @vladvildanov @petyaslavova
7.4.0
Changes
π Bug Fixes
- Fix AttributeError in cluster metrics recording when connection is None or ClusterNode object instance is used to extract the connection info (#3999)
- Fixing security concern in repr methods for ConnectionPools - passwords might leak in plain text logs (#3998)
- Refactored connection count and SCH metric collection (#4001)
π§ͺ Experimental Features
- Refactored health check logic for MultiDBClient (#3994)
π§° Maintenance
- Expose basic Otel classes and functions to be importable through redis.observability to match the examples in the readthedocs (#3996)
We'd like to thank all the contributors who worked on this release!
@vladvildanov @petyaslavova
7.3.0
Changes
OpenTelemetry Native Metrics Support for asynchronous clients
Added comprehensive OpenTelemetry metrics support for asynchronous clients following the OpenTelemetry Database Client Semantic Conventions.
Metric groups include:
- Command metrics: Operation duration with retry tracking
- Connection basic: Connection count and creation time
- Resiliency: Errors, handoffs, timeout relaxation
- Connection advanced: Wait time and use time
- Pubsub metrics: Published and received messages
- Stream metrics: Processing duration and maintenance notifications
π New Features
- Added OTel instrumentation and metrics export for async client (#3977)
π Bug Fixes
- [async] Adding access to cluster client's nodes_manager and set_response_callback in ClusterPipeline objects (#3989)
- fix(connection): Ensure we have an initialized protocol in connection (#3981)
π§° Maintenance
- fix: use KeysT for blpop and brpop keys parameter type annotation (#3987 #3990)
- Bump actions/upload-artifact from 6 to 7 (#3985)
- fix: replace 3 bare except clauses with except Exception (#3980)
We'd like to thank all the contributors who worked on this release!
@mitre88 @turanalmammadov @haosenwang1018 @Medno @vladvildanov @petyaslavova