Restructure codebase to one class per file, implement async counterpa…

README.md

@@ -3,15 +3,16 @@
 Redis Client implementation for Python 3.
 
 ## Features
-- Base Redis Client
-- Publish Subscribe Client
-- Sentinel Client
-- Connection Pool
-- Sentinel Backed Connection Pool
-- Client & Pool for Redis Cluster
-- Bulk Mode (Not supported with Redis Cluster)
-- Client & Pool with Static Hash Cluster (Supports Bulk Mode)
-- Sentinel Backed Pool with Static Hash Cluster (Supports Bulk Mode)
+- Complete Synchronous and Asynchronous (asyncio) counterparts for all client and pool classes.
+- Base Redis Client & AsyncClient
+- Publish Subscribe Client & AsyncPubSubClient
+- Sentinel Client & AsyncSentinelClient
+- Connection Pool & AsyncPool
+- Sentinel Backed Connection Pool & AsyncSentinelPool
+- Client & Pool for Redis Cluster & AsyncClusterPool
+- Bulk Mode (Sync & Async, not supported with Redis Cluster)
+- Client & Pool with Static Hash Cluster & AsyncHashPool
+- Sentinel Backed Pool with Static Hash Cluster & AsyncSentinelHashPool
 
 ## Documentation
 Documentation can be found on GitHub Pages:

docs/api/client/async_client.md

@@ -0,0 +1,3 @@
+# AsyncClient
+
+::: pyredis.AsyncClient

docs/api/client/async_cluster_client.md

@@ -0,0 +1,3 @@
+# AsyncClusterClient
+
+::: pyredis.AsyncClusterClient

docs/api/client/async_hash_client.md

@@ -0,0 +1,3 @@
+# AsyncHashClient
+
+::: pyredis.AsyncHashClient

docs/api/client/async_pubsub_client.md

@@ -0,0 +1,3 @@
+# AsyncPubSubClient
+
+::: pyredis.AsyncPubSubClient

docs/api/client/async_sentinel_client.md

@@ -0,0 +1,3 @@
+# AsyncSentinelClient
+
+::: pyredis.AsyncSentinelClient

docs/api/client/client.md

@@ -0,0 +1,3 @@
+# Client
+
+::: pyredis.Client

docs/api/client/cluster_client.md

@@ -0,0 +1,3 @@
+# ClusterClient
+
+::: pyredis.ClusterClient

docs/api/client/hash_client.md

@@ -0,0 +1,3 @@
+# HashClient
+
+::: pyredis.HashClient

docs/api/client/pubsub_client.md

@@ -0,0 +1,3 @@
+# PubSubClient
+
+::: pyredis.PubSubClient

docs/api/client/sentinel_client.md

@@ -0,0 +1,3 @@
+# SentinelClient
+
+::: pyredis.SentinelClient

docs/api/commands/connection.md

@@ -0,0 +1,3 @@
+# Connection Commands
+
+::: pyredis.commands.Connection

docs/api/commands/geo.md

@@ -0,0 +1,3 @@
+# Geo Commands
+
+::: pyredis.commands.Geo

docs/api/commands/hash.md

@@ -0,0 +1,3 @@
+# Hash Commands
+
+::: pyredis.commands.Hash

docs/api/commands/hyperloglog.md

@@ -0,0 +1,3 @@
+# HyperLogLog Commands
+
+::: pyredis.commands.HyperLogLog

docs/api/commands/key.md

@@ -0,0 +1,3 @@
+# Key Commands
+
+::: pyredis.commands.Key

docs/api/commands/list.md

@@ -0,0 +1,3 @@
+# List Commands
+
+::: pyredis.commands.List

docs/api/commands/publish.md

@@ -0,0 +1,3 @@
+# Publish Commands
+
+::: pyredis.commands.Publish

docs/api/commands/scripting.md

@@ -0,0 +1,3 @@
+# Scripting Commands
+
+::: pyredis.commands.Scripting

docs/api/commands/set.md

@@ -0,0 +1,3 @@
+# Set Commands
+
+::: pyredis.commands.Set

docs/api/commands/sset.md

@@ -0,0 +1,3 @@
+# SSet Commands
+
+::: pyredis.commands.SSet

docs/api/commands/string.md

@@ -0,0 +1,3 @@
+# String Commands
+
+::: pyredis.commands.String

docs/api/commands/subscribe.md

@@ -0,0 +1,3 @@
+# Subscribe Commands
+
+::: pyredis.commands.Subscribe

docs/api/commands/transaction.md

@@ -0,0 +1,3 @@
+# Transaction Commands
+
+::: pyredis.commands.Transaction

docs/api/connection/async_connection.md

@@ -0,0 +1,3 @@
+# AsyncConnection
+
+::: pyredis.connection.AsyncConnection

docs/api/connection/connection.md

@@ -0,0 +1,3 @@
+# Connection
+
+::: pyredis.connection.Connection

docs/api/pool/async_base_pool.md

@@ -0,0 +1,3 @@
+# AsyncBasePool
+
+::: pyredis.pool.AsyncBasePool

docs/api/pool/async_cluster_pool.md

@@ -0,0 +1,3 @@
+# AsyncClusterPool
+
+::: pyredis.AsyncClusterPool

docs/api/pool/async_hash_pool.md

@@ -0,0 +1,3 @@
+# AsyncHashPool
+
+::: pyredis.AsyncHashPool

docs/api/pool/async_pool.md

@@ -0,0 +1,3 @@
+# AsyncPool
+
+::: pyredis.AsyncPool

docs/api/pool/async_sentinel_hash_pool.md

@@ -0,0 +1,3 @@
+# AsyncSentinelHashPool
+
+::: pyredis.AsyncSentinelHashPool

docs/api/pool/async_sentinel_pool.md

@@ -0,0 +1,3 @@
+# AsyncSentinelPool
+
+::: pyredis.AsyncSentinelPool

docs/api/pool/base_pool.md

@@ -0,0 +1,3 @@
+# BasePool
+
+::: pyredis.pool.BasePool

docs/api/pool/cluster_pool.md

@@ -0,0 +1,3 @@
+# ClusterPool
+
+::: pyredis.ClusterPool

docs/api/pool/hash_pool.md

@@ -0,0 +1,3 @@
+# HashPool
+
+::: pyredis.HashPool

docs/api/pool/pool.md

@@ -0,0 +1,3 @@
+# Pool
+
+::: pyredis.Pool

docs/api/pool/sentinel_hash_pool.md

@@ -0,0 +1,3 @@
+# SentinelHashPool
+
+::: pyredis.SentinelHashPool

docs/api/pool/sentinel_pool.md

@@ -0,0 +1,3 @@
+# SentinelPool
+
+::: pyredis.SentinelPool

docs/example.md

@@ -140,3 +140,159 @@ client.publish('/blub', 'test')
 subscribe.get()
 [b'message', b'/blub', b'test']
 ```
+
+## Asynchronous Client and Pool Usage
+
+### Simple Async Client Usage
+
+```python
+import asyncio
+from pyredis import AsyncClient
+
+async def main():
+    client = AsyncClient(host="localhost")
+    await client.ping()
+    await client.close()
+
+asyncio.run(main())
+```
+
+### Async Bulk Mode
+
+```python
+import asyncio
+from pyredis import AsyncClient
+
+async def main():
+    client = AsyncClient(host="localhost")
+    await client.bulk_start()
+    await client.set("key1", "value1")
+    await client.set("key2", "value2")
+    await client.set("key3", "value3")
+    results = await client.bulk_stop()
+    print(results)
+    await client.close()
+
+asyncio.run(main())
+```
+
+### Using an Async Connection Pool
+
+```python
+import asyncio
+from pyredis import AsyncPool
+
+async def main():
+    pool = AsyncPool(host="localhost")
+    client = await pool.acquire()
+    await client.ping()
+    await pool.release(client)
+
+asyncio.run(main())
+```
+
+### Using an Async Cluster Connection Pool
+
+```python
+import asyncio
+from pyredis import AsyncClusterPool
+
+async def main():
+    pool = AsyncClusterPool(
+        seeds=[
+            ("seed1", 6379),
+            ("seed2", 6379)
+        ]
+    )
+    client = await pool.acquire()
+    await client.ping(shard_key="test")
+    await pool.release(client)
+
+asyncio.run(main())
+```
+
+### Using an Async Hash Connection Pool
+
+```python
+import asyncio
+from pyredis import AsyncHashPool
+
+async def main():
+    pool = AsyncHashPool(
+        buckets=[
+            ("host1", 6379),
+            ("host2", 6379)
+        ]
+    )
+    client = await pool.acquire()
+    await client.ping(shard_key="test")
+    await pool.release(client)
+
+asyncio.run(main())
+```
+
+### Using an Async Sentinel backed Connection Pool
+
+```python
+import asyncio
+from pyredis import AsyncSentinelPool
+
+async def main():
+    pool = AsyncSentinelPool(
+        sentinels=[
+            ("sentinel1", 26379),
+            ("sentinel2", 26379)
+        ],
+        name="mymaster"
+    )
+    client = await pool.acquire()
+    await client.ping()
+    await pool.release(client)
+
+asyncio.run(main())
+```
+
+### Getting Async Pools/Clients by URL
+
+```python
+from pyredis import get_by_url
+
+pool = get_by_url(
+    url="redis://localhost?password=topsecret",
+    async_client=True
+)
+
+pubsub = get_by_url(
+    url="pubsub://localhost?password=topsecret",
+    async_client=True
+)
+```
+
+### Async Publish Subscribe
+
+```python
+import asyncio
+from pyredis import AsyncClient
+from pyredis import AsyncPubSubClient
+
+async def main():
+    client = AsyncClient(host="localhost")
+    subscribe = AsyncPubSubClient(host="localhost")
+
+    await subscribe.subscribe("/blub")
+    res1 = await subscribe.get()
+    print(res1)
+
+    await client.publish(
+        "/blub",
+        "test"
+    )
+    res2 = await subscribe.get()
+    print(res2)
+
+    await client.close()
+    await subscribe.close()
+
+asyncio.run(main())
+```
+