Python async client for Redis key-value store

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for alisaifee from gravatar.com alisaifee

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Ali-Akber Saifee

Maintainer: Ali-Akber Saifee

Tags Redis, key-value store, asyncio

Requires: Python >=3.7

Classifiers

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 mirrors the specifications in the Redis command documentation by using the following rules:

    • 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 redis <-> 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.

It is strongly recommended to use a static type checker of your choice to catch any errors with respect to argument and response types. If static type checking is not a part of your workflow, you can consider using the optional runtime type validation provided with the help of the excellent beartype library.

Installation

To install coredis:

$ pip install coredis

Feature Summary

Deployment topologies

Application patterns

Server side scripting

Miscellaneous

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.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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for alisaifee from gravatar.com alisaifee

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (MIT)

Author: Ali-Akber Saifee

Maintainer: Ali-Akber Saifee

Tags Redis, key-value store, asyncio

Requires: Python >=3.7

Classifiers

Release history Release notifications | RSS feed

4.17.0

4.16.0

4.16.0rc1 pre-release

4.15.1

4.15.0

4.14.0

4.13.3

4.13.2

4.13.1

4.13.0

4.12.4

4.12.3

4.12.2

4.12.1

4.12.0

4.12.0rc1 pre-release

4.12.0b4 pre-release

4.12.0b3 pre-release

4.12.0b2 pre-release

4.12.0b1 pre-release

4.11.6

4.11.5

4.11.3

4.11.2

4.11.1

4.11.0 yanked

Reason this release was yanked:

Compiled extensions missing

4.10.3

4.10.2

4.10.1

4.10.0

4.9.0

4.8.3

4.8.2

4.8.1

4.8.0

4.7.1

4.7.0

4.6.0

4.5.6

This version

4.5.5

4.5.4

4.5.3

4.5.2

4.5.1

4.5.0

4.4.0

4.3.1

4.3.0

4.2.1

4.2.0

4.1.1

4.1.0

4.0.2

4.0.1

4.0.0

4.0.0b2 pre-release

4.0.0b1 pre-release

3.757 yanked

Reason this release was yanked:

This was meant to be 3.7.57

3.11.5

3.11.4

3.11.3

3.11.2

3.11.1

3.11.0

3.10.1

3.10.0

3.9.3

3.9.2

3.9.1

3.9

3.8.12

3.8.11

3.8.10

3.8.9

3.8.7

3.8.6

3.8.5

3.8.0

3.7.57

3.6.0

3.5.1

3.5.0

3.4.7

3.4.6

3.4.5

3.4.3

3.4.2

3.4.1

3.4.0

3.3.0

3.2.0

3.1.1

3.1.0

3.0.3

3.0.2

3.0.1

3.0.0

3.0.0rc2 pre-release

3.0.0rc1 pre-release

2.3.2

2.3.1

2.3.0

2.2.3

2.2.2

2.2.1

2.1.0

2.0.1

2.0.0

2.0.0b1 pre-release

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.5.5.tar.gz (190.3 kB view hashes)

Uploaded Source

Built Distributions

coredis-4.5.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (342.6 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

coredis-4.5.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (346.3 kB view hashes)

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

coredis-4.5.5-cp310-cp310-macosx_11_0_arm64.whl (315.9 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

coredis-4.5.5-cp310-cp310-macosx_10_9_x86_64.whl (320.8 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

coredis-4.5.5-cp310-cp310-macosx_10_9_universal2.whl (398.2 kB view hashes)

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

coredis-4.5.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (342.5 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

coredis-4.5.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (346.1 kB view hashes)

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

coredis-4.5.5-cp39-cp39-macosx_11_0_arm64.whl (315.9 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

coredis-4.5.5-cp39-cp39-macosx_10_9_x86_64.whl (320.7 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

coredis-4.5.5-cp39-cp39-macosx_10_9_universal2.whl (398.0 kB view hashes)

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

coredis-4.5.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (341.7 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

coredis-4.5.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (345.6 kB view hashes)

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

coredis-4.5.5-cp38-cp38-macosx_11_0_arm64.whl (314.6 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

coredis-4.5.5-cp38-cp38-macosx_10_9_x86_64.whl (318.9 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

coredis-4.5.5-cp38-cp38-macosx_10_9_universal2.whl (395.0 kB view hashes)

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

coredis-4.5.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (334.9 kB view hashes)

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

coredis-4.5.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (338.1 kB view hashes)

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

coredis-4.5.5-cp37-cp37m-macosx_10_9_x86_64.whl (314.7 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