Deprecate older functions.

Author: kristjanvalur

redis/asyncio/client.py

@@ -64,6 +64,7 @@
 from redis.utils import (
     HIREDIS_AVAILABLE,
     _set_info_logger,
+    deprecated_function,
     get_lib_version,
     safe_str,
     str_if_bytes,
@@ -515,6 +516,7 @@ async def aclose(self, close_connection_pool: Optional[bool] = None) -> None:
         ):
             await self.connection_pool.disconnect()
 
+    @deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
     async def close(self, close_connection_pool: Optional[bool] = None) -> None:
         """
         Alias for aclose(), for backwards compatibility
@@ -751,10 +753,12 @@ async def aclose(self):
             self.patterns = {}
             self.pending_unsubscribe_patterns = set()
 
+    @deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
     async def close(self) -> None:
         """Alias for aclose(), for backwards compatibility"""
         await self.aclose()
 
+    @deprecated_function(version="5.0.0", reason="Use aclose() instead", name="reset")
     async def reset(self) -> None:
         """alias for aclose(), for backwards compatibility"""
         await self.aclose()

redis/asyncio/cluster.py

@@ -62,7 +62,13 @@
     TryAgainError,
 )
 from redis.typing import AnyKeyT, EncodableT, KeyT
-from redis.utils import dict_merge, get_lib_version, safe_str, str_if_bytes
+from redis.utils import (
+    deprecated_function,
+    dict_merge,
+    get_lib_version,
+    safe_str,
+    str_if_bytes,
+)
 
 TargetNodesT = TypeVar(
     "TargetNodesT", str, "ClusterNode", List["ClusterNode"], Dict[Any, "ClusterNode"]
@@ -411,6 +417,7 @@ async def aclose(self) -> None:
                     await self.nodes_manager.aclose()
                     await self.nodes_manager.aclose("startup_nodes")
 
+    @deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
     async def close(self) -> None:
         """alias for aclose() for backwards compatibility"""
         await self.aclose()

tests/test_asyncio/test_connection.py

@@ -319,6 +319,9 @@ async def mock_aclose(self):
         await r1.close()
         assert calls == 1
 
+    with pytest.deprecated_call():
+        await r1.close()
+
 
 @pytest.mark.parametrize("from_url", (True, False))
 async def test_pool_auto_close_disable(request, from_url):

tests/test_asyncio/test_pubsub.py

@@ -240,7 +240,8 @@ async def test_close_is_aclose(self, r: redis.Redis):
         assert p.subscribed is False
         await p.subscribe("foo")
         assert p.subscribed is True
-        await p.close()
+        with pytest.deprecated_call():
+            await p.close()
         assert p.subscribed is False
 
     async def test_reset_is_aclose(self, r: redis.Redis):
@@ -251,7 +252,8 @@ async def test_reset_is_aclose(self, r: redis.Redis):
         assert p.subscribed is False
         await p.subscribe("foo")
         assert p.subscribed is True
-        await p.reset()
+        with pytest.deprecated_call():
+            await p.reset()
         assert p.subscribed is False
 
     async def test_ignore_all_subscribe_messages(self, r: redis.Redis):