forked from redis/redis-py
/
CHANGES
324 lines (324 loc) · 18.2 KB
/
CHANGES
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
* 2.9.2 (in development)
* The HiRedis parser will now properly raise ConnectionErrors.
* 2.9.1
* IPv6 support. Thanks https://github.com/amashinchi
* 2.9.0
* Performance improvement for packing commands when using the PythonParser.
Thanks Guillaume Viot.
* Executing an empty pipeline transaction no longer sends MULTI/EXEC to
the server. Thanks EliFinkelshteyn.
* Errors when authenticating (incorrect password) and selecting a database
now close the socket.
* Full Sentinel support thanks to Vitja Makarov. Thanks!
* Better repr support for client and connection pool instances. Thanks
Mark Roberts.
* Error messages that the server sends to the client are now included
in the client error message. Thanks Sangjin Lim.
* Added the SCAN, SSCAN, HSCAN, and ZSCAN commands. Thanks Jingchao Hu.
* ResponseErrors generated by pipeline execution provide addition context
including the position of the command in the pipeline and the actual
command text generated the error.
* ConnectionPools now play nicer in threaded environments that fork. Thanks
Christian Joergensen.
* 2.8.0
* redis-py should play better with gevent when a gevent Timeout is raised.
Thanks leifkb.
* Added SENTINEL command. Thanks Anna Janackova.
* Fixed a bug where pipelines could potentially corrupt a connection
if the MULTI command generated a ResponseError. Thanks EliFinkelshteyn
for the report.
* Connections now call socket.shutdown() prior to socket.close() to
ensure communication ends immediately per the note at
http://docs.python.org/2/library/socket.html#socket.socket.close
Thanks to David Martin for pointing this out.
* Lock checks are now based on floats rather than ints. Thanks
Vitja Makarov.
* 2.7.6
* Added CONFIG RESETSTAT command. Thanks Yossi Gottlieb.
* Fixed a bug introduced in 2.7.3 that caused issues with script objects
and pipelines. Thanks Carpentier Pierre-Francois.
* Converted redis-py's test suite to use the awesome py.test library.
* Fixed a bug introduced in 2.7.5 that prevented a ConnectionError from
being raised when the Redis server is LOADING data.
* Added a BusyLoadingError exception that's raised when the Redis server
is starting up and not accepting commands yet. BusyLoadingError
subclasses ConnectionError, which this state previously returned.
Thanks Yossi Gottlieb.
* 2.7.5
* DEL, HDEL and ZREM commands now return the numbers of keys deleted
instead of just True/False.
* from_url now supports URIs with a port number. Thanks Aaron Westendorf.
* 2.7.4
* Added missing INCRBY method. Thanks Krzysztof Dorosz.
* SET now accepts the EX, PX, NX and XX options from Redis 2.6.12. These
options will generate errors if these options are used when connected
to a Redis server < 2.6.12. Thanks George Yoshida.
* 2.7.3
* Fixed a bug with BRPOPLPUSH and lists with empty strings.
* All empty except: clauses have been replaced to only catch Exception
subclasses. This prevents a KeyboardInterrupt from triggering exception
handlers. Thanks Lucian Branescu Mihaila.
* All exceptions that are the result of redis server errors now share a
command Exception subclass, ServerError. Thanks Matt Robenolt.
* Prevent DISCARD from being called if MULTI wasn't also called. Thanks
Pete Aykroyd.
* SREM now returns an integer indicating the number of items removed from
the set. Thanks http://github.com/ronniekk.
* Fixed a bug with BGSAVE and BGREWRITEAOF response callbacks with Python3.
Thanks Nathan Wan.
* Added CLIENT GETNAME and CLIENT SETNAME commands.
Thanks http://github.com/bitterb.
* It's now possible to use len() on a pipeline instance to determine the
number of commands that will be executed. Thanks Jon Parise.
* Fixed a bug in INFO's parse routine with floating point numbers. Thanks
Ali Onur Uyar.
* Fixed a bug with BITCOUNT to allow `start` and `end` to both be zero.
Thanks Tim Bart.
* The transaction() method now accepts a boolean keyword argument,
value_from_callable. By default, or if False is passes, the transaction()
method will return the value of the pipelines execution. Otherwise, it
will return whatever func() returns.
* Python3 compatibility fix ensuring we're not already bytes(). Thanks
Salimane Adjao Moustapha.
* Added PSETEX. Thanks YAMAMOTO Takashi.
* Added a BlockingConnectionPool to limit the number of connections that
can be created. Thanks James Arthur.
* SORT now accepts a `groups` option that if specified, will return
tuples of n-length, where n is the number of keys specified in the GET
argument. This allows for convenient row-based iteration. Thanks
Ionuț Arțăriși.
* 2.7.2
* Parse errors are now *always* raised on multi/exec pipelines, regardless
of the `raise_on_error` flag. See
https://groups.google.com/forum/?hl=en&fromgroups=#!topic/redis-db/VUiEFT8U8U0
for more info.
* 2.7.1
* Packaged tests with source code
* 2.7.0
* Added BITOP and BITCOUNT commands. Thanks Mark Tozzi.
* Added the TIME command. Thanks Jason Knight.
* Added support for LUA scripting. Thanks to Angus Peart, Drew Smathers,
Issac Kelly, Louis-Philippe Perron, Sean Bleier, Jeffrey Kaditz, and
Dvir Volk for various patches and contributions to this feature.
* Changed the default error handling in pipelines. By default, the first
error in a pipeline will now be raised. A new parameter to the
pipeline's execute, `raise_on_error`, can be set to False to keep the
old behavior of embeedding the exception instances in the result.
* Fixed a bug with pipelines where parse errors won't corrupt the
socket.
* Added the optional `number` argument to SRANDMEMBER for use with
Redis 2.6+ servers.
* Added PEXPIRE/PEXPIREAT/PTTL commands. Thanks Luper Rouch.
* Added INCRBYFLOAT/HINCRBYFLOAT commands. Thanks Nikita Uvarov.
* High precision floating point values won't lose their precision when
being sent to the Redis server. Thanks Jason Oster and Oleg Pudeyev.
* Added CLIENT LIST/CLIENT KILL commands
* 2.6.2
* `from_url` is now available as a classmethod on client classes. Thanks
Jon Parise for the patch.
* Fixed several encoding errors resulting from the Python 3.x support.
* 2.6.1
* Python 3.x support! Big thanks to Alex Grönholm.
* Fixed a bug in the PythonParser's read_response that could hide an error
from the client (#251).
* 2.6.0
* Changed (p)subscribe and (p)unsubscribe to no longer return messages
indicating the channel was subscribed/unsubscribed to. These messages
are available in the listen() loop instead. This is to prevent the
following scenario:
* Client A is subscribed to "foo"
* Client B publishes message to "foo"
* Client A subscribes to channel "bar" at the same time.
Prior to this change, the subscribe() call would return the published
messages on "foo" rather than the subscription confirmation to "bar".
* Added support for GETRANGE, thanks Jean-Philippe Caruana
* A new setting "decode_responses" specifies whether return values from
Redis commands get decoded automatically using the client's charset
value. Thanks to Frankie Dintino for the patch.
* 2.4.13
* redis.from_url() can take an URL representing a Redis connection string
and return a client object. Thanks Kenneth Reitz for the patch.
* 2.4.12
* ConnectionPool is now fork-safe. Thanks Josiah Carson for the patch.
* 2.4.11
* AuthenticationError will now be correctly raised if an invalid password
is supplied.
* If Hiredis is unavailable, the HiredisParser will raise a RedisError
if selected manually.
* Made the INFO command more tolerant of Redis changes formatting. Fix
for #217.
* 2.4.10
* Buffer reads from socket in the PythonParser. Fix for a Windows-specific
bug (#205).
* Added the OBJECT and DEBUG OBJECT commands.
* Added __del__ methods for classes that hold on to resources that need to
be cleaned up. This should prevent resource leakage when these objects
leave scope due to misuse or unhandled exceptions. Thanks David Wolever
for the suggestion.
* Added the ECHO command for completeness.
* Fixed a bug where attempting to subscribe to a PubSub channel of a Redis
server that's down would blow out the stack. Fixes #179 and #195. Thanks
Ovidiu Predescu for the test case.
* StrictRedis's TTL command now returns a -1 when querying a key with no
expiration. The Redis class continues to return None.
* ZADD and SADD now return integer values indicating the number of items
added. Thanks Homer Strong.
* Renamed the base client class to StrictRedis, replacing ZADD and LREM in
favor of their official argument order. The Redis class is now a subclass
of StrictRedis, implementing the legacy redis-py implementations of ZADD
and LREM. Docs have been updated to suggesting the use of StrictRedis.
* SETEX in StrictRedis is now compliant with official Redis SETEX command.
the name, value, time implementation moved to "Redis" for backwards
compatability.
* 2.4.9
* Removed socket retry logic in Connection. This is the responsbility of
the caller to determine if the command is safe and can be retried. Thanks
David Wolver.
* Added some extra guards around various types of exceptions being raised
when sending or parsing data. Thanks David Wolver and Denis Bilenko.
* 2.4.8
* Imported with_statement from __future__ for Python 2.5 compatability.
* 2.4.7
* Fixed a bug where some connections were not getting released back to the
connection pool after pipeline execution.
* Pipelines can now be used as context managers. This is the preferred way
of use to ensure that connections get cleaned up properly. Thanks
David Wolever.
* Added a convenience method called transaction() on the base Redis class.
This method eliminates much of the boilerplate used when using pipelines
to watch Redis keys. See the documentation for details on usage.
* 2.4.6
* Variadic arguments for SADD, SREM, ZREN, HDEL, LPUSH, and RPUSH. Thanks
Raphaël Vinot.
* (CRITICAL) Fixed an error in the Hiredis parser that occasionally caused
the socket connection to become corrupted and unusable. This became
noticeable once connection pools started to be used.
* ZRANGE, ZREVRANGE, ZRANGEBYSCORE, and ZREVRANGEBYSCORE now take an
additional optional argument, score_cast_func, which is a callable used
to cast the score value in the return type. The default is float.
* Removed the PUBLISH method from the PubSub class. Connections that are
[P]SUBSCRIBEd cannot issue PUBLISH commands, so it doesn't make sense
to have it here.
* Pipelines now contain WATCH and UNWATCH. Calling WATCH or UNWATCH from
the base client class will result in a deprecation warning. After
WATCHing one or more keys, the pipeline will be placed in immediate
execution mode until UNWATCH or MULTI are called. Refer to the new
pipeline docs in the README for more information. Thanks to David Wolever
and Randall Leeds for greatly helping with this.
* 2.4.5
* The PythonParser now works better when reading zero length strings.
* 2.4.4
* Fixed a typo introduced in 2.4.3
* 2.4.3
* Fixed a bug in the UnixDomainSocketConnection caused when trying to
form an error message after a socket error.
* 2.4.2
* Fixed a bug in pipeline that caused an exception while trying to
reconnect after a connection timeout.
* 2.4.1
* Fixed a bug in the PythonParser if disconnect is called before connect.
* 2.4.0
* WARNING: 2.4 contains several backwards incompatible changes.
* Completely refactored Connection objects. Moved much of the Redis
protocol packing for requests here, and eliminated the nasty dependencies
it had on the client to do AUTH and SELECT commands on connect.
* Connection objects now have a parser attribute. Parsers are responsible
for reading data Redis sends. Two parsers ship with redis-py: a
PythonParser and the HiRedis parser. redis-py will automatically use the
HiRedis parser if you have the Python hiredis module installed, otherwise
it will fall back to the PythonParser. You can force or the other, or even
an external one by passing the `parser_class` argument to ConnectionPool.
* Added a UnixDomainSocketConnection for users wanting to talk to the Redis
instance running on a local machine only. You can use this connection
by passing it to the `connection_class` argument of the ConnectionPool.
* Connections no longer derive from threading.local. See threading.local
note below.
* ConnectionPool has been comletely refactored. The ConnectionPool now
maintains a list of connections. The redis-py client only hangs on to
a ConnectionPool instance, calling get_connection() anytime it needs to
send a command. When get_connection() is called, the command name and
any keys involved in the command are passed as arguments. Subclasses of
ConnectionPool could use this information to identify the shard the keys
belong to and return a connection to it. ConnectionPool also implements
disconnect() to force all connections in the pool to disconnect from
the Redis server.
* redis-py no longer support the SELECT command. You can still connect to
a specific database by specifing it when instantiating a client instance
or by creating a connection pool. If you need to talk to multiplate
databases within your application, you should use a separate client
instance for each database you want to talk to.
* Completely refactored Publish/Subscribe support. The subscribe and listen
commands are no longer available on the redis-py Client class. Instead,
the `pubsub` method returns an instance of the PubSub class which contains
all publish/subscribe support. Note, you can still PUBLISH from the
redis-py client class if you desire.
* Removed support for all previously deprecated commands or options.
* redis-py no longer uses threading.local in any way. Since the Client
class no longer holds on to a connection, it's no longer needed. You can
now pass client instances between threads, and commands run on those
threads will retrieve an available connection from the pool, use it and
release it. It should now be trivial to use redis-py with eventlet or
greenlet.
* ZADD now accepts pairs of value=score keyword arguments. This should help
resolve the long standing #72. The older value and score arguments have
been deprecated in favor of the keyword argument style.
* Client instances now get their own copy of RESPONSE_CALLBACKS. The new
set_response_callback method adds a user defined callback to the instance.
* Support Jython, fixing #97. Thanks to Adam Vandenberg for the patch.
* Using __getitem__ now properly raises a KeyError when the key is not
found. Thanks Ionuț Arțăriși for the patch.
* Newer Redis versions return a LOADING message for some commands while
the database is loading from disk during server start. This could cause
problems with SELECT. We now force a socket disconnection prior to
raising a ResponseError so subsuquent connections have to reconnect and
re-select the appropriate database. Thanks to Benjamin Anderson for
finding this and fixing.
* 2.2.4
* WARNING: Potential backwards incompatible change - Changed order of
parameters of ZREVRANGEBYSCORE to match those of the actual Redis command.
This is only backwards-incompatible if you were passing max and min via
keyword args. If passing by normal args, nothing in user code should have
to change. Thanks Stéphane Angel for the fix.
* Fixed INFO to properly parse the Redis data correctly for both 2.2.x and
2.3+. Thanks Stéphane Angel for the fix.
* Lock objects now store their timeout value as a float. This allows floats
to be used as timeout values. No changes to existing code required.
* WATCH now supports multiple keys. Thanks Rich Schumacher.
* Broke out some code that was Python 2.4 incompatible. redis-py should
now be useable on 2.4, but this hasn't actually been tested. Thanks
Dan Colish for the patch.
* Optimized some code using izip and islice. Should have a pretty good
speed up on larger data sets. Thanks Dan Colish.
* Better error handling when submitting an empty mapping to HMSET. Thanks
Dan Colish.
* Subscription status is now reset after every (re)connection.
* 2.2.3
* Added support for Hiredis. To use, simply "pip install hiredis" or
"easy_install hiredis". Thanks for Pieter Noordhuis for the hiredis-py
bindings and the patch to redis-py.
* The connection class is chosen based on whether hiredis is installed
or not. To force the use of the PythonConnection, simply create
your own ConnectionPool instance with the connection_class argument
assigned to to PythonConnection class.
* Added missing command ZREVRANGEBYSCORE. Thanks Jay Baird for the patch.
* The INFO command should be parsed correctly on 2.2.x server versions
and is backwards compatible with older versions. Thanks Brett Hoerner.
* 2.2.2
* Fixed a bug in ZREVRANK where retriving the rank of a value not in
the zset would raise an error.
* Fixed a bug in Connection.send where the errno import was getting
overwritten by a local variable.
* Fixed a bug in SLAVEOF when promoting an existing slave to a master.
* Reverted change of download URL back to redis-VERSION.tar.gz. 2.2.1's
change of this actually broke Pypi for Pip installs. Sorry!
* 2.2.1
* Changed archive name to redis-py-VERSION.tar.gz to not conflict
with the Redis server archive.
* 2.2.0
* Implemented SLAVEOF
* Implemented CONFIG as config_get and config_set
* Implemented GETBIT/SETBIT
* Implemented BRPOPLPUSH
* Implemented STRLEN
* Implemented PERSIST
* Implemented SETRANGE