1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
|
from __future__ import annotations
import asyncio
import sys
import uuid
from typing import Union, Optional, Any, Callable, Iterable, Tuple, List, Set
from redis import ResponseError
from ._helpers import SimpleError
from ._server import FakeBaseConnectionMixin, VersionType
if sys.version_info >= (3, 11):
from asyncio import timeout as async_timeout
else:
from async_timeout import timeout as async_timeout
import redis.asyncio as redis_async # aioredis was integrated into redis in version 4.2.0 as redis.asyncio
from redis.asyncio.connection import DefaultParser
from . import _fakesocket
from . import _helpers
from . import _msgs as msgs
from . import _server
class AsyncFakeSocket(_fakesocket.FakeSocket):
_connection_error_class = redis_async.ConnectionError
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
self.responses: asyncio.Queue = asyncio.Queue() # type:ignore
def _decode_error(self, error: SimpleError) -> ResponseError:
parser = DefaultParser(1)
return parser.parse_error(error.value)
def put_response(self, msg: Any) -> None:
if not self.responses:
return
self.responses.put_nowait(msg)
async def _async_blocking(
self,
timeout: Optional[Union[float, int]],
func: Callable[[bool], Any],
event: asyncio.Event,
callback: Callable[[], None],
) -> None:
result = None
try:
async with async_timeout(timeout if timeout else None):
while True:
await event.wait()
event.clear()
# This is a coroutine outside the normal control flow that
# locks the server, so we have to take our own lock.
with self._server.lock:
ret = func(False)
if ret is not None:
result = self._decode_result(ret)
break
except asyncio.TimeoutError:
pass
finally:
with self._server.lock:
self._db.remove_change_callback(callback)
self.put_response(result)
self.resume()
def _blocking(
self,
timeout: Optional[Union[float, int]],
func: Callable[[bool], None],
) -> Any:
loop = asyncio.get_event_loop()
ret = func(True)
if ret is not None or self._in_transaction:
return ret
event = asyncio.Event()
def callback() -> None:
loop.call_soon_threadsafe(event.set)
self._db.add_change_callback(callback)
self.pause()
loop.create_task(self._async_blocking(timeout, func, event, callback))
return _helpers.NoResponse()
class FakeReader:
def __init__(self, socket: AsyncFakeSocket) -> None:
self._socket = socket
async def read(self, _: int) -> bytes:
return await self._socket.responses.get() # type:ignore
def at_eof(self) -> bool:
return self._socket.responses.empty() and not self._socket._server.connected
class FakeWriter:
def __init__(self, socket: AsyncFakeSocket) -> None:
self._socket: Optional[AsyncFakeSocket] = socket
def close(self) -> None:
self._socket = None
async def wait_closed(self) -> None:
pass
async def drain(self) -> None:
pass
def writelines(self, data: Iterable[Any]) -> None:
if self._socket is None:
return
for chunk in data:
self._socket.sendall(chunk) # type:ignore
class FakeConnection(FakeBaseConnectionMixin, redis_async.Connection):
async def _connect(self) -> None:
if not self._server.connected:
raise redis_async.ConnectionError(msgs.CONNECTION_ERROR_MSG)
self._sock: Optional[AsyncFakeSocket] = AsyncFakeSocket(self._server, self.db, lua_modules=self._lua_modules)
self._reader: Optional[FakeReader] = FakeReader(self._sock)
self._writer: Optional[FakeWriter] = FakeWriter(self._sock)
async def disconnect(self, nowait: bool = False, **kwargs: Any) -> None:
await super().disconnect(**kwargs)
self._sock = None
async def can_read(self, timeout: Optional[float] = 0) -> bool:
if not self.is_connected:
await self.connect()
if timeout == 0:
return self._sock is not None and not self._sock.responses.empty()
# asyncio.Queue doesn't have a way to wait for the queue to be
# non-empty without consuming an item, so kludge it with a sleep/poll
# loop.
loop = asyncio.get_event_loop()
start = loop.time()
while True:
if self._sock and not self._sock.responses.empty():
return True
await asyncio.sleep(0.01)
now = loop.time()
if timeout is not None and now > start + timeout:
return False
def _decode(self, response: Any) -> Any:
if isinstance(response, list):
return [self._decode(item) for item in response]
elif isinstance(response, bytes):
return self.encoder.decode(response)
else:
return response
async def read_response(self, **kwargs: Any) -> Any: # type: ignore
if not self._sock:
raise redis_async.ConnectionError(msgs.CONNECTION_ERROR_MSG)
if not self._server.connected:
try:
response = self._sock.responses.get_nowait()
except asyncio.QueueEmpty:
if kwargs.get("disconnect_on_error", True):
await self.disconnect()
raise redis_async.ConnectionError(msgs.CONNECTION_ERROR_MSG)
else:
timeout: Optional[float] = kwargs.pop("timeout", None)
can_read = await self.can_read(timeout)
response = await self._reader.read(0) if can_read and self._reader else None
if isinstance(response, redis_async.ResponseError):
raise response
if kwargs.get("disable_decoding", False):
return response
return self._decode(response)
def repr_pieces(self) -> List[Tuple[str, Any]]:
pieces = [("server", self._server), ("db", self.db)]
if self.client_name:
pieces.append(("client_name", self.client_name))
return pieces
def __str__(self) -> str:
return self.server_key
class FakeRedis(redis_async.Redis):
def __init__(
self,
*,
host: Optional[str] = None,
port: int = 6379,
db: Union[str, int] = 0,
password: Optional[str] = None,
socket_timeout: Optional[float] = None,
connection_pool: Optional[redis_async.ConnectionPool] = None,
encoding: str = "utf-8",
encoding_errors: str = "strict",
decode_responses: bool = False,
retry_on_timeout: bool = False,
max_connections: Optional[int] = None,
health_check_interval: int = 0,
client_name: Optional[str] = None,
username: Optional[str] = None,
server: Optional[_server.FakeServer] = None,
connected: bool = True,
version: VersionType = (7,),
server_type: str = "redis",
lua_modules: Optional[Set[str]] = None,
**kwargs: Any,
) -> None:
if not connection_pool:
# Adapted from aioredis
connection_kwargs = dict(
host=host or uuid.uuid4().hex,
port=port,
db=db,
# Ignoring because AUTH is not implemented
# 'username',
# 'password',
socket_timeout=socket_timeout,
encoding=encoding,
encoding_errors=encoding_errors,
decode_responses=decode_responses,
retry_on_timeout=retry_on_timeout,
health_check_interval=health_check_interval,
client_name=client_name,
server=server,
connected=connected,
connection_class=FakeConnection,
max_connections=max_connections,
version=version,
server_type=server_type,
lua_modules=lua_modules,
)
connection_pool = redis_async.ConnectionPool(**connection_kwargs) # type:ignore
kwargs.update(
dict(
db=db,
password=password,
socket_timeout=socket_timeout,
connection_pool=connection_pool,
encoding=encoding,
encoding_errors=encoding_errors,
decode_responses=decode_responses,
retry_on_timeout=retry_on_timeout,
max_connections=max_connections,
health_check_interval=health_check_interval,
client_name=client_name,
username=username,
)
)
super().__init__(**kwargs)
@classmethod
def from_url(cls, url: str, **kwargs: Any) -> redis_async.Redis:
self = super().from_url(url, **kwargs)
pool = self.connection_pool # Now override how it creates connections
pool.connection_class = FakeConnection
pool.connection_kwargs.setdefault("version", "7.4")
pool.connection_kwargs.setdefault("server_type", "redis")
pool.connection_kwargs.pop("username", None)
pool.connection_kwargs.pop("password", None)
return self
|