Changes

🚀 New Features

• Add support for CLUSTER MYID (#2063)
• Add dialect support for RediSearch queries (#2071)

🧰 Maintenance

• Fix black (#2075)
• Make typing_extensions conditional to Python < 3.8 (#2062)

Contributors

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

@dvora-h, @enjoy-binbin and @mgorny

Changes

4.2.0-rc1 release notes 4.2.0-rc2 release notes 4.2.0-rc3 release notes

🚀 New Features

• Support for Vector Fields for Vector Similarity Search (#2041)

🐛 Bug Fixes

• Fix cluster scan command cursors & scan_iter (#2054)

🧰 Maintenance

• Remove verbose logging from cluster initializers (#2055)
• Mark tests for redis-stack (#2052)

Contributors

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

@Avital-Fine, @dvora-h, @joni- and @utkarshgupta137

Changes

🚀 New Features

• Add support for SORT_RO available in redis 7(#1858)
• Added support for redisearch module commands in cluster (#2042)
• Add support for PEXPIREAT command options available in redis 7 (#2027)
• Add support for PEXPIRE command option available in redis 7 (#2026)
• Add support for EXPIREAT command options available in redis 7 (#2024)
• Add support for EXPIRE command's options available in redis 7 (#2002)
• SSL connections can now load certificates from strings instead of just files (#2048)
• Add support for CLUSTER LINKS available in redis 7 (#2019)
• Add support for CLUSTER DELSLOTSRANGE available in redis 7 (#2018)
• Add support for CLUSTER ADDSLOTSRANGE available in redis 7 (#2017)

🐛 Bug Fixes

• Fix TypeError in graph commands (#2050)
• Async - ensure redis_connect_func is set on uds connection (#2046)

🧰 Maintenance

• Fix: avoiding issue with PytestUnraisableExceptionWarning (#1458)
• Documentation typos (#2045, #2043)

Contributors

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

@advance512, @dogukanteber, @dvora-h, @fuho, @lazToum and @razzeee

Changes

🚀 New Features

• Add pipeline support for Search (#2038)
• Add support for PEXPIRETIME (#1861)
• Add support for EXPIRETIME (#1860)
• Implemented COMMAND DOCS by always throwing NotImplementedError (#2020)
• Add cluster support for functions (#2016)
• Add support for HSET items (#2006)
• Add support for JSON, TIMESERIES, BLOOM & GRAPH commands in cluster (#2032)
• Add support for AUTH (#1929)
• Implement locks for RedisCluster (#2013)

🧰 Maintenance

• Add async typing support to commands' returns (#2010)
• Fix asyncio retry.py typing (#2011)
• Fix typo in comment (#2025)
• Fixing TimesSeries tests (#2029)
• Add AsyncFunctionCommands (#2009)
• Renaming chore as maintenance (#2015)
• Add Python 3.6 back to hash verify CI (#2008)
• Add redismod cluster docker (#2022)

Contributors

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

@Andrew-Chen-Wang, @OfirMos, @chayim, @dogukanteber, @dvora-h, @jakebarnwell, @mdczaplicki and @spagh-eddie

Changes

🔥 Breaking Changes

• Functions within RedisGraph support, were renamed to match Python naming conventions. (#1872)
• Modified rootPath argument in JSON.SET to root_path as part of type hint addition. (#1921)

🚀 New Features

• Added ASYNC support, merging with aioredis (#1899)
• Add cluster support for scripting (#1937)
• Add support for Redis 7 functions (#1998)
• Add support for ACL DRYRUN (#1992)
• Add support for BZMPOP (#1851)
• Add support for CLIENT NO-EVICT (#1856)
• Add support for ZINTERCARD (#1857)
• Add support for EVAL_RO (#1862)
• Add support for EVAL_RO (#1863)
• Add support for SINTERCARD (#1859)
• Add support for LMPOP (#1843)
• Add support for BLMPOP (#1849)
• Add support for ZMPOP (#1923)
• Add support for LCS (#1924)
• Implemented AUTH by always throwing NotImplementedError (#1910)
• Implemented FAILOVER by always throwing NotImplementedError (#1911)
• Implemented HELLO by always throwing NotImplementedError (#1912)

🐛 Bug Fixes

• Catch OSError in BlockingConnectionPool.get_connection (#2001)
• Fixing Elevated CPU utilization on one node when using RedisCluster pipeline (#1985)

🧰 Maintenance

• Fixing type annotation for EXPLAIN (#1997)
• Add type hints for list commands (#1917)
• Add type hints for set commands (#1918)
• Add type hints for hash commands (#1919)
• Add type hints for JSON commands (#1921)
• Add set and get examples (#1916)
• Docs: fix the wrong link to watch command (#1984)
• Fix typo in readme (#1936)

Contributors

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

@Andrew-Chen-Wang, @chayim, @dogukanteber, @dvora-h, @elemoine, @jakebarnwell, @shchurov, @ashtul, @Pagliacii, @joseotoro and @srittau

Changes

🚀 New Features

• Adding ExecutionPlan support for graph (#1993)
• Vector similiary search support (#1986)

🐛 Bug Fixes

• Fix flushdb and flushall (#1926)

🧰 Maintenance

• Add redis5 and redis4 dockers (#1871)
• Change json.clear test multi to be up to date with redisjson (#1922)
• Fixing volume for unstable_cluster docker (#1914)
• Update changes file with changes since 4.0.0-beta2 (#1915)

Contributors

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

@MeirShpilraien, @dvora-h

Changes

🚀 New Features

• Invalid OCSP certificates should raise ConnectionError on failed validation (#1907)
• Added retry mechanism on socket timeouts when connecting to the server (#1895)

🐛 Bug Fixes

• LMOVE, BLMOVE return incorrect responses (#1906)
• Fixing AttributeError in UnixDomainSocketConnection (#1903)
• Fixing TypeError in GraphCommands.explain (#1901)

🧰 Maintenance

• For tests, increasing wait time for the cluster (#1908)
• Increased pubsub's wait_for_messages timeout to prevent flaky tests (#1893)
• README code snippets formatted to highlight properly (#1888)
• Fix link in the main page (#1897)
• Documentation fixes: JSON Example, SSL Connection Examples, RTD version (#1887)
• Direct link to readthedocs (#1885)

Contributors

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

@barshaul, @chayim, @dvora-h, @soumendrak and @varunchopra

Changes

🚀 New Features

• Add retries to connections in Sentinel Pools (#1879)
• OCSP Stapling Support (#1873)
• Define incr/decr as aliases of incrby/decrby (#1874)
• FT.CREATE - support MAXTEXTFIELDS, TEMPORARY, NOHL, NOFREQS, SKIPINITIALSCAN (#1847)

🐛 Bug Fixes

• Timeseries docs fix (#1877)
• get_connection: catch OSError too (#1832)
• Set keys var otherwise variable not created (#1853)
• Clusters should optionally require full slot coverage (#1845)

🧰 Maintenance

• Triple quote docstrings in client.py PEP 257 (#1876)
• syncing requirements (#1870)
• Typo and typing in GraphCommands documentation (#1855)
• Allowing poetry and redis-py to install together (#1854)
• setup.py: Add project_urls for PyPI (#1867)
• Support test with redis unstable docker (#1850)
• Connection examples (#1835)
• Documentation cleanup (#1841)

Contributors

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

@Andrew-Chen-Wang, @AvitalFineRedis, @Enchufa2, @barshaul, @chayim, @dvora-h, @jdieter, @salty-horse, @sbv-csis and @tony

Changes

4.1.0-rc2 release notes 4.1.0-rc1 release notes

🚀 New Features

• OCSP stapling support (#1820)
• Support for SELECT (#1825)
• Support for specifying error types with retry (#1817)
• Support for RESET command since Redis 6.2.0 (#1824)
• Support CLIENT TRACKING (#1612)
• Support WRITE in CLIENT PAUSE (#1549)
• JSON set_file and set_path support (#1818)
• Allow ssl_ca_path with rediss:// urls (#1814)
• Support for password-encrypted SSL private keys (#1782)
• Support SYNC and PSYNC (#1741)

🐛 Bug Fixes

• Retry on error exception and timeout fixes (#1821)
• Fixing read race condition during pubsub (#1737)
• Fixing exception in listen (#1823)
• Fixed MovedError, and stopped iterating through startup nodes when slots are fully covered (#1819)
• Socket not closing after server disconnect (#1797)
• Single sourcing the package version (#1791)
• Ensure redis_connect_func is set on uds connection (#1794)

🧰 Maintenance

• SRTALGO - Skip for redis versions greater than 7.0.0 (#1831)
• Documentation updates (#1822)
• Add CI action to install package from repository commit hash (#1781) (#1790)
• Fix link in lmove docstring (#1793)
• Disabling JSON.DEBUG tests (#1787)

Contributors

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

@Akuli, @AvitalFineRedis, @alisaifee, @ashwani99, @barshaul, @chayim, @dvora-h, @pawl and @yanivhershkovich

Changes

🔥 Breaking Changes (from 4.1.0 rc1)

• Migrated targeted nodes to kwargs in Cluster Mode (#1762)

🚀 New Features

• Added support for MONITOR in clusters (#1756)
• Adding ROLE Command (#1610)
• Integrate RedisBloom support (#1683)
• Adding RedisGraph support (#1556)
• Allow overriding connection class via keyword arguments (#1752)
• Aggregation LOAD * support for RediSearch (#1735)

🧰 Maintenance

• Adding cluster, bloom, and graph docs (#1779)
• Add packaging to setup_requires, and use >= to play nice to setup.py (fixes #1625) (#1780)
• Fixing the license link in the readme (#1778)
• Removing distutils from tests (#1773)
• Fix cluster ACL tests (#1774)
• Improved RedisCluster's reinitialize_steps and documentation (#1765)
• Added black and isort (#1734)
• Link Documents for all module commands (#1711)
• Pyupgrade + flynt + f-strings (#1759)
• Remove unused aggregation subclasses in RediSearch (#1754)

Contributors

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

@AvitalFineRedis, @WisdomPill, @akx, @barshaul, @asheryerm, @chayim, @hartwork and @m-novikov

Changes

🚀 New Features

• Adding RedisCluster client to support Redis Cluster Mode (#1660)
• Support RediSearch FT.PROFILE command (#1727)
• Adding support for non-decodable commands (#1731)
• COMMAND GETKEYS support (#1738)
• RedisJSON 2.0.4 behaviour support (#1747)

🐛 Bug Fixes

• Removing deprecating distutils (PEP 632) (#1730)

🧰 Maintenance

• Updating PR template (#1745)
• Removing duplication of Script class (#1751)
• Splitting documentation for read the docs (#1743)
• Improve code coverage for aggregation tests (#1713)
• Fixing COMMAND GETKEYS tests (#1750)
• GitHub release improvements (#1684)
• 4.1.0rc1 (#1742)

Contributors

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

@AvitalFineRedis, @barshaul and @chayim

Changes

🐛 Bug Fixes

• Restoring Sentinel commands to redis client (#1723)
• Better removal of hiredis warning (#1726)

🧰 Maintenance

• Adding links to redis documents in function calls (#1719)

Contributors

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

@Carlosbogo, @sculley and @wuisawesome

🐛 Bug Fixes

• Removing command on initial connections (#1722)
• Removing hiredis warning when not installed (#1721)

Contributors

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

@chayim

Changes Since 3.5.3

4.0.0-rc2 release notes 4.0.0-rc1 release notes 4.0.0-beta3 release notes 4.0.0-beta2 release notes 4.0.0-beta1 ​release notes

🚀 New Features

• FT.EXPLAINCLI intentionally raising NotImplementedError (#1705)

🐛 Bug Fixes

• Restoring ZRANGE desc for Redis < 6.2.0 (#1697)
• Response parsing occasionally fails to parse floats (#1692)
• Re-enabling read-the-docs (#1707)

🧰 Maintenance

• Call HSET after FT.CREATE to avoid keyspace scan (#1706)
• Unit tests fixes for compatibility (#1703)
• Improve documentation about Locks (#1701)
• Fixes to allow --redis-url to pass through all tests (#1700)
• Fix unit tests running against Redis 4.0.0 (#1699)
• Search alias test fix (#1695)
• Adding RediSearch/RedisJSON tests (#1691)
• Updating codecov rules (#1689)
• Tests to validate custom JSON decoders (#1681)
• Added breaking icon to release drafter (#1702)

Contributors

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

@AvitalFineRedis, @ashtul, @chayim and @jerr0328

🐛 Bug Fixes

• Removing dependency on six (#1676)
• Re-enable pipeline support for JSON and TimeSeries (#1674)
• Export Sentinel, and SSL like other classes (#1671)
• Restore zrange functionality for older versions of Redis (#1670)
• Fixed garbage collection deadlock (#1578)

🧰 Maintenance

• Tests to validate built python packages (#1678)
• Sleep for flaky search test (#1680)
• Test function renames, to match standards (#1679)
• Docstring improvements for Redis class (#1675)
• Fix georadius tests (#1672)

Contributors

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

@AvitalFineRedis, @chayim, @emorozov and @terencehonles

Breaking Changes

• Improvements to JSON coverage (#1666) Impact: JSON commands available since 4.0.0beta3 now better match RedisJSON
• Add python_requires setuptools check for python > 3.6 (#1656)

🚀 New Features

• SMISMEMBER support (#1667)
• Exposing the module version in loaded_modules (#1648)
• RedisTimeSeries support (#1652)
• Support for json multipath ($) (#1663)

🐛 Bug Fixes

• Added boolean parsing to PEXPIRE and PEXPIREAT (#1665)
• Add python_requires setuptools check for python > 3.6 (#1656)

🧰 Maintenance

• Adding vulture for static analysis (#1655)
• Starting to clean the docs (#1657)
• Update README.md (#1654)
• Adding description format for package (#1651)
• Publish to pypi as releases are generated with the release drafter (#1647)
• Restore actions to prs (#1653)

Contributors

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

@Nicusor97, @WisdomPill, @chayim and @gkorland

Changes

🐛 Bug Fixes

• Fixing the package to include commands (#1649)

🧰 Maintenance

• Re-enabling codecov as part of CI process (#1646)

Contributors

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

@chayim

Changes

🚀 New Features

• Adding support for redisearch (#1640) Thanks @chayim
• redisjson support (#1636) Thanks @chayim
• Sentinel: Add SentinelManagedSSLConnection (#1419) Thanks @AbdealiJK
• Enable floating parameters in SET (ex and px) (#1635) Thanks @AvitalFineRedis
• Add warning when hiredis not installed. Recommend installation. (#1621) Thanks @adiamzn
• Raising NotImplementedError for SCRIPT DEBUG and DEBUG SEGFAULT (#1624) Thanks @chayim
• CLIENT REDIR command support (#1623) Thanks @chayim
• REPLICAOF command implementation (#1622) Thanks @chayim
• Add support to NX XX and CH to GEOADD (#1605) Thanks @AvitalFineRedis
• Add support to ZRANGE and ZRANGESTORE parameters (#1603) Thanks @AvitalFineRedis

🐛 Bug Fixes

• Pre 6.2 redis should default to None for script flush (#1641) Thanks @chayim
• Add FULL option to XINFO SUMMARY (#1638) Thanks @agusdmb
• Geosearch test should use any=True (#1594) Thanks @Andrew-Chen-Wang
• Removing packaging dependency (#1626) Thanks @chayim
• Fix client_kill_filter docs for skimpy (#1596) Thanks @Andrew-Chen-Wang
• Normalize minid and maxlen docs (#1593) Thanks @Andrew-Chen-Wang
• Update docs for multiple usernames for ACL DELUSER (#1595) Thanks @Andrew-Chen-Wang
• Fix grammar of get param in set command (#1588) Thanks @Andrew-Chen-Wang
• Fix docs for client_kill_filter (#1584) Thanks @Andrew-Chen-Wang

🧰 Maintenance

• Convert README & CONTRIBUTING from rst to md (#1633) Thanks @davidylee
• Test BYLEX param in zrangestore (#1634) Thanks @AvitalFineRedis
• Tox integrations with invoke and docker (#1632) Thanks @chayim
• Adding the release drafter to help simplify release notes (#1618). Thanks @chayim

Backwards Incompatible Changes

• Removed support for end of life Python 2.7. #1318
• All values within Redis URLs are unquoted via urllib.parse.unquote. Prior versions of redis-py supported this by specifying the decode_components flag to the from_url functions. This is now done by default and cannot be disabled. #589
• Redis commands were moved into a mixin (see commands.py). Anyone importing redis.client to access commands directly should import redis.commands. #1534, #1550

CHANGES

• Removed technical debt on REDIS_6_VERSION placeholder. Thanks @chayim #1582.
• Various docus fixes. Thanks @Andrew-Chen-Wang #1585, #1586.
• Support for LOLWUT command, available since Redis 5.0.0. Thanks @brainix #1568.
• Added support for CLIENT REPLY, available in Redis 3.2.0. Thanks @chayim #1581.
• Support for Auto-reconnect PubSub on get_message. Thanks @luhn #1574.
• Fix RST syntax error in README/ Thanks @JanCBrammer #1451.
• IDLETIME and FREQ support for RESTORE. Thanks @chayim #1580.
• Supporting args with MODULE LOAD. Thanks @chayim #1579.
• Updating RedisLabs with Redis. Thanks @gkorland #1575.
• Added support for ASYNC to SCRIPT FLUSH available in Redis 6.2.0. Thanks @chayim. #1567
• Added CLIENT LIST fix to support multiple client ids available in Redis 2.8.12. Thanks @chayim #1563.
• Added DISCARD support for pipelines available in Redis 2.0.0. Thanks @chayim #1565.
• Added ACL DELUSER support for deleting lists of users available in Redis 6.2.0. Thanks @chayim. #1562
• Added CLIENT TRACKINFO support available in Redis 6.2.0. Thanks @chayim. #1560
• Added GEOSEARCH and GEOSEARCHSTORE support available in Redis 6.2.0. Thanks @AvitalFine Redis. #1526
• Added LPUSHX support for lists available in Redis 4.0.0. Thanks @chayim. #1559
• Added support for QUIT available in Redis 1.0.0. Thanks @chayim. #1558
• Added support for COMMAND COUNT available in Redis 2.8.13. Thanks @chayim. #1554.
• Added CREATECONSUMER support for XGROUP available in Redis 6.2.0. Thanks @AvitalFineRedis. #1553
• Including slowly complexity in INFO if available. Thanks @ian28223 #1489.
• Added support for STRALGO available in Redis 6.0.0. Thanks @AvitalFineRedis. #1528
• Addes support for ZMSCORE available in Redis 6.2.0. Thanks @2014BDuck and @jiekun.zhu. #1437
• Support MINID and LIMIT on XADD available in Redis 6.2.0. Thanks @AvitalFineRedis. #1548
• Added sentinel commands FLUSHCONFIG, CKQUORUM, FAILOVER, and RESET available in Redis 2.8.12. Thanks @otherpirate. #834
• Migrated Version instead of StrictVersion for Python 3.10. Thanks @tirkarthi. #1552
• Added retry mechanism with backoff. Thanks @nbraun-amazon. #1494
• Migrated commands to a mixin. Thanks @chayim. #1534
• Added support for ZUNION, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1522
• Added support for CLIENT LIST with ID, available in Redis 6.2.0. Thanks @chayim. #1505
• Added support for MINID and LIMIT with xtrim, available in Reds 6.2.0. Thanks @chayim. #1508
• Implemented LMOVE and BLMOVE commands, available in Redis 6.2.0. Thanks @chayim. #1504
• Added GET argument to SET command, available in Redis 6.2.0. Thanks @2014BDuck. #1412
• Documentation fixes. Thanks @enjoy-binbin @jonher937. #1496 #1532
• Added support for XAUTOCLAIM, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1529
• Added IDLE support for XPENDING, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1523
• Add a count parameter to lpop/rpop, available in Redis 6.2.0. Thanks @wavenator. #1487
• Added a (pypy) trove classifier for Python 3.9. Thanks @D3X. #1535
• Added ZINTER support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1520
• Added ZINTER support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1520
• Added ZDIFF and ZDIFFSTORE support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1518
• Added ZRANGESTORE support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1521
• Added LT and GT support for ZADD, available in Redis 6.2.0. Thanks @chayim. #1509
• Added ZRANDMEMBER support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1519
• Added GETDEL support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1514
• Added CLIENT KILL laddr filter, available in Redis 6.2.0. Thanks @chayim. #1506
• Added CLIENT UNPAUSE, available in Redis 6.2.0. Thanks @chayim. #1512
• Added NOMKSTREAM support for XADD, available in Redis 6.2.0. Thanks @chayim. #1507
• Added HRANDFIELD support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1513
• Added CLIENT INFO support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1517
• Added GETEX support, available in Redis 6.2.0. Thanks @AvitalFineRedis. #1515
• Added support for COPY command, available in Redis 6.2.0. Thanks @malinaa96. #1492
• Provide a development and testing environment via docker. Thanks @abrookins. #1365
• Added support for the LPOS command available in Redis 6.0.6. Thanks @aparcar #1353/#1354
• Added support for the ACL LOG command available in Redis 6. Thanks @2014BDuck. #1307
• Added support for ABSTTL option of the RESTORE command available in Redis 5.0. Thanks @charettes. #1423