Skip to content

Commit cfc99bd

Browse files
committed
Deprecate older functions.
1 parent fd2505a commit cfc99bd

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

redis/asyncio/client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
from redis.utils import (
6565
HIREDIS_AVAILABLE,
6666
_set_info_logger,
67+
deprecated_function,
6768
get_lib_version,
6869
safe_str,
6970
str_if_bytes,
@@ -515,6 +516,7 @@ async def aclose(self, close_connection_pool: Optional[bool] = None) -> None:
515516
):
516517
await self.connection_pool.disconnect()
517518

519+
@deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
518520
async def close(self, close_connection_pool: Optional[bool] = None) -> None:
519521
"""
520522
Alias for aclose(), for backwards compatibility
@@ -751,10 +753,12 @@ async def aclose(self):
751753
self.patterns = {}
752754
self.pending_unsubscribe_patterns = set()
753755

756+
@deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
754757
async def close(self) -> None:
755758
"""Alias for aclose(), for backwards compatibility"""
756759
await self.aclose()
757760

761+
@deprecated_function(version="5.0.0", reason="Use aclose() instead", name="reset")
758762
async def reset(self) -> None:
759763
"""alias for aclose(), for backwards compatibility"""
760764
await self.aclose()

redis/asyncio/cluster.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,13 @@
6262
TryAgainError,
6363
)
6464
from redis.typing import AnyKeyT, EncodableT, KeyT
65-
from redis.utils import dict_merge, get_lib_version, safe_str, str_if_bytes
65+
from redis.utils import (
66+
deprecated_function,
67+
dict_merge,
68+
get_lib_version,
69+
safe_str,
70+
str_if_bytes,
71+
)
6672

6773
TargetNodesT = TypeVar(
6874
"TargetNodesT", str, "ClusterNode", List["ClusterNode"], Dict[Any, "ClusterNode"]
@@ -411,6 +417,7 @@ async def aclose(self) -> None:
411417
await self.nodes_manager.aclose()
412418
await self.nodes_manager.aclose("startup_nodes")
413419

420+
@deprecated_function(version="5.0.0", reason="Use aclose() instead", name="close")
414421
async def close(self) -> None:
415422
"""alias for aclose() for backwards compatibility"""
416423
await self.aclose()

0 commit comments

Comments
 (0)