coredis is an async redis client for python with support for redis cluster & sentinel.
MIT License
coredis is an async redis client with support for redis server, cluster & sentinel.
The client API uses the specifications in the Redis command documentation to define the API by using the following conventions:
Mapping
.One of
arguments accepting pure tokens are collapsed and accept a PureToken
Responses are mapped between RESP and python types as closely as possible.
For higher level concepts such as Pipelines, LUA Scripts, PubSub & Streams abstractions are provided to encapsulate recommended patterns. See the Handbook and the API Documentation for more details.
Warning The command API does NOT mirror the official python redis client. For details about the high level differences refer to Divergence from aredis & redis-py
To install coredis:
$ pip install coredis
>= Redis 7.0
]
>= Redis 7.0
]
import asyncio
from coredis import Redis, RedisCluster
async def example():
client = Redis(host='127.0.0.1', port=6379, db=0)
# or with redis cluster
# client = RedisCluster(startup_nodes=[{"host": "127.0.01", "port": 7001}])
await client.flushdb()
await client.set('foo', 1)
assert await client.exists(['foo']) == 1
assert await client.incr('foo') == 2
assert await client.incrby('foo', increment=100) == 102
assert int(await client.get('foo')) == 102
assert await client.expire('foo', 1)
await asyncio.sleep(0.1)
assert await client.ttl('foo') == 1
assert await client.pttl('foo') < 1000
await asyncio.sleep(1)
assert not await client.exists(['foo'])
asyncio.run(example())
import asyncio
from coredis.sentinel import Sentinel
async def example():
sentinel = Sentinel(sentinels=[("localhost", 26379)])
primary = sentinel.primary_for("myservice")
replica = sentinel.replica_for("myservice")
assert await primary.set("fubar", 1)
assert int(await replica.get("fubar")) == 1
asyncio.run(example())
To see a full list of supported redis commands refer to the Command compatibility documentation
Details about supported Redis modules and their commands can be found here
coredis is tested against redis versions 6.2.x
, 7.0.x
& 7.2.x
.
The test matrix status can be reviewed
here
coredis is additionally tested against:
uvloop >= 0.15.0
coredis is known to work with the following databases that have redis protocol compatibility: