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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
|
import hashlib
import pickle
import random
from typing import Tuple, Any, Callable, List, Optional
from fakeredis import _msgs as msgs
from fakeredis._command_args_parsing import extract_args
from fakeredis._commands import (
command,
Key,
Int,
DbIndex,
BeforeAny,
CommandItem,
SortFloat,
delete_keys,
)
from fakeredis._helpers import compile_pattern, SimpleError, OK, casematch, Database, SimpleString
from fakeredis.model import ZSet, Hash, ExpiringMembersSet
class GenericCommandsMixin:
_ttl: Callable[[CommandItem, float], int]
_scan: Callable[[CommandItem, int, bytes, bytes], Tuple[int, List[bytes]]]
_key_value_type: Callable[[CommandItem], SimpleString]
def __init__(self, *args: Any, **kwargs: Any) -> None:
super(GenericCommandsMixin, self).__init__(*args, **kwargs)
self.version: Tuple[int]
self._server: Any
self._db: Database
self._db_num: int
def _lookup_key(self, key: bytes, pattern: bytes) -> Optional[bytes]:
"""Python implementation of lookupKeyByPattern from redis"""
if pattern == b"#":
return key
p = pattern.find(b"*")
if p == -1:
return None
prefix = pattern[:p]
suffix = pattern[p + 1 :]
arrow = suffix.find(b"->", 0, -1)
if arrow != -1:
field = suffix[arrow + 2 :]
suffix = suffix[:arrow]
else:
field = None
new_key = prefix + key + suffix
item = CommandItem(new_key, self._db, item=self._db.get(new_key))
if item.value is None:
return None
if field is not None:
if not isinstance(item.value, Hash):
return None
return item.value.get(field) # type: ignore
else:
if not isinstance(item.value, bytes):
return None
return item.value
def _expireat(self, key: CommandItem, timestamp: float, *args: bytes) -> int:
(
(
nx,
xx,
gt,
lt,
),
_,
) = extract_args(
args,
(
"nx",
"xx",
"gt",
"lt",
),
exception=msgs.EXPIRE_UNSUPPORTED_OPTION,
)
if self.version < (7,) and any((nx, xx, gt, lt)):
raise SimpleError(msgs.WRONG_ARGS_MSG6.format("expire"))
counter = (nx, gt, lt).count(True)
if (counter > 1) or (nx and xx):
raise SimpleError(msgs.NX_XX_GT_LT_ERROR_MSG)
if (
not key
or (xx and key.expireat is None)
or (nx and key.expireat is not None)
or (gt and key.expireat is not None and timestamp < key.expireat)
or (lt and key.expireat is not None and timestamp > key.expireat)
):
return 0
key.expireat = timestamp
return 1
@command(name="DEL", fixed=(Key(),), repeat=(Key(),))
def del_(self, *keys: CommandItem):
return delete_keys(*keys)
@command(name="DUMP", fixed=(Key(missing_return=None),))
def dump(self, key: CommandItem) -> Optional[bytes]:
value = pickle.dumps(key.value)
checksum = hashlib.sha1(value).digest()
return checksum + value
@command(name="EXISTS", fixed=(Key(),), repeat=(Key(),))
def exists(self, *keys):
ret = 0
for key in keys:
if key:
ret += 1
return ret
@command(name="EXPIRE", fixed=(Key(), Int), repeat=(bytes,))
def expire(self, key: CommandItem, seconds: int, *args: bytes) -> int:
res = self._expireat(key, self._db.time + seconds, *args)
return res
@command(name="EXPIREAT", fixed=(Key(), Int))
def expireat(self, key: CommandItem, timestamp: int) -> int:
return self._expireat(key, float(timestamp))
@command(name="KEYS", fixed=(bytes,))
def keys(self, pattern: bytes) -> List[bytes]:
if pattern == b"*":
return list(self._db)
else:
regex = compile_pattern(pattern)
return [key for key in self._db if regex.match(key)]
@command(name="MOVE", fixed=(Key(), DbIndex))
def move(self, key: CommandItem, db: int) -> int:
if db == self._db_num:
raise SimpleError(msgs.SRC_DST_SAME_MSG)
if not key or key.key in self._server.dbs[db]:
return 0
# TODO: what is the interaction with expiry?
self._server.dbs[db][key.key] = self._server.dbs[self._db_num][key.key]
key.value = None # Causes deletion
return 1
@command(name="PERSIST", fixed=(Key(),))
def persist(self, key: CommandItem) -> int:
if key.expireat is None:
return 0
key.expireat = None
return 1
@command(name="PEXPIRE", fixed=(Key(), Int))
def pexpire(self, key: CommandItem, ms: int) -> int:
return self._expireat(key, self._db.time + ms / 1000.0)
@command(name="PEXPIREAT", fixed=(Key(), Int))
def pexpireat(self, key: CommandItem, ms_timestamp: int) -> int:
return self._expireat(key, ms_timestamp / 1000.0)
@command(name="PTTL", fixed=(Key(),))
def pttl(self, key: CommandItem) -> int:
return self._ttl(key, 1000.0)
@command(name="EXPIRETIME", fixed=(Key(),))
def expiretime(self, key: CommandItem) -> int:
if key.value is None:
return -2
if key.expireat is None:
return -1
return key.expireat
@command(name="PEXPIRETIME", fixed=(Key(),))
def pexpiretime(self, key: CommandItem) -> float:
if key.value is None:
return -2
if key.expireat is None:
return -1
return key.expireat * 1000
@command(name="RANDOMKEY", fixed=())
def randomkey(self):
keys = list(self._db.keys())
if not keys:
return None
return random.choice(keys)
@command(name="RENAME", fixed=(Key(), Key()))
def rename(self, key: CommandItem, newkey: CommandItem) -> SimpleString:
if not key:
raise SimpleError(msgs.NO_KEY_MSG)
# TODO: check interaction with WATCH
if newkey.key != key.key:
newkey.value = key.value
newkey.expireat = key.expireat
key.value = None
return OK
@command(name="RENAMENX", fixed=(Key(), Key()))
def renamenx(self, key: CommandItem, newkey: CommandItem) -> int:
if not key:
raise SimpleError(msgs.NO_KEY_MSG)
if newkey:
return 0
self.rename(key, newkey)
return 1
@command(name="RESTORE", fixed=(Key(), Int, bytes), repeat=(bytes,))
def restore(self, key: CommandItem, ttl: int, value: bytes, *args: bytes) -> str:
(replace,), _ = extract_args(args, ("replace",))
if key and not replace:
raise SimpleError(msgs.RESTORE_KEY_EXISTS)
checksum, value = value[:20], value[20:]
if hashlib.sha1(value).digest() != checksum:
raise SimpleError(msgs.RESTORE_INVALID_CHECKSUM_MSG)
if ttl < 0:
raise SimpleError(msgs.RESTORE_INVALID_TTL_MSG)
if ttl == 0:
expireat = None
else:
expireat = self._db.time + ttl / 1000.0
key.value = pickle.loads(value)
key.expireat = expireat
return OK
@command(name="SCAN", fixed=(Int,), repeat=(bytes, bytes))
def scan(self, cursor, *args):
return self._scan(list(self._db), cursor, *args)
@command(name="SORT", fixed=(Key(),), repeat=(bytes,))
def sort(self, key, *args):
if key.value is not None and not isinstance(key.value, (ExpiringMembersSet, list, ZSet)):
raise SimpleError(msgs.WRONGTYPE_MSG)
(
(
asc,
desc,
alpha,
store,
sortby,
(limit_start, limit_count),
),
left_args,
) = extract_args(
args,
("asc", "desc", "alpha", "*store", "*by", "++limit"),
error_on_unexpected=False,
left_from_first_unexpected=False,
)
limit_start = limit_start or 0
limit_count = -1 if limit_count is None else limit_count
dontsort = sortby is not None and b"*" not in sortby
i = 0
get = []
while i < len(left_args):
if casematch(left_args[i], b"get") and i + 1 < len(left_args):
get.append(left_args[i + 1])
i += 2
else:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
# TODO: force sorting if the object is a set and either in Lua or
# storing to a key, to match redis behaviour.
items = list(key.value) if key.value is not None else []
# These transformations are based on the redis implementation, but
# changed to produce a half-open range.
start = max(limit_start, 0)
end = len(items) if limit_count < 0 else start + limit_count
if start >= len(items):
start = end = len(items) - 1
end = min(end, len(items))
if not get:
get.append(b"#")
if sortby is None:
sortby = b"#"
if not dontsort:
def sort_key(val: bytes) -> bytes:
byval = self._lookup_key(val, sortby)
# TODO: use locale.strxfrm when not storing? But then need to decode too.
if byval is None:
byval = BeforeAny()
return byval
def sort_key_score(val: bytes) -> Tuple[float, bytes]:
byval = self._lookup_key(val, sortby)
score = SortFloat.decode(byval) if byval is not None else 0.0
return score, val
sort_func = sort_key if alpha else sort_key_score
items.sort(key=sort_func, reverse=desc)
elif isinstance(key.value, (list, ZSet)):
items.reverse()
out = []
for row in items[start:end]:
for g in get:
v = self._lookup_key(row, g)
if store is not None and v is None:
v = b""
out.append(v)
if store is not None:
item = CommandItem(store, self._db, item=self._db.get(store))
item.value = out
item.writeback()
return len(out)
else:
return out
@command(name="SORT_RO", fixed=(Key(),), repeat=(bytes,))
def sort_ro(self, key: CommandItem, *args: bytes) -> List[bytes]:
if key.value is not None and not isinstance(key.value, (set, list, ZSet)):
raise SimpleError(msgs.WRONGTYPE_MSG)
(
(
asc,
desc,
alpha,
sortby,
(limit_start, limit_count),
),
left_args,
) = extract_args(
args,
("asc", "desc", "alpha", "*by", "++limit"),
error_on_unexpected=False,
left_from_first_unexpected=False,
)
limit_start = limit_start or 0
limit_count = -1 if limit_count is None else limit_count
dontsort = sortby is not None and b"*" not in sortby
i = 0
get = []
while i < len(left_args):
if casematch(left_args[i], b"get") and i + 1 < len(left_args):
get.append(left_args[i + 1])
i += 2
else:
raise SimpleError(msgs.SYNTAX_ERROR_MSG)
# TODO: force sorting if the object is a set and either in Lua or
# storing to a key, to match redis behaviour.
items = list(key.value) if key.value is not None else []
# These transformations are based on the redis implementation, but
# changed to produce a half-open range.
start = max(limit_start, 0)
end = len(items) if limit_count < 0 else start + limit_count
if start >= len(items):
start = end = len(items) - 1
end = min(end, len(items))
if not get:
get.append(b"#")
if sortby is None:
sortby = b"#"
if not dontsort:
def sort_key(val: bytes) -> bytes:
byval = self._lookup_key(val, sortby)
# TODO: use locale.strxfrm when not storing? But then need to decode too.
if byval is None:
byval = BeforeAny()
return byval
def sort_key_score(val: bytes) -> Tuple[float, bytes]:
byval = self._lookup_key(val, sortby)
score = SortFloat.decode(byval) if byval is not None else 0.0
return score, val
sort_func = sort_key if alpha else sort_key_score
items.sort(key=sort_func, reverse=desc)
elif isinstance(key.value, (list, ZSet)):
items.reverse()
out: List[bytes] = []
for row in items[start:end]:
for g in get:
v = self._lookup_key(row, g)
out.append(v)
return out
@command(name="TTL", fixed=(Key(),))
def ttl(self, key: CommandItem) -> int:
return self._ttl(key, 1.0)
@command(name="TYPE", fixed=(Key(),))
def type_cmd(self, key: CommandItem) -> SimpleString:
return self._key_value_type(key)
@command(name="UNLINK", fixed=(Key(),), repeat=(Key(),))
def unlink(self, *keys: CommandItem) -> int:
return delete_keys(*keys)
|