Refactor deprecated aioredis-py to redis-py

Author: rszamszur

template/pyproject.toml.jinja

@@ -23,7 +23,7 @@ uvicorn = {extras = ["standard"], version = "~0.20.0"}
 gunicorn = "~20.1.0"
 click = "~8.1.3"
 {%- if redis %}
-aioredis = "~2.0.1"
+redis = "~4.4.0"
 {%- endif %}
 {%- if aiohttp %}
 aiohttp = "~3.8.3"

template/tests/unit/app/utils/{% if redis %}test_redis.py{% endif %}.jinja

@@ -1,8 +1,7 @@
 from unittest import mock
 
 import pytest
-from aioredis import Redis
-from aioredis.exceptions import RedisError
+from redis import asyncio as aioredis
 from {{package_name}}.app.utils import RedisClient
 from {{package_name}}.config import redis as redis_conf
 
@@ -18,14 +17,14 @@ mock.MagicMock.__await__ = lambda x: async_magic().__await__()
 
 def test_open_redis_client():
     RedisClient.open_redis_client()
-    assert isinstance(RedisClient.redis_client, Redis)
+    assert isinstance(RedisClient.redis_client, aioredis.Redis)
     RedisClient.redis_client = None
 
     redis_conf.REDIS_USERNAME = "John"
     redis_conf.REDIS_PASSWORD = "Secret"
     redis_conf.REDIS_USE_SENTINEL = True
     RedisClient.open_redis_client()
-    assert isinstance(RedisClient.redis_client, Redis)
+    assert isinstance(RedisClient.redis_client, aioredis.Redis)
     RedisClient.redis_client = None
 
 
@@ -39,7 +38,7 @@ async def test_ping():
 @pytest.mark.asyncio
 async def test_ping_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.ping.side_effect = RedisError("Mock error")
+    RedisClient.redis_client.ping.side_effect = aioredis.RedisError("Mock error")
     assert await RedisClient.ping() is False
 
 
@@ -53,8 +52,8 @@ async def test_set():
 @pytest.mark.asyncio
 async def test_set_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.set.side_effect = RedisError("Mock error")
-    with pytest.raises(RedisError):
+    RedisClient.redis_client.set.side_effect = aioredis.RedisError("Mock error")
+    with pytest.raises(aioredis.RedisError):
         await RedisClient.set("key", "value")
 
 
@@ -68,8 +67,8 @@ async def test_rpush():
 @pytest.mark.asyncio
 async def test_rpush_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.rpush.side_effect = RedisError("Mock error")
-    with pytest.raises(RedisError):
+    RedisClient.redis_client.rpush.side_effect = aioredis.RedisError("Mock error")
+    with pytest.raises(aioredis.RedisError):
         await RedisClient.rpush("key", "value")
 
 
@@ -83,8 +82,8 @@ async def test_exists():
 @pytest.mark.asyncio
 async def test_exists_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.exists.side_effect = RedisError("Mock error")
-    with pytest.raises(RedisError):
+    RedisClient.redis_client.exists.side_effect = aioredis.RedisError("Mock error")
+    with pytest.raises(aioredis.RedisError):
         await RedisClient.exists("key")
 
 
@@ -98,8 +97,8 @@ async def test_get():
 @pytest.mark.asyncio
 async def test_get_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.get.side_effect = RedisError("Mock error")
-    with pytest.raises(RedisError):
+    RedisClient.redis_client.get.side_effect = aioredis.RedisError("Mock error")
+    with pytest.raises(aioredis.RedisError):
         await RedisClient.get("key")
 
 
@@ -113,6 +112,6 @@ async def test_lrange():
 @pytest.mark.asyncio
 async def test_lrange_exception():
     RedisClient.redis_client = mock.MagicMock()
-    RedisClient.redis_client.lrange.side_effect = RedisError("Mock error")
-    with pytest.raises(RedisError):
+    RedisClient.redis_client.lrange.side_effect = aioredis.RedisError("Mock error")
+    with pytest.raises(aioredis.RedisError):
         await RedisClient.lrange("key", 1, -1)

template/{{package_name}}/app/utils/{% if redis %}redis.py{% endif %}.jinja

@@ -1,9 +1,7 @@
 """Redis client class utility."""
 import logging
 
-import aioredis
-import aioredis.sentinel
-from aioredis.exceptions import RedisError
+from redis import asyncio as aioredis
 from {{package_name}}.config import redis as redis_conf
 
 
@@ -88,7 +86,7 @@ class RedisClient(object):
         cls.log.debug("Execute Redis PING command")
         try:
             return await redis_client.ping()
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis PING command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),
@@ -119,7 +117,7 @@ class RedisClient(object):
         cls.log.debug(f"Execute Redis SET command, key: {key}, value: {value}")
         try:
             await redis_client.set(key, value)
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis SET command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),
@@ -153,7 +151,7 @@ class RedisClient(object):
         )
         try:
             await redis_client.rpush(key, value)
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis RPUSH command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),
@@ -181,7 +179,7 @@ class RedisClient(object):
         cls.log.debug(f"Execute Redis EXISTS command, key: {key}")
         try:
             return await redis_client.exists(key)
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis EXISTS command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),
@@ -211,7 +209,7 @@ class RedisClient(object):
         cls.log.debug(f"Execute Redis GET command, key: {key}")
         try:
             return await redis_client.get(key)
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis GET command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),
@@ -248,7 +246,7 @@ class RedisClient(object):
         )
         try:
             return await redis_client.lrange(key, start, end)
-        except RedisError as ex:
+        except aioredis.RedisError as ex:
             cls.log.exception(
                 "Redis LRANGE command finished with exception",
                 exc_info=(type(ex), ex, ex.__traceback__),