Best for a library to avoid logging deprecation warnings

Author: abrookins

redisvl/redis/connection.py

@@ -23,7 +23,7 @@
 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
+from redisvl.utils.utils import deprecated_argument, deprecated_function
 
 logger = get_logger(__name__)
 
@@ -500,6 +500,7 @@ def get_redis_connection(
         return client
 
     @staticmethod
+    @deprecated_argument("url", "redis_url")
     async def _get_aredis_connection(
         redis_url: Optional[str] = None,
         **kwargs,
@@ -528,11 +529,6 @@ async def _get_aredis_connection(
         _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"):
             client = RedisConnectionFactory._redis_sentinel_client(
@@ -563,6 +559,7 @@ async def _get_aredis_connection(
         return client
 
     @staticmethod
+    @deprecated_argument("url", "redis_url")
     def get_async_redis_connection(
         redis_url: Optional[str] = None,
         **kwargs,
@@ -591,10 +588,6 @@ def get_async_redis_connection(
         )
         _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

@@ -4,6 +4,7 @@
 import pytest
 
 from redisvl.redis.connection import RedisConnectionFactory
+from redisvl.utils.utils import assert_no_warnings
 
 
 class DummyAsyncClient:
@@ -15,68 +16,55 @@ async def echo(self, *args, **kwargs):
 
 
 @pytest.mark.asyncio
-async def test__get_aredis_connection_deprecates_url_kwarg_only(caplog):
+async def test__get_aredis_connection_deprecates_url_kwarg_only():
     # 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"
-        )
+        with pytest.warns(DeprecationWarning) as record:
+            await RedisConnectionFactory._get_aredis_connection(
+                url="redis://localhost:6379"
+            )
 
-    assert (
-        "The `url` parameter is deprecated. Please use `redis_url` instead."
-        in caplog.text
+    assert any(
+        str(w.message)
+        == (
+            "Argument url is deprecated and will be removed in the next major release. "
+            "Use redis_url instead."
+        )
+        for w in record
     )
 
 
 @pytest.mark.asyncio
-async def test__get_aredis_connection_no_deprecation_with_redis_url(caplog):
+async def test__get_aredis_connection_no_deprecation_with_redis_url():
     # 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
-    )
+        with assert_no_warnings():
+            await RedisConnectionFactory._get_aredis_connection(
+                redis_url="redis://localhost:6379"
+            )
 
 
-def test_get_async_redis_connection_deprecates_url_kwarg_only(caplog):
+def test_get_async_redis_connection_deprecates_url_kwarg_only():
     # 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):
+def test_get_async_redis_connection_no_deprecation_with_redis_url():
     # 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
-    )