Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update redis to 5.2.1 #854

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented Dec 6, 2024

This PR updates redis from 2.10.6 to 5.2.1.

Changelog

4.1.3

* Fix flushdb and flushall (1926)
* 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)

4.1.2

* Invalid OCSP certificates should raise ConnectionError on failed validation (1907)
* Added retry mechanism on socket timeouts when connecting to the server (1895)
* LMOVE, BLMOVE return incorrect responses (1906)
* Fixing AttributeError in UnixDomainSocketConnection (1903)
* Fixing TypeError in GraphCommands.explain (1901)
* 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)

4.1.1

* 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)
* 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)
* 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)

4.1.0

* 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)
* 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)
* 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)
* Migrated targeted nodes to kwargs in Cluster Mode (1762)
* 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)
* 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)
* 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)
* Removing deprecating distutils (PEP 632) (1730)
* 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.0.2

* Restoring Sentinel commands to redis client (1723)
* Better removal of hiredis warning (1726)
* Adding links to redis documents in function calls (1719)

4.0.1

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

4.0.0

* FT.EXPLAINCLI intentionally raising NotImplementedError
* Restoring ZRANGE desc for Redis < 6.2.0 (1697)
* Response parsing occasionally fails to parse floats (1692)
* Re-enabling read-the-docs (1707)
* 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)
* 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)
* 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)
* Improvements to JSON coverage (1666)
* Add python_requires setuptools check for python > 3.6 (1656)
* SMISMEMBER support (1667)
* Exposing the module version in loaded_modules (1648)
* RedisTimeSeries support (1652)
* Support for json multipath ($) (1663)
* Added boolean parsing to PEXPIRE and PEXPIREAT (1665)
* Add python_requires setuptools check for python > 3.6 (1656)
* 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)
* Fixing the package to include commands (1649)
* Re-enabling codecov as part of CI process (1646)
* 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
* 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
* 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: Removed support for end of life Python 2.7. 1318
* BACKWARDS INCOMPATIBLE: 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
* POTENTIALLY INCOMPATIBLE: Redis commands were moved into a mixin
   (see commands.py). Anyone importing ``redis.client`` to access commands
   directly should import ``redis.commands``. 1534, 1550
* 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

3.5.3

* Restore try/except clauses to __del__ methods. These will be removed
   in 4.0 when more explicit resource management if enforced. 1339
* Update the master_address when Sentinels promote a new master. 847
* Update SentinelConnectionPool to not forcefully disconnect other in-use
   connections which can negatively affect threaded applications. 1345

3.5.2

* Tune the locking in ConnectionPool.get_connection so that the lock is
   not held while waiting for the socket to establish and validate the
   TCP connection.

3.5.1

* Fix for HSET argument validation to allow any non-None key. Thanks
   AleksMat, 1337, 1341

3.5.0

* Removed exception trapping from __del__ methods. redis-py objects that
   hold various resources implement __del__ cleanup methods to release
   those resources when the object goes out of scope. This provides a
   fallback for when these objects aren't explicitly closed by user code.
   Prior to this change any errors encountered in closing these resources
   would be hidden from the user. Thanks jdufresne. 1281
* Expanded support for connection strings specifying a username connecting
   to pre-v6 servers. 1274
* Optimized Lock's blocking_timeout and sleep. If the lock cannot be
   acquired and the sleep value would cause the loop to sleep beyond
   blocking_timeout, fail immediately. Thanks clslgrnc. 1263
* Added support for passing Python memoryviews to Redis command args that
   expect strings or bytes. The memoryview instance is sent directly to
   the socket such that there are zero copies made of the underlying data
   during command packing. Thanks Cody-G. 1265, 1285
* HSET command now can accept multiple pairs. HMSET has been marked as
   deprecated now. Thanks to laixintao 1271
* Don't manually DISCARD when encountering an ExecAbortError.
   Thanks nickgaya, 1300/1301
* Reset the watched state of pipelines after calling exec. This saves
   a roundtrip to the server by not having to call UNWATCH within
   Pipeline.reset(). Thanks nickgaya, 1299/1302
* Added the KEEPTTL option for the SET command. Thanks
   laixintao 1304/1280
* Added the MEMORY STATS command. 1268
* Lock.extend() now has a new option, `replace_ttl`. When False (the
   default), Lock.extend() adds the `additional_time` to the lock's existing
   TTL. When replace_ttl=True, the lock's existing TTL is replaced with
   the value of `additional_time`.
* Add testing and support for PyPy.

3.4.1

* Move the username argument in the Redis and Connection classes to the
   end of the argument list. This helps those poor souls that specify all
   their connection options as non-keyword arguments. 1276
* Prior to ACL support, redis-py ignored the username component of
   Connection URLs. With ACL support, usernames are no longer ignored and
   are used to authenticate against an ACL rule. Some cloud vendors with
   managed Redis instances (like Heroku) provide connection URLs with a
   username component pre-ACL that is not intended to be used. Sending that
   username to Redis servers < 6.0.0 results in an error. Attempt to detect
   this condition and retry the AUTH command with only the password such
   that authentication continues to work for these users. 1274
* Removed the __eq__ hooks to Redis and ConnectionPool that were added
   in 3.4.0. This ended up being a bad idea as two separate connection
   pools be considered equal yet manage a completely separate set of
   connections.

3.4.0

* Allow empty pipelines to be executed if there are WATCHed keys.
   This is a convenient way to test if any of the watched keys changed
   without actually running any other commands. Thanks brianmaissy.
   1233, 1234
* Removed support for end of life Python 3.4.
* Added support for all ACL commands in Redis 6. Thanks IAmATeaPot418
   for helping.
* Pipeline instances now always evaluate to True. Prior to this change,
   pipeline instances relied on __len__ for boolean evaluation which
   meant that pipelines with no commands on the stack would be considered
   False. 994
* Client instances and Connection pools now support a 'client_name'
   argument. If supplied, all connections created will call CLIENT SETNAME
   as soon as the connection is opened. Thanks to Habbie for supplying
   the basis of this change. 802
* Added the 'ssl_check_hostname' argument to specify whether SSL
   connections should require the server hostname to match the hostname
   specified in the SSL cert. By default 'ssl_check_hostname' is False
   for backwards compatibility. 1196
* Slightly optimized command packing. Thanks Deneby67. 1255
* Added support for the TYPE argument to SCAN. Thanks netocp. 1220
* Better thread and fork safety in ConnectionPool and
   BlockingConnectionPool. Added better locking to synchronize critical
   sections rather than relying on CPython-specific implementation details
   relating to atomic operations. Adjusted how the pools identify and
   deal with a fork. Added a ChildDeadlockedError exception that is
   raised by child processes in the very unlikely chance that a deadlock
   is encountered. Thanks gmbnomis, mdellweg, yht804421715. 1270,
   1138, 1178, 906, 1262
* Added __eq__ hooks to the Redis and ConnectionPool classes.
   Thanks brainix. 1240

3.3.11

* Further fix for the SSLError -> TimeoutError mapping to work
   on obscure releases of Python 2.7.

3.3.10

* Fixed a potential error handling bug for the SSLError -> TimeoutError
   mapping introduced in 3.3.9. Thanks zbristow. 1224

3.3.9

* Mapped Python 2.7 SSLError to TimeoutError where appropriate. Timeouts
   should now consistently raise TimeoutErrors on Python 2.7 for both
   unsecured and secured connections. Thanks zbristow. 1222

3.3.8

* Fixed MONITOR parsing to properly parse IPv6 client addresses, unix
   socket connections and commands issued from Lua. Thanks kukey. 1201

3.3.7

* Fixed a regression introduced in 3.3.0 where socket.error exceptions
   (or subclasses) could potentially be raised instead of
   redis.exceptions.ConnectionError. 1202

3.3.6

* Fixed a regression in 3.3.5 that caused PubSub.get_message() to raise
   a socket.timeout exception when passing a timeout value. 1200

3.3.5

* Fix an issue where socket.timeout errors could be handled by the wrong
   exception handler in Python 2.7.

3.3.4

* More specifically identify nonblocking read errors for both SSL and
   non-SSL connections. 3.3.1, 3.3.2 and 3.3.3 on Python 2.7 could
   potentially mask a ConnectionError. 1197

3.3.3

* The SSL module in Python < 2.7.9 handles non-blocking sockets
   differently than 2.7.9+. This patch accommodates older versions. 1197

3.3.2

* Further fixed a regression introduced in 3.3.0 involving SSL and
   non-blocking sockets. 1197

3.3.1

* Fixed a regression introduced in 3.3.0 involving SSL and non-blocking
   sockets. 1197

3.3.0

* Resolve a race condition with the PubSubWorkerThread. 1150
* Cleanup socket read error messages. Thanks Vic Yu. 1159
* Cleanup the Connection's selector correctly. Thanks Bruce Merry. 1153
* Added a Monitor object to make working with MONITOR output easy.
   Thanks Roey Prat 1033
* Internal cleanup: Removed the legacy Token class which was necessary
   with older version of Python that are no longer supported. 1066
* Response callbacks are now case insensitive. This allows users that
   call Redis.execute_command() directly to pass lower-case command
   names and still get reasonable responses. 1168
* Added support for hiredis-py 1.0.0 encoding error support. This should
   make the PythonParser and the HiredisParser behave identically
   when encountering encoding errors. Thanks Brian Candler. 1161/1162
* All authentication errors now properly raise AuthenticationError.
   AuthenticationError is now a subclass of ConnectionError, which will
   cause the connection to be disconnected and cleaned up appropriately.
   923
* Add READONLY and READWRITE commands. Thanks theodesp. 1114
* Remove selectors in favor of nonblocking sockets. Selectors had
   issues in some environments including eventlet and gevent. This should
   resolve those issues with no other side effects.
* Fixed an issue with XCLAIM and previously claimed but not removed
   messages. Thanks thomdask. 1192/1191
* Allow for single connection client instances. These instances
   are not thread safe but offer other benefits including a subtle
   performance increase.
* Added extensive health checks that keep the connections lively.
   Passing the "health_check_interval=N" option to the Redis client class
   or to a ConnectionPool ensures that a round trip PING/PONG is successful
   before any command if the underlying connection has been idle for more
   than N seconds. ConnectionErrors and TimeoutErrors are automatically
   retried once for health checks.
* Changed the PubSubWorkerThread to use a threading.Event object rather
   than a boolean to control the thread's life cycle. Thanks Timothy
   Rule. 1194/1195.
* Fixed a bug in Pipeline error handling that would incorrectly retry
   ConnectionErrors.

3.2.1

* Fix SentinelConnectionPool to work in multiprocess/forked environments.

3.2.0

* Added support for `select.poll` to test whether data can be read
   on a socket. This should allow for significantly more connections to
   be used with pubsub. Fixes 486/1115
* Attempt to guarantee that the ConnectionPool hands out healthy
   connections. Healthy connections are those that have an established
   socket connection to the Redis server, are ready to accept a command
   and have no data available to read. Fixes 1127/886
* Use the socket.IPPROTO_TCP constant instead of socket.SOL_TCP.
   IPPROTO_TCP is available on more interpreters (Jython for instance).
   Thanks Junnplus. 1130
* Fixed a regression introduced in 3.0 that mishandles exceptions not
   derived from the base Exception class. KeyboardInterrupt and
   gevent.timeout notable. Thanks Christian Fersch. 1128/1129
* Significant improvements to handing connections with forked processes.
   Parent and child processes no longer trample on each others' connections.
   Thanks to Jay Rolette for the patch and highlighting this issue.
   504/732/784/863
* PythonParser no longer closes the associated connection's socket. The
   connection itself will close the socket. 1108/1085

3.1.0

* Connection URLs must have one of the following schemes:
   redis://, rediss://, unix://. Thanks jdupl123. 961/969
* Fixed an issue with retry_on_timeout logic that caused some TimeoutErrors
   to be retried. Thanks Aaron Yang. 1022/1023
* Added support for SNI for SSL. Thanks oridistor and Roey Prat. 1087
* Fixed ConnectionPool repr for pools with no connections. Thanks
   Cody Scott. 1043/995
* Fixed GEOHASH to return a None value when specifying a place that
   doesn't exist on the server. Thanks guybe7. 1126
* Fixed XREADGROUP to return an empty dictionary for messages that
   have been deleted but still exist in the unacknowledged queue. Thanks
   xeizmendi. 1116
* Added an owned method to Lock objects. owned returns a boolean
   indicating whether the current lock instance still owns the lock.
   Thanks Dave Johansen. 1112
* Allow lock.acquire() to accept an optional token argument. If
   provided, the token argument is used as the unique value used to claim
   the lock. Thankd Dave Johansen. 1112
* Added a reacquire method to Lock objects. reacquire attempts to renew
   the lock such that the timeout is extended to the same value that the
   lock was initially acquired with. Thanks Ihor Kalnytskyi. 1014
* Stream names found within XREAD and XREADGROUP responses now properly
   respect the decode_responses flag.
* XPENDING_RANGE now requires the user the specify the min, max and
   count arguments. Newer versions of Redis prevent count from being
   infinite so it's left to the user to specify these values explicitly.
* ZADD now returns None when xx=True and incr=True and an element
   is specified that doesn't exist in the sorted set. This matches
   what the server returns in this case. 1084
* Added client_kill_filter that accepts various filters to identify
   and kill clients. Thanks Theofanis Despoudis. 1098
* Fixed a race condition that occurred when unsubscribing and
   resubscribing to the same channel or pattern in rapid succession.
   Thanks Marcin Raczyński. 764
* Added a LockNotOwnedError that is raised when trying to extend or
   release a lock that is no longer owned. This is a subclass of LockError
   so previous code should continue to work as expected. Thanks Joshua
   Harlow. 1095
* Fixed a bug in GEORADIUS that forced decoding of places without
   respecting the decode_responses option. Thanks Bo Bayles. 1082

3.0.1

* Fixed regression with UnixDomainSocketConnection caused by 3.0.0.
   Thanks Jyrki Muukkonen
* Fixed an issue with the new asynchronous flag on flushdb and flushall.
   Thanks rogeryen
* Updated Lock.locked() method to indicate whether *any* process has
   acquired the lock, not just the current one. This is in line with
   the behavior of threading.Lock. Thanks Alan Justino da Silva

3.0.0

BACKWARDS INCOMPATIBLE CHANGES
* When using a Lock as a context manager and the lock fails to be acquired
   a LockError is now raised. This prevents the code block inside the
   context manager from being executed if the lock could not be acquired.
* Renamed LuaLock to Lock.
* Removed the pipeline based Lock implementation in favor of the LuaLock
   implementation.
* Only bytes, strings and numbers (ints, longs and floats) are acceptable
   for keys and values. Previously redis-py attempted to cast other types
   to str() and store the result. This caused must confusion and frustration
   when passing boolean values (cast to 'True' and 'False') or None values
   (cast to 'None'). It is now the user's responsibility to cast all
   key names and values to bytes, strings or numbers before passing the
   value to redis-py.
* The StrictRedis class has been renamed to Redis. StrictRedis will
   continue to exist as an alias of Redis for the foreseeable future.
* The legacy Redis client class has been removed. It caused much confusion
   to users.
* ZINCRBY arguments 'value' and 'amount' have swapped order to match the
   the Redis server. The new argument order is: keyname, amount, value.
* MGET no longer raises an error if zero keys are passed in. Instead an
   empty list is returned.
* MSET and MSETNX now require all keys/values to be specified in a single
   dictionary argument named mapping. This was changed to allow for future
   options to these commands in the future.
* ZADD now requires all element names/scores be specified in a single
   dictionary argument named mapping. This was required to allow the NX,
   XX, CH and INCR options to be specified.
* ssl_cert_reqs now has a default value of 'required' by default. This
   should make connecting to a remote Redis server over SSL more secure.
   Thanks u2mejc
* Removed support for EOL Python 2.6 and 3.3. Thanks jdufresne
OTHER CHANGES
* Added missing DECRBY command. Thanks derek-dchu
* CLUSTER INFO and CLUSTER NODES responses are now properly decoded to
   strings.
* Added a 'locked()' method to Lock objects. This method returns True
   if the lock has been acquired and owned by the current process,
   otherwise False.
* EXISTS now supports multiple keys. It's return value is now the number
   of keys in the list that exist.
* Ensure all commands can accept key names as bytes. This fixes issues
   with BLPOP, BRPOP and SORT.
* All errors resulting from bad user input are raised as DataError
   exceptions. DataError is a subclass of RedisError so this should be
   transparent to anyone previously catching these.
* Added support for NX, XX, CH and INCR options to ZADD
* Added support for the MIGRATE command
* Added support for the MEMORY USAGE and MEMORY PURGE commands. Thanks
   Itamar Haber
* Added support for the 'asynchronous' argument to FLUSHDB and FLUSHALL
   commands. Thanks Itamar Haber
* Added support for the BITFIELD command. Thanks Charles Leifer and
   Itamar Haber
* Improved performance on pipeline requests with large chunks of data.
   Thanks tzickel
* Fixed test suite to not fail if another client is connected to the
   server the tests are running against.
* Added support for SWAPDB. Thanks Itamar Haber
* Added support for all STREAM commands. Thanks Roey Prat and Itamar Haber
* SHUTDOWN now accepts the 'save' and 'nosave' arguments. Thanks
   dwilliams-kenzan
* Added support for ZPOPMAX, ZPOPMIN, BZPOPMAX, BZPOPMIN. Thanks
   Itamar Haber
* Added support for the 'type' argument in CLIENT LIST. Thanks Roey Prat
* Added support for CLIENT PAUSE. Thanks Roey Prat
* Added support for CLIENT ID and CLIENT UNBLOCK. Thanks Itamar Haber
* GEODIST now returns a None value when referencing a place that does
   not exist. Thanks qingping209
* Added a ping() method to pubsub objects. Thanks krishan-carbon
* Fixed a bug with keys in the INFO dict that contained ':' symbols.
   Thanks mzalimeni
* Fixed the select system call retry compatibility with Python 2.x.
   Thanks lddubeau
* max_connections is now a valid querystring argument for creating
   connection pools from URLs. Thanks mmaslowskicc
* Added the UNLINK command. Thanks yozel
* Added socket_type option to Connection for configurability.
   Thanks garlicnation
* Lock.do_acquire now atomically sets acquires the lock and sets the
   expire value via set(nx=True, px=timeout). Thanks 23doors
* Added 'count' argument to SPOP. Thanks AlirezaSadeghi
* Fixed an issue parsing client_list responses that contained an '='.
   Thanks swilly22
Links

@pyup-bot pyup-bot mentioned this pull request Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant