Deprecate url in async Redis connection APIs in favor of redis_url; add tests; remove unused import in CLI

Author: abrookins

redisvl/cli/index.py

@@ -8,7 +8,6 @@
 from redisvl.redis.utils import convert_bytes, make_dict
 from redisvl.schema.schema import IndexSchema
 from redisvl.utils.log import get_logger
-from redisvl.utils.utils import lazy_import
 
 logger = get_logger("[RedisVL]")
 

redisvl/redis/connection.py

@@ -1,5 +1,4 @@
 import os
-from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union, overload
 from urllib.parse import parse_qs, urlencode, urlparse, urlunparse
 from warnings import warn
@@ -23,8 +22,11 @@
 )
 from redisvl.redis.utils import convert_bytes, is_cluster_url
 from redisvl.types import AsyncRedisClient, RedisClient, SyncRedisClient
+from redisvl.utils.log import get_logger
 from redisvl.utils.utils import deprecated_function
 
+logger = get_logger(__name__)
+
 
 def _strip_cluster_from_url_and_kwargs(
     url: str, **kwargs
@@ -499,7 +501,6 @@ def get_redis_connection(
 
     @staticmethod
     async def _get_aredis_connection(
-        url: Optional[str] = None,
         redis_url: Optional[str] = None,
         **kwargs,
     ) -> AsyncRedisClient:
@@ -509,9 +510,11 @@ async def _get_aredis_connection(
         only used internally by the library now.
 
         Args:
-            url (Optional[str]): The URL of the Redis server.
-            redis_url (Optional[str]): Alias for url for consistency with public APIs.
-                If neither is provided, the environment variable REDIS_URL is used.
+            redis_url (Optional[str]): The URL of the Redis server. If neither
+                `redis_url` nor `url` are provided, the environment variable
+                REDIS_URL is used.
+            url (Optional[str]): Former parameter for the URL of the Redis
+                server. Use `redis_url` instead. (Deprecated)
             **kwargs: Additional keyword arguments to be passed to the async
                 Redis client constructor.
 
@@ -522,7 +525,13 @@ async def _get_aredis_connection(
             ValueError: If url is not provided and REDIS_URL environment
                 variable is not set.
         """
-        url = url or redis_url or get_address_from_env()
+        _deprecated_url = kwargs.pop("url", None)
+        url = _deprecated_url or redis_url or get_address_from_env()
+
+        if _deprecated_url is not None:
+            logger.warning(
+                "The `url` parameter is deprecated. Please use `redis_url` instead."
+            )
 
         client: AsyncRedisClient
         if url.startswith("redis+sentinel"):
@@ -555,14 +564,17 @@ async def _get_aredis_connection(
 
     @staticmethod
     def get_async_redis_connection(
-        url: Optional[str] = None,
+        redis_url: Optional[str] = None,
         **kwargs,
     ) -> AsyncRedisClient:
         """Creates and returns an asynchronous Redis client.
 
         Args:
-            url (Optional[str]): The URL of the Redis server. If not provided,
-                the environment variable REDIS_URL is used.
+            redis_url (Optional[str]): The URL of the Redis server. If neither
+                `redis_url` nor `url` are provided, the environment variable
+                REDIS_URL is used.
+            url (Optional[str]): Former parameter for the URL of the Redis
+                server. Use `redis_url` instead. (Deprecated)
             **kwargs: Additional keyword arguments to be passed to the async
                 Redis client constructor.
 
@@ -577,7 +589,12 @@ def get_async_redis_connection(
             "get_async_redis_connection will become async in the next major release.",
             DeprecationWarning,
         )
-        url = url or get_address_from_env()
+        _deprecated_url = kwargs.pop("url", None)
+        url = _deprecated_url or redis_url or get_address_from_env()
+        if _deprecated_url is not None:
+            logger.warning(
+                "The `url` parameter is deprecated. Please use `redis_url` instead."
+            )
 
         if url.startswith("redis+sentinel"):
             return RedisConnectionFactory._redis_sentinel_client(

tests/unit/test_url_deprecation.py

@@ -0,0 +1,82 @@
+import logging
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+
+from redisvl.redis.connection import RedisConnectionFactory
+
+
+class DummyAsyncClient:
+    async def client_setinfo(self, *args, **kwargs):
+        return None
+
+    async def echo(self, *args, **kwargs):
+        return None
+
+
+@pytest.mark.asyncio
+async def test__get_aredis_connection_deprecates_url_kwarg_only(caplog):
+    # Patch AsyncRedis.from_url to avoid real network calls
+    with patch(
+        "redisvl.redis.connection.AsyncRedis.from_url", return_value=DummyAsyncClient()
+    ):
+        caplog.set_level(logging.WARNING, logger="redisvl.redis.connection")
+        await RedisConnectionFactory._get_aredis_connection(
+            url="redis://localhost:6379"
+        )
+
+    assert (
+        "The `url` parameter is deprecated. Please use `redis_url` instead."
+        in caplog.text
+    )
+
+
+@pytest.mark.asyncio
+async def test__get_aredis_connection_no_deprecation_with_redis_url(caplog):
+    # Patch AsyncRedis.from_url to avoid real network calls
+    with patch(
+        "redisvl.redis.connection.AsyncRedis.from_url", return_value=DummyAsyncClient()
+    ):
+        caplog.set_level(logging.WARNING, logger="redisvl.redis.connection")
+        await RedisConnectionFactory._get_aredis_connection(
+            redis_url="redis://localhost:6379"
+        )
+
+    assert (
+        "The `url` parameter is deprecated. Please use `redis_url` instead."
+        not in caplog.text
+    )
+
+
+def test_get_async_redis_connection_deprecates_url_kwarg_only(caplog):
+    # Patch AsyncRedis.from_url to avoid real network calls
+    with patch(
+        "redisvl.redis.connection.AsyncRedis.from_url", return_value=MagicMock()
+    ):
+        caplog.set_level(logging.WARNING, logger="redisvl.redis.connection")
+        with pytest.warns(DeprecationWarning):
+            RedisConnectionFactory.get_async_redis_connection(
+                url="redis://localhost:6379"
+            )
+
+    assert (
+        "The `url` parameter is deprecated. Please use `redis_url` instead."
+        in caplog.text
+    )
+
+
+def test_get_async_redis_connection_no_deprecation_with_redis_url(caplog):
+    # Patch AsyncRedis.from_url to avoid real network calls
+    with patch(
+        "redisvl.redis.connection.AsyncRedis.from_url", return_value=MagicMock()
+    ):
+        caplog.set_level(logging.WARNING, logger="redisvl.redis.connection")
+        with pytest.warns(DeprecationWarning):
+            RedisConnectionFactory.get_async_redis_connection(
+                redis_url="redis://localhost:6379"
+            )
+
+    assert (
+        "The `url` parameter is deprecated. Please use `redis_url` instead."
+        not in caplog.text
+    )