reddish 0.2.1

An async redis client library with a minimal api

reddish - an async redis client with minimal api

• Features
• Installation
• Minimal Example
• Usage

Features

• async/await using trio's stream primitives (TCP, TCP+TLS, Unix domain sockets)
• minimal api so you don't have to relearn how to write redis commands
• supports all redis commands including modules except SUBSCRIBE, PSUBSCRIBE and MONITOR [^footnote]
• parses responses back into python types if you like (powered by pydantic)
• works with every redis version and supports both RESP2and RESP3 protocols

[^footnote]: Commands like SUBSCRIBE or MONITOR take over the redis connection for listeting to new events barring regular commands from being issued over the connection.

Installation

pip install reddish

Minimal Example

import trio
from reddish import Redis, Command

redis = Redis(await trio.open_tcp_stream('localhost', 6379))

assert b'PONG' == await redis.execute(Command('PING'))

Usage

Commands with a fixed number of arguments

# simple command without any arguments
Command('PING')

# commands with positional arguments
Command('ECHO {}', 'hello world')

# commands with keyword arguments
Command('SET {key} {value}', key='foo', value=42)

Commands with response parsing

# return response unchanged from redis
assert b'42' == await redis.execute(Command('ECHO {}', 42))

# parse response as type
assert 42 == await redis.execute(Command('ECHO {}', 42).into(int))

# use any type that works with pydantic
from pydantic import Json
import json

data = json.dumps({'alice': 30, 'bob': 42})
response == await redis.execute(Command('ECHO {}', data).into(Json))
assert response == json.loads(data)

Commands with variadic arguments

from reddish import Args

# inlining arguments
Command('DEL {keys}', keys=Args(['foo', 'bar']))  # DEL foo bar

# inlining pairwise arguments 
data = {'name': 'bob', 'age': 42}
Command('XADD foo * {fields}', fields=Args.from_dict(data))  # XADD foo * name bob age 42

Pipelining commands

foo, bar = await redis.execute(Command('GET', 'foo'), Command('GET', 'bar'))

Transactions

from reddish import MultiExec

tx = MultiExec(
    Command('ECHO {}', 'foo'),
    Command('ECHO {}', 'bar')
)

foo, bar = await redis.execute(tx)

# pipelining together with transactions
[foo, bar], baz = await redis.execute(tx, Command('ECHO {}', 'baz'))