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
|
import inspect
import queue
import sys
import time
import uuid
import warnings
from typing import Tuple, Any, List, Optional, Set
from ._server import FakeBaseConnectionMixin, FakeServer, VersionType, ServerType
if sys.version_info >= (3, 11):
from typing import Self
else:
from typing_extensions import Self
import redis
from fakeredis._fakesocket import FakeSocket
from fakeredis._helpers import FakeSelector
from . import _msgs as msgs
class FakeConnection(FakeBaseConnectionMixin, redis.Connection):
def connect(self) -> None:
super().connect()
# The selector is set in redis.Connection.connect() after _connect() is called
self._selector: Optional[FakeSelector] = FakeSelector(self._sock)
def _connect(self) -> FakeSocket:
if not self._server.connected:
raise redis.ConnectionError(msgs.CONNECTION_ERROR_MSG)
return FakeSocket(
self._server,
db=self.db,
lua_modules=self._lua_modules,
client_info=dict(
id=3,
addr="127.0.0.1:57275",
laddr="127.0.0.1:6379",
fd=8,
name="",
_created=int(time.time()),
idle=0,
flags="N",
db=0,
sub=0,
psub=0,
ssub=0,
multi=-1,
qbuf=48,
qbuf_free=16842,
argv_mem=25,
multi_mem=0,
rbs=1024,
rbp=0,
obl=0,
oll=0,
omem=0,
tot_mem=18737,
events="r",
cmd="auth",
user="default",
redir=-1,
resp=2,
),
)
def can_read(self, timeout: Optional[float] = 0) -> bool:
if not self._server.connected:
return True
if not self._sock:
self.connect()
# We use check_can_read rather than can_read, because on redis-py<3.2,
# FakeSelector inherits from a stub BaseSelector which doesn't
# implement can_read. Normally can_read provides retries on EINTR,
# but that's not necessary for the implementation of
# FakeSelector.check_can_read.
return self._selector is not None and self._selector.check_can_read(timeout)
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
def read_response(self, **kwargs: Any) -> Any: # type: ignore
if not self._sock:
raise redis.ConnectionError(msgs.CONNECTION_ERROR_MSG)
if not self._server.connected:
try:
response = self._sock.responses.get_nowait()
except queue.Empty:
if kwargs.get("disconnect_on_error", True):
self.disconnect()
raise redis.ConnectionError(msgs.CONNECTION_ERROR_MSG)
else:
response = self._sock.responses.get()
if isinstance(response, (redis.ResponseError, redis.AuthenticationError)):
raise response
if kwargs.get("disable_decoding", False):
return response
else:
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 FakeRedisMixin:
def __init__(
self,
*args: Any,
server: Optional[FakeServer] = None,
version: VersionType = (7,),
server_type: ServerType = "redis",
lua_modules: Optional[Set[str]] = None,
**kwargs: Any,
) -> None:
# Interpret the positional and keyword arguments according to the
# version of redis in use.
parameters = list(inspect.signature(redis.Redis.__init__).parameters.values())[1:]
# Convert args => kwargs
kwargs.update({parameters[i].name: args[i] for i in range(len(args))})
kwargs.setdefault("host", uuid.uuid4().hex)
kwds = {
p.name: kwargs.get(p.name, p.default)
for ind, p in enumerate(parameters)
if p.default != inspect.Parameter.empty
}
kwds["server"] = server
if not kwds.get("connection_pool", None):
charset = kwds.get("charset", None)
errors = kwds.get("errors", None)
# Adapted from redis-py
if charset is not None:
warnings.warn(DeprecationWarning('"charset" is deprecated. Use "encoding" instead'))
kwds["encoding"] = charset
if errors is not None:
warnings.warn(DeprecationWarning('"errors" is deprecated. Use "encoding_errors" instead'))
kwds["encoding_errors"] = errors
conn_pool_args = {
"host",
"port",
"db",
"username",
"password",
"socket_timeout",
"encoding",
"encoding_errors",
"decode_responses",
"retry_on_timeout",
"max_connections",
"health_check_interval",
"client_name",
"connected",
"server",
}
connection_kwargs = {
"connection_class": FakeConnection,
"version": version,
"server_type": server_type,
"lua_modules": lua_modules,
}
connection_kwargs.update({arg: kwds[arg] for arg in conn_pool_args if arg in kwds})
kwds["connection_pool"] = redis.connection.ConnectionPool(**connection_kwargs) # type: ignore
kwds.pop("server", None)
kwds.pop("connected", None)
kwds.pop("version", None)
kwds.pop("server_type", None)
kwds.pop("lua_modules", None)
super().__init__(**kwds)
@classmethod
def from_url(cls, *args: Any, **kwargs: Any) -> Self:
kwargs.setdefault("version", "7.4")
kwargs.setdefault("server_type", "redis")
pool = redis.ConnectionPool.from_url(*args, **kwargs)
# Now override how it creates connections
pool.connection_class = FakeConnection
return cls(connection_pool=pool, *args, **kwargs)
class FakeStrictRedis(FakeRedisMixin, redis.StrictRedis): # type: ignore
pass
class FakeRedis(FakeRedisMixin, redis.Redis): # type: ignore
pass
|