rename arg to address_remap and take and return an address tuple.

Author: kristjanvalur

redis/asyncio/cluster.py

@@ -252,7 +252,7 @@ def __init__(
         ssl_certfile: Optional[str] = None,
         ssl_check_hostname: bool = False,
         ssl_keyfile: Optional[str] = None,
-        host_port_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
+        address_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
     ) -> None:
         if db:
             raise RedisClusterException(
@@ -344,7 +344,7 @@ def __init__(
             startup_nodes,
             require_full_coverage,
             kwargs,
-            host_port_remap=host_port_remap,
+            address_remap=address_remap,
         )
         self.encoder = Encoder(encoding, encoding_errors, decode_responses)
         self.read_from_replicas = read_from_replicas
@@ -1067,20 +1067,20 @@ class NodesManager:
         "require_full_coverage",
         "slots_cache",
         "startup_nodes",
-        "host_port_remap",
+        "address_remap",
     )
 
     def __init__(
         self,
         startup_nodes: List["ClusterNode"],
         require_full_coverage: bool,
         connection_kwargs: Dict[str, Any],
-        host_port_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
+        address_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
     ) -> None:
         self.startup_nodes = {node.name: node for node in startup_nodes}
         self.require_full_coverage = require_full_coverage
         self.connection_kwargs = connection_kwargs
-        self.host_port_remap = host_port_remap
+        self.address_remap = address_remap
 
         self.default_node: "ClusterNode" = None
         self.nodes_cache: Dict[str, "ClusterNode"] = {}
@@ -1338,8 +1338,8 @@ def remap_host_port(self, host: str, port: int) -> Tuple[str, int]:
         internal value.  Useful if the client is not connecting directly
         to the cluster.
         """
-        if self.host_port_remap:
-            return self.host_port_remap(host, port)
+        if self.address_remap:
+            return self.address_remap((host, port))
         return host, port
 
 

redis/cluster.py

@@ -466,7 +466,7 @@ def __init__(
         read_from_replicas: bool = False,
         dynamic_startup_nodes: bool = True,
         url: Optional[str] = None,
-        host_port_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
+        address_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
         **kwargs,
     ):
         """
@@ -595,7 +595,7 @@ def __init__(
             from_url=from_url,
             require_full_coverage=require_full_coverage,
             dynamic_startup_nodes=dynamic_startup_nodes,
-            host_port_remap=host_port_remap,
+            address_remap=address_remap,
             **kwargs,
         )
 
@@ -1271,7 +1271,7 @@ def __init__(
         lock=None,
         dynamic_startup_nodes=True,
         connection_pool_class=ConnectionPool,
-        host_port_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
+        address_remap: Optional[Callable[[str, int], Tuple[str, int]]] = None,
         **kwargs,
     ):
         self.nodes_cache = {}
@@ -1283,7 +1283,7 @@ def __init__(
         self._require_full_coverage = require_full_coverage
         self._dynamic_startup_nodes = dynamic_startup_nodes
         self.connection_pool_class = connection_pool_class
-        self.host_port_remap = host_port_remap
+        self.address_remap = address_remap
         self._moved_exception = None
         self.connection_kwargs = kwargs
         self.read_load_balancer = LoadBalancer()
@@ -1603,8 +1603,8 @@ def remap_host_port(self, host: str, port: int) -> Tuple[str, int]:
         internal value.  Useful if the client is not connecting directly
         to the cluster.
         """
-        if self.host_port_remap:
-            return self.host_port_remap(host, port)
+        if self.address_remap:
+            return self.address_remap((host, port))
         return host, port
 
 

tests/test_asyncio/test_cluster.py

@@ -874,7 +874,7 @@ async def test_default_node_is_replaced_after_exception(self, r):
         # Rollback to the old default node
         r.replace_default_node(curr_default_node)
 
-    async def test_host_port_remap(self, create_redis, redis_addr):
+    async def test_address_remap(self, create_redis, redis_addr):
         """Test that we can create a rediscluster object with
         a host-port remapper and map connections through proxy objects
         """
@@ -884,9 +884,10 @@ async def test_host_port_remap(self, create_redis, redis_addr):
         n = 6
         ports = [redis_addr[1] + i for i in range(n)]
 
-        def host_port_remap(host, port):
+        def address_remap(address):
             # remap first three nodes to our local proxy
             # old = host, port
+            host, port = address
             if int(port) in ports:
                 host, port = "127.0.0.1", int(port) + offset
             # print(f"{old} {host, port}")
@@ -901,7 +902,7 @@ def host_port_remap(host, port):
         try:
             # create cluster:
             r = await create_redis(
-                cls=RedisCluster, flushdb=False, host_port_remap=host_port_remap
+                cls=RedisCluster, flushdb=False, address_remap=address_remap
             )
             try:
                 assert await r.ping() is True

tests/test_cluster.py

@@ -907,7 +907,7 @@ def raise_connection_error():
         assert "myself" not in nodes.get(curr_default_node.name).get("flags")
         assert r.get_default_node() != curr_default_node
 
-    def test_host_port_remap(self, request, redis_addr):
+    def test_address_remap(self, request, redis_addr):
         """Test that we can create a rediscluster object with
         a host-port remapper and map connections through proxy objects
         """
@@ -917,9 +917,10 @@ def test_host_port_remap(self, request, redis_addr):
         n = 6
         ports = [redis_addr[1] + i for i in range(n)]
 
-        def host_port_remap(host, port):
+        def address_remap(address):
             # remap first three nodes to our local proxy
             # old = host, port
+            host, port = address
             if int(port) in ports:
                 host, port = "127.0.0.1", int(port) + offset
             # print(f"{old} {host, port}")
@@ -935,7 +936,7 @@ def host_port_remap(host, port):
         try:
             # create cluster:
             r = _get_client(
-                RedisCluster, request, flushdb=False, host_port_remap=host_port_remap
+                RedisCluster, request, flushdb=False, address_remap=address_remap
             )
             try:
                 assert r.ping() is True