Normalize to using mock.mock everywhere instead of mixing and matching.

Author: akx

dev_requirements.txt

@@ -5,7 +5,7 @@ flake8-isort
 flake8
 flynt~=0.69.0
 invoke==2.2.0
-mock
+mock~=5.1.0
 packaging>=20.4
 pytest
 pytest-asyncio>=0.23.0,<0.24.0

tests/conftest.py

@@ -6,12 +6,11 @@
 from datetime import datetime, timezone
 from enum import Enum
 from typing import Callable, TypeVar, Union
-from unittest import mock
-from unittest.mock import Mock
 from urllib.parse import urlparse
 
 import pytest
 import redis
+from mock.mock import Mock, patch
 from packaging.version import Version
 from redis import Sentinel
 from redis.auth.idp import IdentityProviderInterface
@@ -510,7 +509,7 @@ def _gen_cluster_mock_resp(r, response):
     connection = Mock(spec=Connection)
     connection.retry = Retry(NoBackoff(), 0)
     connection.read_response.return_value = response
-    with mock.patch.object(r, "connection", connection):
+    with patch.object(r, "connection", connection):
         yield r
 
 

tests/test_asyncio/compat.py

@@ -1,11 +1,3 @@
-import asyncio
-from unittest import mock
-
-try:
-    mock.AsyncMock
-except AttributeError:
-    from unittest import mock
-
 try:
     from contextlib import aclosing
 except ImportError:
@@ -17,7 +9,3 @@ async def aclosing(thing):
             yield thing
         finally:
             await thing.aclose()
-
-
-def create_task(coroutine):
-    return asyncio.create_task(coroutine)

tests/test_asyncio/conftest.py

@@ -7,7 +7,7 @@
 import pytest
 import pytest_asyncio
 import redis.asyncio as redis
-from mock.mock import Mock
+from mock.mock import AsyncMock, Mock, patch
 from packaging.version import Version
 from redis.asyncio import Sentinel
 from redis.asyncio.client import Monitor
@@ -36,8 +36,6 @@
 )
 from tests.conftest import REDIS_INFO
 
-from .compat import mock
-
 
 class AuthType(Enum):
     MANAGED_IDENTITY = "managed_identity"
@@ -171,10 +169,10 @@ async def master(request, sentinel_setup):
 
 
 def _gen_cluster_mock_resp(r, response):
-    connection = mock.AsyncMock(spec=Connection)
+    connection = AsyncMock(spec=Connection)
     connection.retry = Retry(NoBackoff(), 0)
     connection.read_response.return_value = response
-    with mock.patch.object(r, "connection", connection):
+    with patch.object(r, "connection", connection):
         yield r
 
 

tests/test_asyncio/test_cluster.py

@@ -9,6 +9,7 @@
 import pytest
 import pytest_asyncio
 from _pytest.fixtures import FixtureRequest
+from mock import mock
 from redis._parsers import AsyncCommandsParser
 from redis.asyncio.cluster import ClusterNode, NodesManager, RedisCluster
 from redis.asyncio.connection import Connection, SSLConnection, async_timeout
@@ -38,7 +39,7 @@
 )
 
 from ..ssl_utils import get_tls_certificates
-from .compat import aclosing, mock
+from .compat import aclosing
 
 pytestmark = pytest.mark.onlycluster
 

tests/test_asyncio/test_connection.py

@@ -2,10 +2,10 @@
 import socket
 import types
 from errno import ECONNREFUSED
-from unittest.mock import patch
 
 import pytest
 import redis
+from mock import mock
 from redis._parsers import (
     _AsyncHiredisParser,
     _AsyncRESP2Parser,
@@ -25,7 +25,6 @@
 from redis.utils import HIREDIS_AVAILABLE
 from tests.conftest import skip_if_server_version_lt
 
-from .compat import mock
 from .mocks import MockStream
 
 
@@ -43,7 +42,7 @@ async def test_invalid_response(create_redis):
     else:
         exp_err = f'Protocol error, got "{raw.decode()}" as reply type byte'
 
-    with mock.patch.object(parser, "_stream", fake_stream):
+    with mock.mock.patch.object(parser, "_stream", fake_stream):
         with pytest.raises(InvalidResponse, match=exp_err):
             await parser.read_response()
 
@@ -86,8 +85,8 @@ async def get_conn():
         init_call_count += 1
         return mock_conn
 
-    with mock.patch.object(r.connection_pool, "get_connection", get_conn):
-        with mock.patch.object(r.connection_pool, "release"):
+    with mock.mock.patch.object(r.connection_pool, "get_connection", get_conn):
+        with mock.mock.patch.object(r.connection_pool, "release"):
             await asyncio.gather(r.set("a", "b"), r.set("c", "d"))
 
     assert init_call_count == 1
@@ -157,7 +156,7 @@ async def mock_connect():
 
 async def test_connect_without_retry_on_os_error():
     """Test that the _connect function is not being retried in case of a OSError"""
-    with patch.object(Connection, "_connect") as _connect:
+    with mock.patch.object(Connection, "_connect") as _connect:
         _connect.side_effect = OSError("")
         conn = Connection(retry_on_timeout=True, retry=Retry(NoBackoff(), 2))
         with pytest.raises(ConnectionError):
@@ -281,9 +280,9 @@ async def dummy_method(*args, **kwargs):
         pass
 
     # get dummy stream objects for the connection
-    with patch.object(asyncio, "open_connection", open_connection):
+    with mock.patch.object(asyncio, "open_connection", open_connection):
         # disable the initial version handshake
-        with patch.multiple(
+        with mock.patch.multiple(
             conn, send_command=dummy_method, read_response=dummy_method
         ):
             await conn.connect()
@@ -325,7 +324,7 @@ async def mock_aclose(self):
 
     url: str = request.config.getoption("--redis-url")
     r1 = await Redis.from_url(url)
-    with patch.object(r1, "aclose", mock_aclose):
+    with mock.patch.object(r1, "aclose", mock_aclose):
         with pytest.deprecated_call():
             await r1.close()
         assert calls == 1
@@ -382,7 +381,7 @@ async def mock_disconnect(_):
         nonlocal called
         called += 1
 
-    with patch.object(ConnectionPool, "disconnect", mock_disconnect):
+    with mock.patch.object(ConnectionPool, "disconnect", mock_disconnect):
         async with await get_redis_connection() as r1:
             assert r1.auto_close_connection_pool is False
 
@@ -414,7 +413,7 @@ async def mock_disconnect(_):
         nonlocal called
         called += 1
 
-    with patch.object(ConnectionPool, "disconnect", mock_disconnect):
+    with mock.patch.object(ConnectionPool, "disconnect", mock_disconnect):
         async with await get_redis_connection() as r1:
             assert r1.auto_close_connection_pool is True
 
@@ -441,7 +440,7 @@ async def mock_disconnect(_):
         nonlocal called
         called += 1
 
-    with patch.object(ConnectionPool, "disconnect", mock_disconnect):
+    with mock.patch.object(ConnectionPool, "disconnect", mock_disconnect):
         async with await get_redis_connection() as r1:
             assert r1.auto_close_connection_pool is False
 
@@ -461,7 +460,7 @@ async def test_client_garbage_collection(request):
     # create a client with a connection from the pool
     client = Redis(connection_pool=pool, single_connection_client=True)
     await client.initialize()
-    with mock.patch.object(client, "connection") as a:
+    with mock.mock.patch.object(client, "connection") as a:
         # we cannot, in unittests, or from asyncio, reliably trigger garbage collection
         # so we must just invoke the handler
         with pytest.warns(ResourceWarning):
@@ -486,8 +485,8 @@ async def test_connection_garbage_collection(request):
     await client.initialize()
     conn = client.connection
 
-    with mock.patch.object(conn, "_reader"):
-        with mock.patch.object(conn, "_writer") as a:
+    with mock.mock.patch.object(conn, "_reader"):
+        with mock.mock.patch.object(conn, "_writer") as a:
             # we cannot, in unittests, or from asyncio, reliably trigger
             # garbage collection so we must just invoke the handler
             with pytest.warns(ResourceWarning):

tests/test_asyncio/test_connection_pool.py

@@ -5,11 +5,12 @@
 import pytest
 import pytest_asyncio
 import redis.asyncio as redis
+from mock import mock
 from redis.asyncio.connection import Connection, to_bool
 from redis.auth.token import TokenInterface
 from tests.conftest import skip_if_redis_enterprise, skip_if_server_version_lt
 
-from .compat import aclosing, mock
+from .compat import aclosing
 from .test_pubsub import wait_for_message
 
 

tests/test_asyncio/test_pipeline.py

@@ -1,8 +1,9 @@
 import pytest
 import redis
+from mock.mock import patch
 from tests.conftest import skip_if_server_version_lt
 
-from .compat import aclosing, mock
+from .compat import aclosing
 from .conftest import wait_for_command
 
 
@@ -295,7 +296,7 @@ async def mock_reset():
                 nonlocal called
                 called += 1
 
-            with mock.patch.object(pipe, "reset", mock_reset):
+            with patch.object(pipe, "reset", mock_reset):
                 await pipe.aclose()
                 assert called == 1
 

tests/test_asyncio/test_pubsub.py

@@ -3,7 +3,8 @@
 import socket
 import sys
 from typing import Optional
-from unittest.mock import patch
+
+from mock.mock import patch
 
 # the functionality is available in 3.11.x but has a major issue before
 # 3.11.3. See https://github.com/redis/redis-py/issues/2633
@@ -20,7 +21,7 @@
 from redis.utils import HIREDIS_AVAILABLE
 from tests.conftest import get_protocol_version, skip_if_server_version_lt
 
-from .compat import aclosing, create_task, mock
+from .compat import aclosing
 
 
 def with_timeout(t):
@@ -733,7 +734,7 @@ async def loop_step():
                 await messages.put(message)
                 break
 
-        task = asyncio.get_running_loop().create_task(loop())
+        task = asyncio.create_task(loop())
         # get the initial connect message
         async with async_timeout(1):
             message = await messages.get()
@@ -782,7 +783,7 @@ def callback(message):
         messages = asyncio.Queue()
         p = pubsub
         await self._subscribe(p, foo=callback)
-        task = asyncio.get_running_loop().create_task(p.run())
+        task = asyncio.create_task(p.run())
         await r.publish("foo", "bar")
         message = await messages.get()
         task.cancel()
@@ -805,8 +806,8 @@ def exception_handler_callback(e, pubsub) -> None:
         exceptions = asyncio.Queue()
         p = pubsub
         await self._subscribe(p, foo=lambda x: None)
-        with mock.patch.object(p, "get_message", side_effect=Exception("error")):
-            task = asyncio.get_running_loop().create_task(
+        with patch.object(p, "get_message", side_effect=Exception("error")):
+            task = asyncio.create_task(
                 p.run(exception_handler=exception_handler_callback)
             )
             e = await exceptions.get()
@@ -823,7 +824,7 @@ def callback(message):
 
         messages = asyncio.Queue()
         p = pubsub
-        task = asyncio.get_running_loop().create_task(p.run())
+        task = asyncio.create_task(p.run())
         # wait until loop gets settled.  Add a subscription
         await asyncio.sleep(0.1)
         await p.subscribe(foo=callback)
@@ -867,7 +868,7 @@ async def mysetup(self, r, method):
         else:
             self.get_message = self.loop_step_listen
 
-        self.task = create_task(self.loop())
+        self.task = asyncio.create_task(self.loop())
         # get the initial connect message
         message = await self.messages.get()
         assert message == {
@@ -903,7 +904,7 @@ async def test_reconnect_socket_error(self, r: redis.Redis, method):
                 async with self.cond:
                     assert self.state == 0
                     self.state = 1
-                    with mock.patch.object(self.pubsub.connection, "_parser") as m:
+                    with patch.object(self.pubsub.connection, "_parser") as m:
                         m.read_response.side_effect = socket.error
                         m.can_read_destructive.side_effect = socket.error
                         # wait until task noticies the disconnect until we

tests/test_asyncio/test_sentinel.py

@@ -1,9 +1,9 @@
 import socket
-from unittest import mock
 
 import pytest
 import pytest_asyncio
 import redis.asyncio.sentinel
+from mock.mock import patch
 from redis import exceptions
 from redis.asyncio.sentinel import (
     MasterNotFoundError,
@@ -259,7 +259,7 @@ async def mock_disconnect():
         nonlocal calls
         calls += 1
 
-    with mock.patch.object(pool, "disconnect", mock_disconnect):
+    with patch.object(pool, "disconnect", mock_disconnect):
         await client.aclose()
 
     assert calls == 1