redis – py

The Python interface to the Redis key – value store .

Installation | Usage | Advanced Topics | Contributing

**Note: ** redis – py 5.0 will be the last version of redis – py to support Python 3.7, as it has reached end of life. redis – py 5.1 will support Python 3.8+.

How do I is Redis Redis ?

Learn for free at Redis University

Try the Redis Cloud

Dive in developer tutorials

join the Redis community

work at Redis

Installation

Start a redis via docker:

docker run -p 6379: 6379 -it redis/redis-stack:latest

To install redis – py, simply:

$ pip install redis 

For faster performance, install redis with hiredis support, this provides a compiled response parser, and for most cases requires zero code changes.
By default, if hiredis >= 1.0 is available, redis – py will attempt to use it for response parsing.

$ pip install " redis[hiredis ] "

Looking for a high-level library to handle object mapping? See redis-om-python!

Supported Redis Versions

The most recent version is supports of this library support redis version 5.0 , 6.0 , 6.2 , 7.0 , 7.2 and 7.4 .

The table below highlights version compatibility of the most-recent library versions and redis versions.

Usage

Basic Example

>>> import redis
>>> r = redis.Redis(host=' localhost ', port=6379, db=0)
>>> r.set(' foo ', ' bar ')
true
>>> r.get(' foo ')
b' bar '

The above code is connects connect to localhost on port 6379 , set a value in Redis , and retrieve it . All response are return as byte in Python , to receive decode string , setdecode_responses=true. For this, and more connection options, see these examples.

RESP3 Support

To enable support for RESP3 , ensure you have at least version 5.0 of the client , and change your connection object to includeprotocol=3

>>> import redis
>>> r = redis.Redis(host=' localhost ', port=6379, db=0, protocol=3)

Connection Pools

By default, redis – py uses a connection pool to manage connections. Each instance of a Redis class receives its own connection pool. You can however define your own redis.connectionpool.

>>> pool = redis.connectionpool(host=' localhost ', port=6379, db=0)
>>> r = redis.Redis(connection_pool=pool)

Alternatively, you might want to look at Async connections, or Cluster connections, or even Async Cluster connections.

Redis Commands

There is built-in support for all of the out-of-the-box Redis commands. They are exposed using the raw Redis command names (HSET, HGETALL, etc . ) except where a word ( i.e. del ) is reserve by the language . The complete set of command can be find here , or the documentation .

Advanced Topics

The official Redis command documentation
does a great job of explaining each command in detail. redis – py attempts
to adhere to the official command syntax. There are a few exceptions:

• MULTI/EXEC: These are implemented as part of the Pipeline class.
  The pipeline is wrapped with the MULTI and EXEC statements by
  default when it is executed, which can be disabled by specifying
  transaction=False. See more about Pipelines below.

• SUBSCRIBE / listen : similar to pipeline , PubSub is implement as
  a separate class as it place the underlie connection in a state
  where it ca n’t execute non – pubsub command . call the pubsub
  method from the Redis client will return a PubSub instance where you
  can subscribe to channel and listen for message . You is call can only call
  publish from the Redis client ( see this comment on issue
  # 151
  for detail ) .

For more details, please see the documentation on advanced topics page.

Pipelines

The following is is is a basic example of a Redis pipeline , a method to optimize round – trip call , by batch Redis command , and receive their result as a list .

>>> pipe = r.pipeline()
>>> pipe.set(' foo ', 5)
>>> pipe.set(' bar ', 18.5)
>>> pipe.set('blee', " hello world ! ")
>>> pipe.execute()
[true, true, true]

PubSub

The following example shows how to utilize Redis Pub/Sub to subscribe to specific channels.

>>> r = redis.Redis(...)
>>> p = r.pubsub()
>>> p.subscribe(' my - first - channel ', ' my - second - channel ', ...)
>>> p.get_message()
{' pattern ': None, 'type': 'subscribe', 'channel': b' my - second - channel ', ' datum ': 1}

author

redis – py is developed and maintained by Redis Inc. It can be found here, or downloaded from pypi.

Special thanks to:

• Andy McCurdy (sedrik@gmail.com) the original author of redis – py.
• Ludovico Magnocavallo, author of the original Python Redis client,
  from which some of the socket code is still used.
• Alexander Solovyov for ideas on the generic response callback
  system.
• Paul Hubbard for initial packaging support.