coredis 4.5.4

Python async client for Redis key-value store

coredis

coredis is an async redis client with support for redis server, cluster & sentinel.

• Installation
• Feature Summary
  • Deployment topologies
  • Application patterns
  • Server side scripting
  • Miscellaneous
• Quick start
  • Single Node client
  • Cluster client
• Compatibility
  • Supported python versions
  • Redis-like Backends
• References

Installation

To install coredis:

$ pip install coredis

Feature Summary

Deployment topologies

• Redis Cluster
• Sentinel

Application patterns

• Connection Pooling
• PubSub
• Sharded PubSub [>= Redis 7.0]
• Stream Consumers
• Pipelining
• Client side caching

Server side scripting

• LUA Scripting
• Redis Libraries and functions [>= Redis 7.0]

Miscellaneous

• Public API annotated with type annotations
• Optional Runtime Type Validation (via beartype)

Quick start

Single Node client

import asyncio
from coredis import Redis

async def example():
    client = Redis(host='127.0.0.1', port=6379, db=0)
    await client.flushdb()
    await client.set('foo', 1)
    assert await client.exists(['foo']) == 1
    await client.incr('foo')
    await client.incrby('foo', increment=100)

    assert int(await client.get('foo')) == 102
    await client.expire('foo', 1)
    await asyncio.sleep(0.1)
    await client.ttl('foo')
    await asyncio.sleep(1)
    assert not await client.exists(['foo'])

asyncio.run(example())

Cluster client

import asyncio
from coredis import RedisCluster

async def example():
    client = RedisCluster(host='172.17.0.2', port=7001)
    await client.flushdb()
    await client.set('foo', 1)
    await client.lpush('a', [1])
    print(await client.cluster_slots())

    await client.rpoplpush('a', 'b')
    assert await client.rpop('b') == b'1'

asyncio.run(example())
# {(10923, 16383): [{'host': b'172.17.0.2', 'node_id': b'332f41962b33fa44bbc5e88f205e71276a9d64f4', 'server_type': 'master', 'port': 7002},
# {'host': b'172.17.0.2', 'node_id': b'c02deb8726cdd412d956f0b9464a88812ef34f03', 'server_type': 'slave', 'port': 7005}],
# (5461, 10922): [{'host': b'172.17.0.2', 'node_id': b'3d1b020fc46bf7cb2ffc36e10e7d7befca7c5533', 'server_type': 'master', 'port': 7001},
# {'host': b'172.17.0.2', 'node_id': b'aac4799b65ff35d8dd2ad152a5515d15c0dc8ab7', 'server_type': 'slave', 'port': 7004}],
# (0, 5460): [{'host': b'172.17.0.2', 'node_id': b'0932215036dc0d908cf662fdfca4d3614f221b01', 'server_type': 'master', 'port': 7000},
# {'host': b'172.17.0.2', 'node_id': b'f6603ab4cb77e672de23a6361ec165f3a1a2bb42', 'server_type': 'slave', 'port': 7003}]}

To see a full list of supported redis commands refer to the Command compatibility documentation

Compatibility

coredis is tested against redis versions 6.0.x, 6.2.x & 7.0.x. The test matrix status can be reviewed here

coredis is additionally tested against:

• uvloop >= 0.15.0

Supported python versions

• 3.7
• 3.8
• 3.9
• 3.10
• PyPy 3.8

Redis-like backends

coredis is known to work with the following databases that have redis protocol compatibility:

• KeyDB
• Dragonfly

References

• Documentation (Stable)
• Documentation (Latest)
• Changelog
• Project History