3.3.0 - Replaced aioredis with redis-py 4.2.0 (breaks python<3.6), fixed some deprecation warnings

Author: kryogenic

CHANGELOG.md

@@ -1,3 +1,17 @@
+
+-----------------------------------------------------------------------------------------------------------------------
+
+3.3.0 - Updated for Python 3.9
+====================================================================================================================
+
+-----------------------------------------------------------------------------------------------------------------------
+
+Author: Kale (kryogenic)
+Date:   Thu Oct 10 11:16 AM 2024 +0000
+
+- **privex.helpers.cache**
+    - Replaced `aioredis` with redis 4.2.0 (breaks Python<3.6)
+
 -----------------------------------------------------------------------------------------------------------------------
 
 3.2.0 - Added MemcachedCache + privex.helpers.cache.extra, plus various other additions

Pipfile

@@ -14,24 +14,23 @@ semver = "*"
 Sphinx = ">=2.1.2"
 sphinx-autobuild = ">=0.7.1"
 restructuredtext-lint = ">=1.3.0"
-sphinx-rtd-theme = ">=0.4.3"
-docutils = ">=0.14"
+sphinx-rtd-theme = "==3.0.0rc4"
+docutils = "*"
 wheel = "*"
 setuptools = "*"
 mypy = "*"
 python-dotenv = "*"
 
 [packages]
 privex-loghelper = "*"
-redis = ">=3.3"
+redis = ">=4.2.0"
 cryptography = ">=2.8"
 dnspython = ">=1.16"
 Django = "*"
 MarkupSafe = ">=1.1.1"
 wheel = "*"
 python-dateutil = "*"
 sniffio = "*"
-aioredis = "*"
 async-property = "*"
 aiomcache = "*"
 hiredis = "*"

Pipfile.lock

@@ -2,8 +2,9 @@
 import pickle
 from typing import Any, Union, Optional
 
-from aioredis.commands import ContextRedis
+
 from async_property import async_property
+from redis.asyncio import Redis, ConnectionPool
 
 from privex.helpers.common import empty
 
@@ -16,7 +17,7 @@
 # if plugin.HAS_ASYNC_REDIS:
 from privex.helpers.plugin import get_redis_async, close_redis_async
 from privex.helpers.cache.asyncx.base import AsyncCacheAdapter
-import aioredis
+from redis import asyncio as aioredis
 import logging
 
 log = logging.getLogger(__name__)
@@ -85,8 +86,8 @@ class AsyncRedisCache(AsyncCacheAdapter):
     adapter_enter_reconnect: bool = True
     adapter_exit_close: bool = True
 
-    _redis_conn: Optional[Union[aioredis.Redis, aioredis.ConnectionsPool]]
-    _redis: Optional[ContextRedis]
+    _redis_conn: Optional[Union[aioredis.Redis, ConnectionPool]]
+    _redis: Optional[Redis]
 
     def __init__(self, use_pickle: bool = None, redis_instance: aioredis.Redis = None, *args, **kwargs):
         """
@@ -137,7 +138,10 @@ async def get(self, key: str, default: Any = None, fail: bool = False) -> Any:
     async def set(self, key: str, value: Any, timeout: Optional[int] = DEFAULT_CACHE_TIMEOUT):
         r: aioredis.Redis = await self.redis
         v = pickle.dumps(value) if self.use_pickle else value
-        return await r.set(str(key), v, expire=timeout)
+        if timeout:
+            return await r.setex(str(key), time=timeout, value=v)
+        else:
+            return await r.set(str(key), v)
 
     # async def get_or_set(self, key: str, value: VAL_FUNC_CORO, timeout: int = DEFAULT_CACHE_TIMEOUT) -> Any:
     #     return await self.get_or_set_async(key=key, value=value, timeout=timeout)
@@ -162,7 +166,7 @@ async def update_timeout(self, key: str, timeout: int = DEFAULT_CACHE_TIMEOUT) -
         await self.set(key=key, value=v, timeout=timeout)
         return v
 
-    async def connect(self, *args, **kwargs) -> ContextRedis:
+    async def connect(self, *args, **kwargs) -> Redis:
         if not self._redis_conn:
             self._redis_conn = await get_redis_async()
         if not self._redis:
@@ -172,10 +176,8 @@ async def connect(self, *args, **kwargs) -> ContextRedis:
     async def close(self):
         if self._redis is not None:
             log.debug("Closing AsyncIO Redis instance %s._redis", self.__class__.__name__)
-            self._redis.close()
+            await self._redis.aclose()
             self._redis = None
-        # Closing the Redis connection directly from this method usually leads to problems...
-        # It's safest to just set it to None and then call close_redis_async()
         if self._redis_conn is not None:
             log.debug("Clearing AsyncIO Redis connection pool %s._redis_conn", self.__class__.__name__)
             self._redis_conn = None

privex/helpers/cache/asyncx/AsyncRedisCache.py

@@ -1291,9 +1291,9 @@ def almost(compare: NumberStr, *numbers: NumberStr, tolerance: NumberStr = Decim
     return True
 
 
-IS_XARGS = re.compile('^\*([a-zA-Z0-9_])+$')
+IS_XARGS = re.compile(r'^\*([a-zA-Z0-9_])+$')
 """Pre-compiled regex for matching catch-all positional argument parameter names like ``*args``"""
-IS_XKWARGS = re.compile('^\*\*([a-zA-Z0-9_])+$')
+IS_XKWARGS = re.compile(r'^\*\*([a-zA-Z0-9_])+$')
 """Pre-compiled regex for matching catch-all keyword argument parameter names like ``**args``"""
 T_PARAM = inspect.Parameter
 """Type alias for :class:`inspect.Parameter`"""

privex/helpers/common.py

@@ -16,7 +16,7 @@
     from privex.helpers.extras.attrs import *
     HAS_ATTRS = True
     __all__ += ['AttribDictable']
-except ImportError:
+except (ImportError, ModuleNotFoundError):
     log.debug('privex.helpers.extras __init__ failed to import "attrs", not loading attrs library helpers')
 
 try:

privex/helpers/extras/__init__.py

@@ -255,14 +255,14 @@ def close_redis(thread_id=None, close_all=False) -> bool:
                     continue
                 log.debug("Closing redis for thread ID %s", t_id)
                 try:
-                    rd.close()
+                    rd.aclose()
                 except Exception:
                     log.exception("Exception while closing redis for thread ID %s", t_id)
             return clean_threadstore(name='redis', clean_all=True)
 
         rd: Union[str, redis.Redis] = _get_threadstore('redis', 'NOT_FOUND', thread_id=thread_id)
         if rd != 'NOT_FOUND':
-            rd.close()
+            rd.aclose()
             clean_threadstore(thread_id=thread_id, name='redis')
             return True
         return False
@@ -291,18 +291,14 @@ def configure_redis(host=settings.REDIS_HOST, port: int = settings.REDIS_PORT, d
               'Redis dependent helpers will be disabled. Exception: %s %s', type(e), str(e))
 
 try:
-    import aioredis
+    from redis import asyncio as aioredis
     HAS_ASYNC_REDIS = True
 
 
     async def connect_redis_async(**rd_config) -> aioredis.Redis:
         from privex.helpers.common import extract_settings
         cf = extract_settings('REDIS_', settings, merge_conf=dict(rd_config))
-        _addr = f"redis://{cf.pop('host', 'localhost')}:{cf.pop('port', 6379)}"
-        return await aioredis.create_redis_pool(
-            address=_addr, **cf
-        )
-
+        return await aioredis.Redis(host=cf.pop('host', 'localhost'), port=cf.pop('port', 6379), **cf)
 
     async def get_redis_async(new_connection=False, thread_id=None, **rd_config) -> aioredis.connection:
         """
@@ -342,8 +338,7 @@ async def close_redis_async(thread_id=None, close_all=False) -> bool:
                     continue
                 log.debug("Closing aioredis for thread ID %s", t_id)
                 try:
-                    rd.close()
-                    await rd.wait_closed()
+                    await rd.aclose()
                 except RuntimeError as err:
                     log.warning("[ignored] RuntimeError while closing aioredis (thread %s): %s - %s", thread_id, type(err), str(err))
                 except Exception:
@@ -353,8 +348,7 @@ async def close_redis_async(thread_id=None, close_all=False) -> bool:
         rd = _get_threadstore('aioredis', 'NOT_FOUND', thread_id=thread_id)
         if rd != 'NOT_FOUND':
             try:
-                rd.close()
-                await rd.wait_closed()
+                await rd.aclose()
             except RuntimeError as err:
                 log.warning("[ignored] RuntimeError while closing aioredis (thread %s): %s - %s", thread_id, type(err), str(err))
             clean_threadstore(thread_id=thread_id, name='aioredis')

privex/helpers/plugin.py

@@ -2,3 +2,6 @@
 filterwarnings =
     ignore:.*coroutine" decorator is deprecated:DeprecationWarning
     ignore:.*loop argument is deprecated:DeprecationWarning
+markers =
+    asyncio: asyncio mark
+asyncio_mode = auto

pytest.ini

@@ -4,8 +4,7 @@ python-dateutil
 sniffio
 
 # Extra [cache] - file: extras/cache.txt
-redis>=3.3
-aioredis>=1.3
+redis>=4.2.0rc1
 hiredis
 aiomcache>=0.6
 
@@ -39,6 +38,6 @@ semver
 Sphinx>=3.1.1
 sphinx-autobuild>=0.7.1
 restructuredtext-lint>=1.3.0
-sphinx-rtd-theme>=0.5.0
+sphinx-rtd-theme>=3.0.0rc4
 MarkupSafe>=1.1.1
 docutils>=0.14