Use anyio for structured concurrency

.github/workflows/compatibility.yml

@@ -41,7 +41,7 @@ jobs:
           exit 1
         fi;
   test:
-    name: Test (Python ${{ matrix.python-version }}, Redis ${{ matrix.redis-version }}${{ matrix.uvloop == 'True' && ', uvloop' || ''}}${{ matrix.orjson == 'True' && ', orjson' || ''}}${{ matrix.extensions == 'True' && ', compiled' || ''}}${{ matrix.label && format(', {0}', matrix.label) || '' }})
+    name: Test (Python ${{ matrix.python-version }}, Anyio ${{ matrix.anyio-backend || 'asyncio' }}, Redis ${{ matrix.redis-version }}${{ matrix.uvloop == 'True' && ', uvloop' || ''}}${{ matrix.orjson == 'True' && ', orjson' || ''}}${{ matrix.extensions == 'True' && ', compiled' || ''}}${{ matrix.label && format(', {0}', matrix.label) || '' }})
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.redis-version == 'next' }}
     strategy:
@@ -52,6 +52,7 @@ jobs:
         test_params: ["-m '(not (dragonfly or valkey or redict))'"]
         orjson: ["False"]
         uvloop: ["False"]
+        anyio-backend: ["asyncio"]
         runtime_type_checks: ["True"]
         extensions: ["True"]
         label: [""]
@@ -72,6 +73,12 @@ jobs:
             extensions: "False"
             runtime_type_checks: "True"
             label: ""
+          - python-version: "3.13"
+            redis-version: latest
+            test_params: "-m '(not (dragonfly or valkey or redict))'"
+            runtime_type_checks: "True"
+            anyio-backend: "trio"
+            label: ""
           - python-version: "3.13"
             redis-version: latest
             test_params: "-m '(not (dragonfly or valkey or redict))'"
@@ -126,28 +133,22 @@ jobs:
     - name: Compile extensions
       if: ${{ matrix.extensions == 'True' }}
       run: uv run mypyc coredis/constants.py coredis/parser.py coredis/_packer.py coredis/_utils.py
-    - name: Install uvloop
-      if: ${{ matrix.uvloop == 'True' }}
-      run:
-        uv pip install uvloop
-    - name: Install orjson
-      if: ${{ matrix.orjson == 'True' }}
-      run:
-        uv pip install orjson
     - name: Tests with coverage
       env:
         COREDIS_UVLOOP: ${{ matrix.uvloop }}
+        COREDIS_ANYIO_BACKEND: ${{ matrix.anyio-backend }}
         HOST_OS: linux
         CI: "True"
         COREDIS_REDIS_VERSION: ${{matrix.redis-version}}
         COREDIS_RUNTIME_CHECKS: ${{matrix.runtime_type_checks}}
         PYTEST_SENTRY_DSN: ${{ matrix.extensions != 'True' && secrets.SENTRY_DSN || ''}}
         COMPOSE_PARALLEL_LIMIT: 1
+        UV_GROUP: ${{ matrix.orjson == 'True' && 'orjson' || 'dev' }}
       run: |
         echo "Runtime checks: $COREDIS_RUNTIME_CHECKS"
         echo "UVLoop: $COREDIS_UVLOOP"
         echo "CI: $CI"
-        uv run pytest --reverse --reruns 2 --cov=coredis --cov-report=xml ${{ matrix.test_params }}
+        uv run --group $UV_GROUP pytest --timeout=60 --reverse --reruns 2 --cov=coredis --cov-report=xml ${{ matrix.test_params }}
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4.2.0
       env:

.github/workflows/main.yml

@@ -36,7 +36,7 @@ jobs:
           exit 1
         fi;
   test:
-    name: Test (Python ${{ matrix.python-version }}, Redis ${{ matrix.redis-version }}${{ matrix.uvloop == 'True' && ', uvloop' || ''}}${{ matrix.orjson == 'True' && ', orjson' || ''}}${{ matrix.extensions == 'True' && ', compiled' || ''}}${{ matrix.label && format(', {0}', matrix.label) || '' }})
+    name: Test (Python ${{ matrix.python-version }}, ${{ matrix.anyio-backend || 'asyncio' }}, Redis ${{ matrix.redis-version }}${{ matrix.uvloop == 'True' && ', uvloop' || ''}}${{ matrix.orjson == 'True' && ', orjson' || ''}}${{ matrix.extensions == 'True' && ', compiled' || ''}}${{ matrix.label && format(', {0}', matrix.label) || '' }})
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.redis-version == 'next' }}
     strategy:
@@ -47,6 +47,7 @@ jobs:
         test_params: ["-m '(not (dragonfly or valkey or redict))'"]
         uvloop: ["False"]
         orjson: ["False"]
+        anyio-backend: ["asyncio"]
         runtime_type_checks: ["True"]
         extensions: ["True"]
         label: [""]
@@ -66,6 +67,11 @@ jobs:
             test_params: "-m '(not (dragonfly or valkey or redict))'"
             runtime_type_checks: "True"
             uvloop: "True"
+          - python-version: "3.13"
+            redis-version: "latest"
+            test_params: "-m '(not (dragonfly or valkey or redict))'"
+            runtime_type_checks: "True"
+            anyio-backend: "trio"
           - python-version: "3.13"
             redis-version: "latest"
             test_params: "-m dragonfly"
@@ -102,28 +108,22 @@ jobs:
     - name: Compile extensions
       if: ${{ matrix.extensions == 'True' }}
       run: uv run mypyc coredis/constants.py coredis/parser.py coredis/_packer.py coredis/_utils.py
-    - name: Install uvloop
-      if: ${{ matrix.uvloop == 'True' }}
-      run:
-        uv pip install uvloop
-    - name: Install orjson
-      if: ${{ matrix.orjson == 'True' }}
-      run:
-        uv pip install orjson
     - name: Tests
       env:
         COREDIS_UVLOOP: ${{ matrix.uvloop }}
+        COREDIS_ANYIO_BACKEND: ${{ matrix.anyio-backend }}
         HOST_OS: linux
         CI: "True"
         COREDIS_REDIS_VERSION: ${{matrix.redis-version}}
         COREDIS_RUNTIME_CHECKS: ${{matrix.runtime_type_checks}}
         PYTEST_SENTRY_DSN: ${{ matrix.extensions != 'True' && secrets.SENTRY_DSN || ''}}
         COMPOSE_PARALLEL_LIMIT: 1
+        UV_GROUP: ${{ matrix.orjson == 'True' && 'orjson' || 'dev' }}
       run: |
         echo "Runtime checks: $COREDIS_RUNTIME_CHECKS"
         echo "UVLoop: $COREDIS_UVLOOP"
         echo "CI: $CI"
-        uv run pytest --reverse --reruns 2 --cov=coredis --cov-report=xml ${{ matrix.test_params }}
+        uv run --group $UV_GROUP pytest --timeout=60 --reverse --reruns 2 --cov=coredis --cov-report=xml ${{ matrix.test_params }}
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4.2.0
       env:

HISTORY.rst

@@ -3,6 +3,34 @@
 Changelog
 =========
 
+v6.0.0rc1
+---------
+Release Date: TBD
+
+* Feature
+
+  * Migrates entire library to ``anyio``, adding structured concurrency and Trio support.
+
+    * Almost all objects (clients, connection pools, PubSub, pipelines) now require use of
+      an async context manager for initialization/cleanup.
+    * Test suite now runs tests on both asyncio and Trio backends
+    * Caching is simplified, and users should replace ``TrackingCache`` instances with a
+      ``LRUCache`` instance instead. Cache no longer has a max byte size, so max keys
+      should be used instead.
+    * All connection types use ``anyio`` networking APIs.
+    * ``Pipeline.execute()`` no longer exists. Instead, pipelines auto-execute when leaving
+      their context manager. Results can be accessed afterwards in a type-safe way.
+  * RESP2 support has been dropped.
+  * All connection pools are now blocking.
+  * ``Library.wraps`` is now just ``wraps`` and supports callbacks. It also optimistically
+    calls FCALL in pipelines instead of checking the function exists first.
+  * When defining type stubs for FFI for Lua scripts or library functions, keys can only
+    be distinguished from arguments by annotating them with the ``KeyT`` type.
+  * EVALSHA and FCALL commands now support optional callbacks
+  * Removes ``Monitor`` wrapper
+  * Client now includes ``Redis.lock`` as a convenient way to access the ``LuaLock``
+    recipe, and the class is now just called ``Lock``.
+
 v5.5.0
 ------
 Release Date: 2026-01-12

README.md

@@ -1,156 +1,88 @@
-# coredis
-
 [![docs](https://readthedocs.org/projects/coredis/badge/?version=stable)](https://coredis.readthedocs.org)
 [![codecov](https://codecov.io/gh/alisaifee/coredis/branch/master/graph/badge.svg)](https://codecov.io/gh/alisaifee/coredis)
 [![Latest Version in PyPI](https://img.shields.io/pypi/v/coredis.svg)](https://pypi.python.org/pypi/coredis/)
 [![ci](https://github.com/alisaifee/coredis/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/alisaifee/coredis/actions?query=branch%3Amaster+workflow%3ACI)
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/coredis.svg)](https://pypi.python.org/pypi/coredis/)
 
-______________________________________________________________________
-
-coredis is an async redis client with support for redis server, cluster & sentinel.
-
-- The client API uses the specifications in the [Redis command documentation](https://redis.io/commands/) 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](https://coredis.readthedocs.io/en/latest/api/typing.html#coredis.typing.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](https://coredis.readthedocs.io/en/latest/api/utilities.html#coredis.tokens.PureToken)
-
-- Responses are mapped between RESP and python types as closely as possible.
-
-- For higher level concepts such as Pipelines, LUA Scripts, PubSub & Streams
-  abstractions are provided to encapsulate recommended patterns.
-  See the [Handbook](https://coredis.readthedocs.io/en/latest/handbook/index.html)
-  and the [API Documentation](https://coredis.readthedocs.io/en/latest/api/index.html)
-  for more details.
-
-______________________________________________________________________
+# coredis
 
-<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+Fast, async, fully-typed Redis client with support for cluster and sentinel
 
-- [Installation](#installation)
-- [Feature Summary](#feature-summary)
-  - [Deployment topologies](#deployment-topologies)
-  - [Application patterns](#application-patterns)
-  - [Server side scripting](#server-side-scripting)
-  - [Redis Modules](#redis-modules)
-  - [Miscellaneous](#miscellaneous)
-- [Quick start](#quick-start)
-  - [Single Node or Cluster client](#single-node-or-cluster-client)
-  - [Sentinel](#sentinel)
-- [Compatibility](#compatibility)
-  - [Supported python versions](#supported-python-versions)
-  - [Redis API compatible databases backends](#redis-api-compatible-databases)
-- [References](#references)
+## Features
 
-<!-- /TOC -->
+- Fully typed, even when using pipelines, Lua scripts, and libraries
+- Redis [Cluster](https://coredis.readthedocs.org/en/latest/handbook/cluster.html#redis-cluster) and [Sentinel](https://coredis.readthedocs.org/en/latest/api/clients.html#sentinel) support
+- Built with structured concurrency on `anyio`, supports both `asyncio` and `trio`
+- Server-assisted [client-side caching](https://coredis.readthedocs.org/en/latest/handbook/caching.html) implementation
+- [Redis Stack modules](https://coredis.readthedocs.org/en/latest/handbook/modules.html) support
+- [Redis PubSub](https://coredis.readthedocs.org/en/latest/handbook/pubsub.html)
+- [Pipelining](https://coredis.readthedocs.org/en/latest/handbook/pipelines.html)
+- [Lua scripts](https://coredis.readthedocs.org/en/latest/handbook/scripting.html#lua_scripting) and [Redis functions](https://coredis.readthedocs.org/en/latest/handbook/scripting.html#library-functions) \[`>= Redis 7.0`\] support, with optional types
+- Convenient [Stream Consumers](https://coredis.readthedocs.org/en/latest/handbook/streams.html) implementation
+- Comprehensive documentation
+- Optional [runtime type validation](https://coredis.readthedocs.org/en/latest/handbook/typing.html#runtime-type-checking) (via [beartype](https://github.com/beartype/beartype))
 
 ## Installation
 
-To install coredis:
-
-```bash
+```console
 $ pip install coredis
 ```
 
-## Feature Summary
-
-### Deployment topologies
-
-- [Redis Cluster](https://coredis.readthedocs.org/en/latest/handbook/cluster.html#redis-cluster)
-- [Sentinel](https://coredis.readthedocs.org/en/latest/api/clients.html#sentinel)
-
-### Application patterns
-
-- [Connection Pooling](https://coredis.readthedocs.org/en/latest/handbook/connections.html#connection-pools)
-- [PubSub](https://coredis.readthedocs.org/en/latest/handbook/pubsub.html)
-- [Sharded PubSub](https://coredis.readthedocs.org/en/latest/handbook/pubsub.html#sharded-pub-sub) \[`>= Redis 7.0`\]
-- [Stream Consumers](https://coredis.readthedocs.org/en/latest/handbook/streams.html)
-- [Pipelining](https://coredis.readthedocs.org/en/latest/handbook/pipelines.html)
-- [Client side caching](https://coredis.readthedocs.org/en/latest/handbook/caching.html)
-
-### Server side scripting
-
-- [LUA Scripting](https://coredis.readthedocs.org/en/latest/handbook/scripting.html#lua_scripting)
-- [Redis Libraries and functions](https://coredis.readthedocs.org/en/latest/handbook/scripting.html#library-functions) \[`>= Redis 7.0`\]
-
-### Redis Modules
-
-- [RedisJSON](https://coredis.readthedocs.org/en/latest/handbook/modules.html#redisjson)
-- [RediSearch](https://coredis.readthedocs.org/en/latest/handbook/modules.html#redisearch)
-- [RedisBloom](https://coredis.readthedocs.org/en/latest/handbook/modules.html#redisbloom)
-- [RedisTimeSeries](https://coredis.readthedocs.org/en/latest/handbook/modules.html#redistimeseries)
-
-### Miscellaneous
-
-- Public API annotated with type annotations
-- Optional [Runtime Type Validation](https://coredis.readthedocs.org/en/latest/handbook/typing.html#runtime-type-checking) (via [beartype](https://github.com/beartype/beartype))
-
-## Quick start
+## Getting started
 
-### Single Node or Cluster client
+To start, you'll need to connect to your `Redis` instance:
 
 ```python
-import asyncio
-from coredis import Redis, RedisCluster
+import trio
+from coredis import Redis
 
-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}])
+client = Redis(host='127.0.0.1', port=6379, db=0, decode_responses=True)
+async with client:
     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 int(await client.get('foo') or 0) == 102
 
     assert await client.expire('foo', 1)
-    await asyncio.sleep(0.1)
+    await trio.sleep(0.1)
     assert await client.ttl('foo') == 1
     assert await client.pttl('foo') < 1000
-    await asyncio.sleep(1)
+    await trio.sleep(1)
     assert not await client.exists(['foo'])
-
-asyncio.run(example())
 ```
 
-### Sentinel
+Sentinel is also supported:
 
 ```python
-import asyncio
 from coredis.sentinel import Sentinel
 
-async def example():
-    sentinel = Sentinel(sentinels=[("localhost", 26379)])
+sentinel = Sentinel(sentinels=[("localhost", 26379)])
+async with sentinel:
     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())
+    async with primary, replica:
+        assert await primary.set("fubar", 1)
+        assert int(await replica.get("fubar")) == 1
 ```
 
-To see a full list of supported redis commands refer to the [Command
-compatibility](https://coredis.readthedocs.io/en/latest/compatibility.html)
-documentation
-
-Details about supported Redis modules and their commands can be found
-[here](https://coredis.readthedocs.io/en/latest/handbook/modules.html)
-
 ## Compatibility
 
+To see a full list of supported Redis commands refer to the [Command
+compatibility](https://coredis.readthedocs.io/en/latest/compatibility.html)
+documentation. Details about supported Redis modules and their commands can be found
+[here](https://coredis.readthedocs.io/en/latest/handbook/modules.html).
+
 coredis is tested against redis versions >= `7.0`
 The test matrix status can be reviewed
 [here](https://github.com/alisaifee/coredis/actions/workflows/main.yml)
 
 coredis is additionally tested against:
 
-- ` uvloop >= 0.15.0`
+- `uvloop >= 0.15.0`
+- `trio`
 
 ### Supported python versions
 

coredis/__init__.py

@@ -17,12 +17,8 @@
     Connection,
     UnixDomainSocketConnection,
 )
-from coredis.pool import (
-    BlockingClusterConnectionPool,
-    BlockingConnectionPool,
-    ClusterConnectionPool,
-    ConnectionPool,
-)
+from coredis.pool import ClusterConnectionPool, ConnectionPool
+from coredis.sentinel import Sentinel
 from coredis.tokens import PureToken
 
 __all__ = [
@@ -33,10 +29,9 @@
     "Connection",
     "UnixDomainSocketConnection",
     "ClusterConnection",
-    "BlockingConnectionPool",
     "ConnectionPool",
-    "BlockingClusterConnectionPool",
     "ClusterConnectionPool",
     "PureToken",
+    "Sentinel",
     "__version__",
 ]