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.
* Expanded support for connection strings specifying a username connecting
to pre-v6 servers.
* 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.
* 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.
* HSET command now can accept multiple pairs. HMSET has been marked as
deprecated now.
* Don't manually DISCARD when encountering an ExecAbortError.
* 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().
* Added the KEEPTTL option for the SET command.
* Added the MEMORY STATS command.
* 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.
* 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.
* 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.
* Removed support for end of life Python 3.4.
* Added support for all ACL commands in Redis 6.
* 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.
* 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.
* 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.
* Slightly optimized command packing.
* Added support for the TYPE argument to SCAN.
* 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.
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.
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.
* 3.3.8
* Fixed MONITOR parsing to properly parse IPv6 client addresses, unix
socket connections and commands issued from Lua.
* 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.
* 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.
* 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.
* 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
* 3.3.2
* Further fixed a regression introduced in 3.3.0 involving SSL and
non-blocking sockets.
* 3.3.1
* Fixed a regression introduced in 3.3.0 involving SSL and non-blocking
sockets.
* 3.3.0
* Resolve a race condition with the PubSubWorkerThread.
* Cleanup socket read error messages.
* Cleanup the Connection's selector correctly.
* Added a Monitor object to make working with MONITOR output easy.
* Internal cleanup: Removed the legacy Token class which was necessary
with older version of Python that are no longer supported.
* 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.
* 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.
* 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.
* Add READONLY and READWRITE commands.
* 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.
* 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.
* Fixed a bug in Pipeline error handling that would incorrectly retry
ConnectionErrors.
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.
* Attempt to guarentee 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.
* Use the socket.IPPROTO_TCP constant instead of socket.SOL_TCP.
IPPROTO_TCP is available on more interpreters (Jython for instance).
* Fixed a regression introduced in 3.0 that mishandles exceptions not
derived from the base Exception class. KeyboardInterrupt and
gevent.timeout notable.
* Significant improvements to handing connections with forked processes.
Parent and child processes no longer trample on each others' connections.
* PythonParser no longer closes the associated connection's socket. The
connection itself will close the socket.
3.1.0:
* Connection URLs must have one of the following schemes:
redis://, rediss://, unix://.
* Fixed an issue with retry_on_timeout logic that caused some TimeoutErrors
to be retried.
* Added support for SNI for SSL.
* Fixed ConnectionPool repr for pools with no connections.
* Fixed GEOHASH to return a None value when specifying a place that
doesn't exist on the server.
* Fixed XREADGROUP to return an empty dictionary for messages that
have been deleted but still exist in the unacknowledged queue.
* Added an owned method to Lock objects. owned returns a boolean
indicating whether the current lock instance still owns the lock.
* 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.
* Added a reacquire method to Lock objects. reaquire attempts to renew
the lock such that the timeout is extended to the same value that the
lock was initially acquired with.
* 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 ount 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.
* Added client_kill_filter that accepts various filters to identify
and kill clients.
* Fixed a race condition that occurred when unsubscribing and
resubscribing to the same channel or pattern in rapid succession.
* 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.
* Fixed a bug in GEORADIUS that forced decoding of places without
respecting the decode_responses option.
* 3.0.1
* Fixed regression with UnixDomainSocketConnection caused by 3.0.0.
* Fixed an issue with the new asynchronous flag on flushdb and flushall.
* 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.
* 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 forseeable 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.
* Removed support for EOL Python 2.6 and 3.3.
OTHER CHANGES
* Added missing DECRBY command.
* CLUSTER INFO and CLUSTER NODES respones 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.
* Added support for the 'asynchronous' argument to FLUSHDB and FLUSHALL
commands.
* Added support for the BITFIELD command.
* Improved performance on pipeline requests with large chunks of data.
* Fixed test suite to not fail if another client is connected to the
server the tests are running against.
* Added support for SWAPDB.
* Added support for all STREAM commands.
* SHUTDOWN now accepts the 'save' and 'nosave' arguments.
* Added support for ZPOPMAX, ZPOPMIN, BZPOPMAX, BZPOPMIN.
* Added support for the 'type' argument in CLIENT LIST.
* Added support for CLIENT PAUSE.
* Added support for CLIENT ID and CLIENT UNBLOCK.
* GEODIST now returns a None value when referencing a place that does
not exist.
* Added a ping() method to pubsub objects.
* Fixed a bug with keys in the INFO dict that contained ':' symbols.
* 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.
* Fixed the select system call retry compatibility with Python 2.x.
* max_connections is now a valid querystring argument for creating
connection pools from URLs.
* Added the UNLINK command.
* Added socket_type option to Connection for configurability.
* Lock.do_acquire now atomically sets acquires the lock and sets the
expire value via set(nx=True, px=timeout).
* Added 'count' argument to SPOP.
* Fixed an issue parsing client_list respones that contained an '='.
* Various performance improvements. Thanks cjsimpson
* Fixed a bug with SRANDMEMBER where
* Added HSTRLEN command. Thanks Alexander Putilin
* Added the TOUCH command. Thanks Anis Jonischkeit
* Remove unnecessary calls to the server when registering Lua scripts.
Thanks Ben Greenberg
* SET's EX and PX arguments now allow values of zero. Thanks huangqiyin
* Added PUBSUB {CHANNELS, NUMPAT, NUMSUB} commands. Thanks Angus Pearson
* PubSub connections that that encounter `InterruptedError`s now
retry automatically. Thanks Carlton Gibson and Seth M. Larson
* LPUSH and RPUSH commands run on PyPy now correctly returns the number
of items of the list. Thanks Jeong YunWon
* Added support to automatically retry socket EINTR errors. Thanks
Thomas Steinacher
* PubSubWorker threads started with `run_in_thread` are now daemonized
so the thread shuts down when the running process goes away. Thanks
Keith Ainsworth
* Added support for GEO commands. Thanks Pau Freixes, Alex DeBrie and
Abraham Toriz
* Made client construction from URLs smarter. Thanks Tim Savage
* Added support for CLUSTER * commands. Thanks Andy Huang
* The RESTORE command now accepts an optional `replace` boolean.
Thanks Yoshinari Takaoka
* Attempt to connect to a new Sentinel if a TimeoutError occurs. Thanks
Bo Lopker
* Fixed a bug in the client's `__getitem__` where a KeyError would be
raised if the value returned by the server is an empty string.
Thanks Javier Candeira.
* Socket timeouts when connecting to a server are now properly raised
as TimeoutErrors.
renamed py-redis-py to py-redis
2.10.5
* Allow URL encoded parameters in Redis URLs. Characters like a "/" can
now be URL encoded and redis-py will correctly decode them.
* Added support for the WAIT command.
* Better shutdown support for the PubSub Worker Thread. It now properly
cleans up the connection, unsubscribes from any channels and patterns
previously subscribed to and consumes any waiting messages on the socket.
* Added the ability to sleep for a brief period in the event of a
WatchError occuring.
* Fixed a bug with pipeline error reporting when dealing with characters
in error messages that could not be encoded to the connection's
character set.
* Fixed a bug in Sentinel connections that would inadvertantly connect
to the master when the connection pool resets.
* Better timeout support in Pubsub get_message.
* Fixed a bug with the HiredisParser that would cause the parser to
get stuck in an endless loop if a specific number of bytes were
delivered from the socket. This fix also increases performance of
parsing large responses from the Redis server.
* Added support for ZREVRANGEBYLEX.
* ConnectionErrors are now raised if Redis refuses a connection due to
the maxclients limit being exceeded.
* max_connections can now be set when instantiating client instances.
