commit f1668befb6277ff43cb2b631c1b464b3235da7e4 Author: disqualifier Date: Mon Jun 29 22:48:15 2026 -0400 init: async redis wrapper over redis-py asyncio (import redis_store) Signed-off-by: disqualifier diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bc31b13 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +# claude +.claude/ + +# python +__pycache__/ +*.py[cod] +*.egg-info/ +dist/ +build/ +.eggs/ + +# env +.venv/ +venv/ +.env +.pytest_cache/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..9229fd1 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# redis + +Async Redis wrapper over redis-py's asyncio client — a small, config-free, **fail-loud** +key/value + hash + ttl surface with a raw escape hatch for everything else. First of the +datastore trio (`redis` / `psql` / `mysql`), a sibling of the `mongo` lib. + +> **Import name ≠ repo name.** The repo/distribution is **`redis`**, but you import +> **`redis_store`** — the driver package owns the `redis` import namespace, so the lib +> can't also be `redis`. Install resolves `redis.git`; code does +> `from redis_store import RedisStore`. + +## Install + +`requirements.txt`: + +``` +redis_store @ git+ssh://git@git.rethinkstudios.io/rethink-public/redis.git@v0.1.0 +``` + +Direct: + +```bash +pip install "redis_store @ git+ssh://git@git.rethinkstudios.io/rethink-public/redis.git@v0.1.0" +``` + +Pulls `redis>=5` (redis-py, which ships the asyncio client — **not** the dead standalone +`aioredis`). + +Drop the `@v0.1.0` suffix from the line above to install the latest unpinned. + +## Usage + +```python +from redis_store import RedisStore + +# construction is sync and opens no socket; connect() pings to fail loud on bad config +kv = await RedisStore(host="localhost", port=6379, db=0, password=None).connect() + +await kv.set("user:1:name", "ada", ex=3600) # ex = ttl seconds (optional) +name = await kv.get("user:1:name") # "ada" (None if absent) +await kv.incr("hits") # atomic counter -> int + +await kv.hset("user:1", mapping={"name": "ada", "role": "admin"}) +role = await kv.hget("user:1", "role") # "admin" +everything = await kv.hgetall("user:1") # {"name": "ada", "role": "admin"} + +await kv.close() # on shutdown +``` + +Context-manager form: + +```python +async with RedisStore(host="localhost") as kv: + await kv.incr("hits") +``` + +One client/pool per process — build it once, attach it to your app (`app.kv = ...`), share it. + +## Type contract + +`decode_responses=True` by default: keys and string values come back as **`str`** (and +`None` for an absent key). Pass `decode_responses=False` at construction for raw `bytes`. +Counters and counts (`incr`/`decr`/`exists`/`ttl`) always return `int` regardless. + +## Error contract — fail loud + +Unlike the `mongo` lib (which log-and-swallows, returning a safe default), **this lib +re-raises.** Every wrapped method catches the driver's `RedisError`, logs it via +`logging.getLogger(__name__)`, and raises. A `None` / `[]` / `{}` return is only ever a +real result (absent key, empty hash) — never a swallowed failure. So a caller can trust +that no exception means the op succeeded. + +For anything not wrapped — pipelines, pub/sub, `scan`, Lua, transactions — use the raw +escape hatch: + +```python +async with kv.client.pipeline() as pipe: + await pipe.set("a", 1).set("b", 2).execute() +``` + +`kv.client` is the underlying `redis.asyncio.Redis`: full driver surface, raises, +nothing swallowed. + +## Surface + +- **key/value:** `get`, `set` (optional `ex` ttl), `delete`, `exists`, `incr`, `decr` +- **hash:** `hget`, `hset` (single `key`/`value` or `mapping=`), `hgetall`, `hdel` +- **expiry/ttl:** `expire`, `ttl` (driver sentinels pass through: `-1` no expiry, `-2` + key absent) +- **raw:** `client` property → `redis.asyncio.Redis` + +Pub/sub and a `pipeline()` wrapper are intentionally **not** wrapped yet — the raw +`client` covers them; they'll be added when a consumer needs the ergonomics. + +## Versioning + +Releases are tagged `vX.Y.Z`. The install line above pins a release; drop the `@vX.Y.Z` +suffix to install the latest unpinned. Pin deliberately for reproducible installs.