Welcome to redis-py-cluster’s documentation!

This project is a port of redis-rb-cluster by antirez, with a lot of added functionality.

The original source can be found at https://github.com/antirez/redis-rb-cluster.

The source code for this project is available on github.


Latest stable release from pypi

$ pip install redis-py-cluster

or from source code

$ python setup.py install

Basic usage example

Small sample script that shows how to get started with RedisCluster. It can also be found in the file exmaples/basic.py.

Additional code examples of more advance functionality can be found in the examples/ folder in the source code git repo.

>>> from rediscluster import RedisCluster

>>> # Requires at least one node for cluster discovery. Multiple nodes is recommended.
>>> startup_nodes = [{"host": "", "port": "7000"}]

>>> # Note: See note on Python 3 for decode_responses behaviour
>>> rc = RedisCluster(startup_nodes=startup_nodes, decode_responses=True)

>>> rc.set("foo", "bar")
>>> print(rc.get("foo"))


Python 3

Since Python 3 changed to Unicode strings from Python 2’s ASCII, the return type of most commands will be binary strings, unless the class is instantiated with the option decode_responses=True.

In this case, the responses will be Python 3 strings (Unicode).

For the init argument decode_responses, when set to False, redis-py-cluster will not attempt to decode the responses it receives.

In Python 3, this means the responses will be of type bytes. In Python 2, they will be native strings (str).

If decode_responses is set to True, for Python 3 responses will be str, for Python 2 they will be unicode.

Library Dependencies

Even if the goal is to support all major versions of redis-py in the 3.x.x track, this is not a guarantee that all versions will work.

It is always recommended to use the latest version of the dependencies of this project.

  • Redis-py: ‘redis>=3.0.0,<4.0.0’ is required in this major version of this cluster lib.
  • Optional Python: hiredis >= 0.2.0. Older versions might work but is not tested.
  • A working Redis cluster based on version >=3.0.0 is required.

Supported python versions

Python versions should follow the same supported python versions as specificed by the upstream package redis-py, based on what major version(s) that is specified.

If this library supports more then one major version line of redis-py, then the supported python versions must include the set of supported python versions by all major version lines.

  • 2.7
  • 3.5
  • 3.6
  • 3.7
  • 3.8

Python 2 Compatibility Note

This library follows the announced change from our upstream package redis-py. Due to this, we will follow the same python 2.7 deprecation timeline as stated in there.

redis-py-cluster 2.1.x will be the last major version release that supports Python 2.7. The 2.1.x line will continue to get bug fixes and security patches that support Python 2 until August 1, 2020. redis-py-cluster 3.0.x will be the next major version and will require Python 3.5+.

Regarding duplicate package name on pypi

It has been found that the python module name that is used in this library (rediscluster) is already shared with a similar but older project.

This lib will NOT change the naming of the module to something else to prevent collisions between the libs.

My reasoning for this is the following

  • Changing the namespace is a major task and probably should only be done in a complete rewrite of the lib, or if the lib had plans for a version 2.0.0 where this kind of backwards incompatibility could be introduced.
  • This project is more up to date, the last merged PR in the other project was 3 years ago.
  • This project is aimed for implement support for the cluster support in 3.0+, the other lib do not have that right now, but they implement almost the same cluster solution as the 3.0+ but in much more in the client side.
  • The 2 libs is not compatible to be run at the same time even if the name would not collide. It is not recommended to run both in the same python interpreter.

An issue has been raised in each repository to have tracking of the problem.

redis-py-cluster: https://github.com/Grokzen/redis-py-cluster/issues/150

rediscluster: https://github.com/salimane/rediscluster-py/issues/11