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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
|
"""Command mixin for emulating `redis-py`'s JSON functionality."""
import copy
import json
from json import JSONDecodeError
from typing import Any, Union, Dict, List, Optional, Callable, Tuple, Type
from jsonpath_ng import Root, JSONPath
from jsonpath_ng.exceptions import JsonPathParserError
from jsonpath_ng.ext import parse
from fakeredis import _helpers as helpers
from fakeredis import _msgs as msgs
from fakeredis._command_args_parsing import extract_args
from fakeredis._commands import Key, command, delete_keys, CommandItem, Int, Float
from fakeredis._helpers import SimpleString
from fakeredis.model import ZSet
JsonType = Union[str, int, float, bool, None, Dict[str, Any], List[Any]]
def _format_path(path: Union[bytes, str]) -> str:
path_str = path.decode() if isinstance(path, bytes) else path
if path_str == ".":
return "$"
elif path_str.startswith("."):
return "$" + path_str
elif path_str.startswith("$"):
return path_str
else:
return "$." + path_str
def _parse_jsonpath(path: Union[str, bytes]) -> JSONPath:
path_str: str = _format_path(path)
try:
return parse(path_str)
except JsonPathParserError:
raise helpers.SimpleError(msgs.JSON_PATH_DOES_NOT_EXIST.format(path_str))
def _path_is_root(path: JSONPath) -> bool:
return path == Root() # type: ignore
def _dict_deep_merge(source: JsonType, destination: Dict[str, Any]) -> Dict[str, Any]:
"""Deep merge of two dictionaries"""
if not isinstance(source, dict):
return destination
for key, value in source.items():
if value is None and key in destination:
del destination[key]
elif isinstance(value, dict):
node = destination.setdefault(key, {})
_dict_deep_merge(value, node)
else:
destination[key] = value
return destination
class JSONObject:
"""Argument converter for JSON objects."""
DECODE_ERROR = msgs.JSON_WRONG_REDIS_TYPE
ENCODE_ERROR = msgs.JSON_WRONG_REDIS_TYPE
@classmethod
def decode(cls, value: bytes) -> Any:
"""Deserialize the supplied bytes into a valid Python object."""
try:
return json.loads(value)
except JSONDecodeError:
raise helpers.SimpleError(cls.DECODE_ERROR)
@classmethod
def encode(cls, value: Any) -> Optional[bytes]:
"""Serialize the supplied Python object into a valid, JSON-formatted
byte-encoded string."""
return json.dumps(value, default=str).encode() if value is not None else None
def _json_write_iterate(
method: Callable[[JsonType], Tuple[Optional[JsonType], Optional[Any], bool]],
key: CommandItem,
path_str: Union[str, bytes],
**kwargs: Any,
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
"""Implement json.* write commands.
Iterate over values with path_str in key and running method to get new value for path item.
"""
if key.value is None:
raise helpers.SimpleError(msgs.JSON_KEY_NOT_FOUND)
path = _parse_jsonpath(path_str)
found_matches = path.find(key.value)
if len(found_matches) == 0:
raise helpers.SimpleError(msgs.JSON_PATH_NOT_FOUND_OR_NOT_STRING.format(path_str))
curr_value = copy.deepcopy(key.value)
res: List[Optional[JsonType]] = list()
for item in found_matches:
new_value, res_val, update = method(item.value)
if update:
curr_value = item.full_path.update(curr_value, new_value)
res.append(res_val)
key.update(curr_value)
if len(path_str) > 1 and path_str[0] == ord(b"."):
if kwargs.get("allow_result_none", False):
return res[-1]
else:
return next(x for x in reversed(res) if x is not None)
if len(res) == 1 and path_str[0] != ord(b"$"):
return res[0]
return res
def _json_read_iterate(
method: Callable[[JsonType], Optional[Any]],
key: CommandItem,
*args: Any,
error_on_zero_matches: bool = False,
) -> Union[List[Optional[Any]], Optional[Any]]:
path_str = args[0] if len(args) > 0 else "$"
if key.value is None:
if path_str[0] == 36:
raise helpers.SimpleError(msgs.JSON_KEY_NOT_FOUND)
else:
return None
path = _parse_jsonpath(path_str)
found_matches = path.find(key.value)
if error_on_zero_matches and len(found_matches) == 0 and path_str[0] != 36:
raise helpers.SimpleError(msgs.JSON_PATH_NOT_FOUND_OR_NOT_STRING.format(path_str))
res = list()
for item in found_matches:
res.append(method(item.value))
if path_str[0] == 46:
return res[0] if len(res) > 0 else None
if len(res) == 1 and (len(args) == 0 or (len(args) == 1 and args[0][0] == 46)):
return res[0]
return res
class JSONCommandsMixin:
"""`CommandsMixin` for enabling RedisJSON compatibility in `fakeredis`."""
TYPES_EMPTY_VAL_DICT: Dict[Type[object], Any] = {
dict: {},
int: 0,
float: 0.0,
list: [],
}
TYPE_NAMES: Dict[Type[object], bytes] = {
dict: b"object",
int: b"integer",
float: b"number",
bytes: b"string",
list: b"array",
set: b"set",
str: b"string",
bool: b"boolean",
type(None): b"null",
ZSet: b"zset",
}
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
self._db: helpers.Database
@staticmethod
def _get_single(
key: CommandItem,
path_str: Union[str, bytes],
always_return_list: bool = False,
empty_list_as_none: bool = False,
) -> Any:
path: JSONPath = _parse_jsonpath(path_str)
path_value = path.find(key.value)
val = [i.value for i in path_value]
if empty_list_as_none and len(val) == 0:
return None
elif len(val) == 1 and not always_return_list:
return val[0]
return val
@command(
name=["JSON.DEL", "JSON.FORGET"],
fixed=(Key(),),
repeat=(bytes,),
flags=msgs.FLAG_LEAVE_EMPTY_VAL,
)
def json_del(self, key: CommandItem, path_str: bytes) -> int:
if key.value is None:
return 0
path = _parse_jsonpath(path_str)
if _path_is_root(path):
delete_keys(key)
return 1
curr_value = copy.deepcopy(key.value)
found_matches = path.find(curr_value)
res = 0
while len(found_matches) > 0:
item = found_matches[0]
curr_value = item.full_path.filter(lambda _: True, curr_value)
res += 1
found_matches = path.find(curr_value)
key.update(curr_value)
return res
@staticmethod
def _json_set(key: CommandItem, path_str: bytes, value: JsonType, *args: Any) -> Optional[SimpleString]:
path = _parse_jsonpath(path_str)
if key.value is not None and (type(key.value) is not dict) and not _path_is_root(path):
raise helpers.SimpleError(msgs.JSON_WRONG_REDIS_TYPE)
old_value_list = path.find(key.value)
(nx, xx), _ = extract_args(args, ("nx", "xx"))
if xx and nx:
raise helpers.SimpleError(msgs.SYNTAX_ERROR_MSG)
old_value = old_value_list[0].value if len(old_value_list) > 0 else None
if (nx and old_value is not None) or (xx and old_value is None):
return None
new_value = path.update_or_create(key.value, value)
key.update(new_value)
return helpers.OK
@command(
name="JSON.SET",
fixed=(Key(), bytes, JSONObject),
repeat=(bytes,),
flags=msgs.FLAG_LEAVE_EMPTY_VAL + msgs.FLAG_DO_NOT_CREATE,
)
def json_set(self, key: CommandItem, path_str: bytes, value: JsonType, *args: bytes) -> Optional[SimpleString]:
"""Set the JSON value at key `name` under the `path` to `obj`.
For more information see `JSON.SET <https://redis.io/commands/json.set>`_.
"""
return JSONCommandsMixin._json_set(key, path_str, value, *args)
@command(name="JSON.GET", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_get(self, key: CommandItem, *args: bytes) -> Optional[bytes]:
if key.value is None:
return None
paths = [arg for arg in args if not helpers.casematch(b"noescape", arg)]
no_wrapping_array = len(paths) == 1 and paths[0][0] == ord(b".")
formatted_paths: List[str] = [_format_path(arg) for arg in args if not helpers.casematch(b"noescape", arg)]
path_values = [self._get_single(key, path, len(formatted_paths) > 1) for path in formatted_paths]
# Emulate the behavior of `redis-py`:
# - if only one path was supplied => return a single value
# - if more than one path was specified => return one value for each specified path
if no_wrapping_array or (len(path_values) == 1 and isinstance(path_values[0], list)):
return JSONObject.encode(path_values[0])
if len(path_values) == 1:
return JSONObject.encode(path_values)
return JSONObject.encode(dict(zip(formatted_paths, path_values)))
@command(name="JSON.MGET", fixed=(bytes,), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_mget(self, *args: bytes) -> List[Optional[bytes]]:
if len(args) < 2:
raise helpers.SimpleError(msgs.WRONG_ARGS_MSG6.format("json.mget"))
path_str = args[-1]
keys = [CommandItem(key, self._db, item=self._db.get(key), default=[]) for key in args[:-1]]
result = [JSONObject.encode(self._get_single(key, path_str, empty_list_as_none=True)) for key in keys]
return result
@command(name="JSON.TOGGLE", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_toggle(self, key: CommandItem, *args: bytes) -> Union[List[Optional[bool]], Optional[bool]]:
if key.value is None:
raise helpers.SimpleError(msgs.JSON_KEY_NOT_FOUND)
path_str = args[0] if len(args) > 0 else b"$"
path = _parse_jsonpath(path_str)
found_matches = path.find(key.value)
curr_value = copy.deepcopy(key.value)
res: List[Optional[bool]] = list()
for item in found_matches:
if type(item.value) is bool:
curr_value = item.full_path.update(curr_value, not item.value)
res.append(not item.value)
else:
res.append(None)
if all([x is None for x in res]):
raise helpers.SimpleError(msgs.JSON_KEY_NOT_FOUND)
key.update(curr_value)
if len(res) == 1 and (len(args) == 0 or (len(args) == 1 and args[0] == b".")):
return res[0]
return res
@command(name="JSON.CLEAR", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_clear(self, key: CommandItem, *args: bytes) -> int:
if key.value is None:
raise helpers.SimpleError(msgs.JSON_KEY_NOT_FOUND)
path_str: bytes = args[0] if len(args) > 0 else b"$"
path = _parse_jsonpath(path_str)
found_matches = path.find(key.value)
curr_value = copy.deepcopy(key.value)
res = 0
for item in found_matches:
new_val = self.TYPES_EMPTY_VAL_DICT.get(type(item.value), None)
if new_val is not None:
curr_value = item.full_path.update(curr_value, new_val)
res += 1
key.update(curr_value)
return res
@command(name="JSON.STRAPPEND", fixed=(Key(), bytes), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_strappend(
self, key: CommandItem, path_str: bytes, *args: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
if len(args) == 0:
raise helpers.SimpleError(msgs.WRONG_ARGS_MSG6.format("json.strappend"))
addition = JSONObject.decode(args[0])
def strappend(val: JsonType) -> Tuple[Optional[JsonType], Optional[int], bool]:
if type(val) is str:
new_value = val + addition
return new_value, len(new_value), True
else:
return None, None, False
return _json_write_iterate(strappend, key, path_str)
@command(name="JSON.ARRAPPEND", fixed=(Key(), bytes), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_arrappend(
self, key: CommandItem, path_str: bytes, *args: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
if len(args) == 0:
raise helpers.SimpleError(msgs.WRONG_ARGS_MSG6.format("json.arrappend"))
addition = [JSONObject.decode(item) for item in args]
def arrappend(val: JsonType) -> Tuple[Optional[JsonType], Optional[int], bool]:
if type(val) is list:
new_value = val + addition
return new_value, len(new_value), True
else:
return None, None, False
return _json_write_iterate(arrappend, key, path_str)
@command(name="JSON.ARRINSERT", fixed=(Key(), bytes, Int), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_arrinsert(
self, key: CommandItem, path_str: bytes, index: int, *args: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
if len(args) == 0:
raise helpers.SimpleError(msgs.WRONG_ARGS_MSG6.format("json.arrinsert"))
addition = [JSONObject.decode(item) for item in args]
def arrinsert(val: JsonType) -> Tuple[Optional[JsonType], Optional[int], bool]:
if type(val) is list:
new_value = val[:index] + addition + val[index:]
return new_value, len(new_value), True
else:
return None, None, False
return _json_write_iterate(arrinsert, key, path_str)
@command(name="JSON.ARRPOP", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_arrpop(self, key: CommandItem, *args: bytes) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
path_str: Union[bytes, str] = args[0] if len(args) > 0 else "$"
index = Int.decode(args[1]) if len(args) > 1 else -1
def arrpop(val: JsonType) -> Tuple[Optional[JsonType], Optional[bytes], bool]:
if type(val) is list and len(val) > 0:
ind = index if index < len(val) else -1
res = val.pop(ind)
return val, JSONObject.encode(res), True
else:
return None, None, False
return _json_write_iterate(arrpop, key, path_str, allow_result_none=True)
@command(name="JSON.ARRTRIM", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_arrtrim(self, key: CommandItem, *args: bytes) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
path_str: bytes = args[0] if len(args) > 0 else b"$"
start = Int.decode(args[1]) if len(args) > 1 else 0
stop = Int.decode(args[2]) if len(args) > 2 else None
def arrtrim(val: JsonType) -> Tuple[Optional[JsonType], Optional[int], bool]:
if type(val) is list:
start_ind = min(start, len(val))
stop_ind = len(val) if stop is None or stop == -1 else stop + 1
if stop_ind < 0:
stop_ind = len(val) + stop_ind + 1
new_val = val[start_ind:stop_ind]
return new_val, len(new_val), True
else:
return None, None, False
return _json_write_iterate(arrtrim, key, path_str)
@command(name="JSON.NUMINCRBY", fixed=(Key(), bytes, Float), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_numincrby(
self, key: CommandItem, path_str: bytes, inc_by: float, *_: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
def numincrby(val: Optional[JsonType]) -> Tuple[Optional[JsonType], Optional[float], bool]:
if val is not None and type(val) in {int, float}:
new_value = val + inc_by # type: ignore
return new_value, new_value, True
else:
return None, None, False
return _json_write_iterate(numincrby, key, path_str)
@command(name="JSON.NUMMULTBY", fixed=(Key(), bytes, Float), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_nummultby(
self, key: CommandItem, path_str: bytes, mult_by: float, *_: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
def nummultby(val: Optional[JsonType]) -> Tuple[Optional[JsonType], Optional[float], bool]:
if type(val) in {int, float}:
new_value = val * mult_by # type: ignore
return new_value, new_value, True
else:
return None, None, False
return _json_write_iterate(nummultby, key, path_str)
# Read operations
@command(name="JSON.ARRINDEX", fixed=(Key(), bytes, bytes), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_arrindex(
self, key: CommandItem, path_str: bytes, encoded_value: bytes, *args: bytes
) -> Union[List[Optional[JsonType]], Optional[JsonType]]:
start = max(0, Int.decode(args[0]) if len(args) > 0 else 0)
end = Int.decode(args[1]) if len(args) > 1 else -1
end = end if end > 0 else -1
expected_value = JSONObject.decode(encoded_value)
def check_index(value: JsonType) -> Optional[int]:
if type(value) is not list:
return None
try:
ind = next(
filter(
lambda x: x[1] == expected_value and type(x[1]) is type(expected_value),
enumerate(value[start:end]),
)
)
return ind[0] + start
except StopIteration:
return -1
return _json_read_iterate(check_index, key, path_str, *args, error_on_zero_matches=True)
@command(name="JSON.STRLEN", fixed=(Key(),), repeat=(bytes,))
def json_strlen(self, key: CommandItem, *args: bytes) -> Union[List[Optional[int]], Optional[int]]:
return _json_read_iterate(lambda val: len(val) if type(val) is str else None, key, *args)
@command(name="JSON.ARRLEN", fixed=(Key(),), repeat=(bytes,))
def json_arrlen(self, key: CommandItem, *args: bytes) -> Union[List[Optional[int]], Optional[int]]:
return _json_read_iterate(lambda val: len(val) if type(val) is list else None, key, *args)
@command(name="JSON.OBJLEN", fixed=(Key(),), repeat=(bytes,))
def json_objlen(self, key: CommandItem, *args: bytes) -> Union[List[Optional[int]], Optional[int]]:
return _json_read_iterate(lambda val: len(val) if type(val) is dict else None, key, *args)
@command(name="JSON.TYPE", fixed=(Key(),), repeat=(bytes,), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_type(self, key: CommandItem, *args: bytes) -> Union[List[Optional[bytes]], Optional[bytes]]:
return _json_read_iterate(lambda val: self.TYPE_NAMES.get(type(val), None), key, *args)
@command(name="JSON.OBJKEYS", fixed=(Key(),), repeat=(bytes,))
def json_objkeys(self, key: CommandItem, *args: bytes) -> Union[List[Optional[bytes]], Optional[bytes]]:
return _json_read_iterate(
lambda val: [i.encode() for i in val.keys()] if type(val) is dict else None, key, *args
)
@command(name="JSON.MSET", fixed=(), repeat=(Key(), bytes, JSONObject), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_mset(self, *args: Any) -> SimpleString:
if len(args) < 3 or len(args) % 3 != 0:
raise helpers.SimpleError(msgs.WRONG_ARGS_MSG6.format("json.mset"))
for i in range(0, len(args), 3):
key, path_str, value = args[i], args[i + 1], args[i + 2]
JSONCommandsMixin._json_set(key, path_str, value)
return helpers.OK
@command(name="JSON.MERGE", fixed=(Key(), bytes, JSONObject), repeat=(), flags=msgs.FLAG_LEAVE_EMPTY_VAL)
def json_merge(self, key: CommandItem, path_str: bytes, value: JsonType) -> SimpleString:
path: JSONPath = _parse_jsonpath(path_str)
if key.value is not None and (type(key.value) is not dict) and not _path_is_root(path):
raise helpers.SimpleError(msgs.JSON_WRONG_REDIS_TYPE)
matching = path.find(key.value)
for item in matching:
prev_value = item.value if item is not None else dict()
_dict_deep_merge(value, prev_value)
if len(matching) > 0:
key.updated()
return helpers.OK
|