Skip to main content

Python async client for Redis key-value store

Project description

coredis

docs codecov Latest Version in PyPI ci Supported Python versions


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:

    • Arguments retain naming from redis as much as possible
    • Only optional variadic arguments are mapped to variadic positional or keyword arguments. When the variable length arguments are not optional (which is almost always the case) the expected argument is an iterable of type Parameters or Mapping.
    • Pure tokens used as flags are mapped to boolean arguments
    • One of arguments accepting pure tokens are collapsed and accept a PureToken
  • Responses are mapped as closely from RESP <-> python types as possible.

  • For higher level concepts such as Pipelines, LUA Scripts, PubSub & Streams abstractions are provided to simplify interaction requires pre-defined sequencing of redis commands (see Command Wrappers) and the Handbook.

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


Installation

To install coredis:

$ pip install coredis

Feature Summary

Deployment topologies

Application patterns

Server side scripting

Miscellaneous

Quick start

Single Node or Cluster client

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())

Sentinel

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

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
  • 3.11
  • PyPy 3.7
  • PyPy 3.8
  • PyPy 3.9

Redis-like backends

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

References

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coredis-4.11.2.tar.gz (195.1 kB view hashes)

Uploaded Source

Built Distributions

coredis-4.11.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (300.8 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

coredis-4.11.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (298.4 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

coredis-4.11.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (304.2 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

coredis-4.11.2-cp311-cp311-macosx_11_0_arm64.whl (275.7 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

coredis-4.11.2-cp311-cp311-macosx_10_9_x86_64.whl (278.0 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

coredis-4.11.2-cp311-cp311-macosx_10_9_universal2.whl (363.0 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

coredis-4.11.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (302.5 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

coredis-4.11.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (300.2 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

coredis-4.11.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (306.4 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

coredis-4.11.2-cp310-cp310-macosx_11_0_arm64.whl (277.5 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

coredis-4.11.2-cp310-cp310-macosx_10_9_x86_64.whl (279.7 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

coredis-4.11.2-cp310-cp310-macosx_10_9_universal2.whl (366.5 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)

coredis-4.11.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (302.7 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

coredis-4.11.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (299.8 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

coredis-4.11.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (306.3 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

coredis-4.11.2-cp39-cp39-macosx_11_0_arm64.whl (277.5 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

coredis-4.11.2-cp39-cp39-macosx_10_9_x86_64.whl (279.5 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

coredis-4.11.2-cp39-cp39-macosx_10_9_universal2.whl (366.4 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ universal2 (ARM64, x86-64)

coredis-4.11.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (301.8 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

coredis-4.11.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (299.4 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

coredis-4.11.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (305.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

coredis-4.11.2-cp38-cp38-macosx_11_0_arm64.whl (276.0 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

coredis-4.11.2-cp38-cp38-macosx_10_9_x86_64.whl (278.0 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

coredis-4.11.2-cp38-cp38-macosx_10_9_universal2.whl (363.4 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ universal2 (ARM64, x86-64)

coredis-4.11.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (294.7 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

coredis-4.11.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (292.9 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ARM64

coredis-4.11.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (298.2 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

coredis-4.11.2-cp37-cp37m-macosx_10_9_x86_64.whl (273.9 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page