Package: redis
redis-pyThe 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 reachedend of life. redis-py 5.1 will support Python 3.8+.How do I Redis?Learn for free at Redis UniversityBuild faster with the Redis LaunchpadTry the Redis CloudDive in developer tutorialsJoin the Redis communityWork at RedisInstallationStart a redis via docker:dockerrun-p6379:6379-itredis/redis-stack:latestTo install redis-py, simply:$pipinstallredisFor faster performance, install redis with hiredis support, this provides a compiled response parser, andfor most casesrequires zero code changes.
By default, if hiredis >= 1.0 is available, redis-py will attempt to use it for response parsing.$pipinstall"redis[hiredis]"Looking for a high-level library to handle object mapping? Seeredis-om-python!Supported Redis VersionsThe most recent version of this library supports redis version5.0,6.0,6.2,7.0and7.2.The table below highlights version compatibility of the most-recent library versions and redis versions.Library versionSupported redis versions3.5.3<= 6.2 Family of releases>= 4.5.0Version 5.0 to 7.0>= 5.0.0Version 5.0 to currentUsageBasic Example>>>importredis>>>r=redis.Redis(host='localhost',port=6379,db=0)>>>r.set('foo','bar')True>>>r.get('foo')b'bar'The above code connects to localhost on port 6379, sets a value in Redis, and retrieves it. All responses are returned as bytes in Python, to receive decoded strings, setdecode_responses=True.  For this, and more connection options, seethese examples.RESP3 SupportTo enable support for RESP3, ensure you have at least version 5.0 of the client, and change your connection object to includeprotocol=3>>>importredis>>>r=redis.Redis(host='localhost',port=6379,db=0,protocol=3)Connection PoolsBy 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 ownredis.ConnectionPool.>>>pool=redis.ConnectionPool(host='localhost',port=6379,db=0)>>>r=redis.Redis(connection_pool=pool)Alternatively, you might want to look atAsync connections, orCluster connections, or evenAsync Cluster connections.Redis CommandsThere is built-in support for all of theout-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 reserved by the language. The complete set of commands can be foundhere, orthe documentation.Advanced TopicsTheofficial Redis command documentationdoes 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 pipelines, PubSub is implemented as
a separate class as it places the underlying connection in a state
where it can't execute non-pubsub commands. Calling the pubsub
method from the Redis client will return a PubSub instance where you
can subscribe to channels and listen for messages. You can only call
PUBLISH from the Redis client (seethis comment on issue
#151for details).For more details, please see the documentation onadvanced topics page.PipelinesThe following is a basic example of aRedis pipeline, a method to optimize round-trip calls, by batching Redis commands, and receiving their results 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]PubSubThe following example shows how to utilizeRedis Pub/Subto 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','data':1}Authorredis-py is developed and maintained byRedis Inc. It can be foundhere, or downloaded frompypi.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.