fix

venv/lib/python3.11/site-packages/redis/commands/json/__init__.py

@@ -0,0 +1,147 @@
+from json import JSONDecodeError, JSONDecoder, JSONEncoder
+
+import redis
+
+from ..helpers import get_protocol_version, nativestr
+from .commands import JSONCommands
+from .decoders import bulk_of_jsons, decode_list
+
+
+class JSON(JSONCommands):
+    """
+    Create a client for talking to json.
+
+    :param decoder:
+    :type json.JSONDecoder: An instance of json.JSONDecoder
+
+    :param encoder:
+    :type json.JSONEncoder: An instance of json.JSONEncoder
+    """
+
+    def __init__(
+        self, client, version=None, decoder=JSONDecoder(), encoder=JSONEncoder()
+    ):
+        """
+        Create a client for talking to json.
+
+        :param decoder:
+        :type json.JSONDecoder: An instance of json.JSONDecoder
+
+        :param encoder:
+        :type json.JSONEncoder: An instance of json.JSONEncoder
+        """
+        # Set the module commands' callbacks
+        self._MODULE_CALLBACKS = {
+            "JSON.ARRPOP": self._decode,
+            "JSON.DEBUG": self._decode,
+            "JSON.GET": self._decode,
+            "JSON.MERGE": lambda r: r and nativestr(r) == "OK",
+            "JSON.MGET": bulk_of_jsons(self._decode),
+            "JSON.MSET": lambda r: r and nativestr(r) == "OK",
+            "JSON.RESP": self._decode,
+            "JSON.SET": lambda r: r and nativestr(r) == "OK",
+            "JSON.TOGGLE": self._decode,
+        }
+
+        _RESP2_MODULE_CALLBACKS = {
+            "JSON.ARRAPPEND": self._decode,
+            "JSON.ARRINDEX": self._decode,
+            "JSON.ARRINSERT": self._decode,
+            "JSON.ARRLEN": self._decode,
+            "JSON.ARRTRIM": self._decode,
+            "JSON.CLEAR": int,
+            "JSON.DEL": int,
+            "JSON.FORGET": int,
+            "JSON.GET": self._decode,
+            "JSON.NUMINCRBY": self._decode,
+            "JSON.NUMMULTBY": self._decode,
+            "JSON.OBJKEYS": self._decode,
+            "JSON.STRAPPEND": self._decode,
+            "JSON.OBJLEN": self._decode,
+            "JSON.STRLEN": self._decode,
+            "JSON.TOGGLE": self._decode,
+        }
+
+        _RESP3_MODULE_CALLBACKS = {}
+
+        self.client = client
+        self.execute_command = client.execute_command
+        self.MODULE_VERSION = version
+
+        if get_protocol_version(self.client) in ["3", 3]:
+            self._MODULE_CALLBACKS.update(_RESP3_MODULE_CALLBACKS)
+        else:
+            self._MODULE_CALLBACKS.update(_RESP2_MODULE_CALLBACKS)
+
+        for key, value in self._MODULE_CALLBACKS.items():
+            self.client.set_response_callback(key, value)
+
+        self.__encoder__ = encoder
+        self.__decoder__ = decoder
+
+    def _decode(self, obj):
+        """Get the decoder."""
+        if obj is None:
+            return obj
+
+        try:
+            x = self.__decoder__.decode(obj)
+            if x is None:
+                raise TypeError
+            return x
+        except TypeError:
+            try:
+                return self.__decoder__.decode(obj.decode())
+            except AttributeError:
+                return decode_list(obj)
+        except (AttributeError, JSONDecodeError):
+            return decode_list(obj)
+
+    def _encode(self, obj):
+        """Get the encoder."""
+        return self.__encoder__.encode(obj)
+
+    def pipeline(self, transaction=True, shard_hint=None):
+        """Creates a pipeline for the JSON module, that can be used for executing
+        JSON commands, as well as classic core commands.
+
+        Usage example:
+
+        r = redis.Redis()
+        pipe = r.json().pipeline()
+        pipe.jsonset('foo', '.', {'hello!': 'world'})
+        pipe.jsonget('foo')
+        pipe.jsonget('notakey')
+        """
+        if isinstance(self.client, redis.RedisCluster):
+            p = ClusterPipeline(
+                nodes_manager=self.client.nodes_manager,
+                commands_parser=self.client.commands_parser,
+                startup_nodes=self.client.nodes_manager.startup_nodes,
+                result_callbacks=self.client.result_callbacks,
+                cluster_response_callbacks=self.client.cluster_response_callbacks,
+                cluster_error_retry_attempts=self.client.cluster_error_retry_attempts,
+                read_from_replicas=self.client.read_from_replicas,
+                reinitialize_steps=self.client.reinitialize_steps,
+                lock=self.client._lock,
+            )
+
+        else:
+            p = Pipeline(
+                connection_pool=self.client.connection_pool,
+                response_callbacks=self._MODULE_CALLBACKS,
+                transaction=transaction,
+                shard_hint=shard_hint,
+            )
+
+        p._encode = self._encode
+        p._decode = self._decode
+        return p
+
+
+class ClusterPipeline(JSONCommands, redis.cluster.ClusterPipeline):
+    """Cluster pipeline for the module."""
+
+
+class Pipeline(JSONCommands, redis.client.Pipeline):
+    """Pipeline for the module."""

venv/lib/python3.11/site-packages/redis/commands/json/_util.py

@@ -0,0 +1,3 @@
+from typing import Any, Dict, List, Union
+
+JsonType = Union[str, int, float, bool, None, Dict[str, Any], List[Any]]

venv/lib/python3.11/site-packages/redis/commands/json/commands.py

@@ -0,0 +1,431 @@
+import os
+from json import JSONDecodeError, loads
+from typing import Dict, List, Optional, Tuple, Union
+
+from redis.exceptions import DataError
+from redis.utils import deprecated_function
+
+from ._util import JsonType
+from .decoders import decode_dict_keys
+from .path import Path
+
+
+class JSONCommands:
+    """json commands."""
+
+    def arrappend(
+        self, name: str, path: Optional[str] = Path.root_path(), *args: List[JsonType]
+    ) -> List[Union[int, None]]:
+        """Append the objects ``args`` to the array under the
+        ``path` in key ``name``.
+
+        For more information see `JSON.ARRAPPEND <https://redis.io/commands/json.arrappend>`_..
+        """  # noqa
+        pieces = [name, str(path)]
+        for o in args:
+            pieces.append(self._encode(o))
+        return self.execute_command("JSON.ARRAPPEND", *pieces)
+
+    def arrindex(
+        self,
+        name: str,
+        path: str,
+        scalar: int,
+        start: Optional[int] = None,
+        stop: Optional[int] = None,
+    ) -> List[Union[int, None]]:
+        """
+        Return the index of ``scalar`` in the JSON array under ``path`` at key
+        ``name``.
+
+        The search can be limited using the optional inclusive ``start``
+        and exclusive ``stop`` indices.
+
+        For more information see `JSON.ARRINDEX <https://redis.io/commands/json.arrindex>`_.
+        """  # noqa
+        pieces = [name, str(path), self._encode(scalar)]
+        if start is not None:
+            pieces.append(start)
+            if stop is not None:
+                pieces.append(stop)
+
+        return self.execute_command("JSON.ARRINDEX", *pieces, keys=[name])
+
+    def arrinsert(
+        self, name: str, path: str, index: int, *args: List[JsonType]
+    ) -> List[Union[int, None]]:
+        """Insert the objects ``args`` to the array at index ``index``
+        under the ``path` in key ``name``.
+
+        For more information see `JSON.ARRINSERT <https://redis.io/commands/json.arrinsert>`_.
+        """  # noqa
+        pieces = [name, str(path), index]
+        for o in args:
+            pieces.append(self._encode(o))
+        return self.execute_command("JSON.ARRINSERT", *pieces)
+
+    def arrlen(
+        self, name: str, path: Optional[str] = Path.root_path()
+    ) -> List[Union[int, None]]:
+        """Return the length of the array JSON value under ``path``
+        at key``name``.
+
+        For more information see `JSON.ARRLEN <https://redis.io/commands/json.arrlen>`_.
+        """  # noqa
+        return self.execute_command("JSON.ARRLEN", name, str(path), keys=[name])
+
+    def arrpop(
+        self,
+        name: str,
+        path: Optional[str] = Path.root_path(),
+        index: Optional[int] = -1,
+    ) -> List[Union[str, None]]:
+        """Pop the element at ``index`` in the array JSON value under
+        ``path`` at key ``name``.
+
+        For more information see `JSON.ARRPOP <https://redis.io/commands/json.arrpop>`_.
+        """  # noqa
+        return self.execute_command("JSON.ARRPOP", name, str(path), index)
+
+    def arrtrim(
+        self, name: str, path: str, start: int, stop: int
+    ) -> List[Union[int, None]]:
+        """Trim the array JSON value under ``path`` at key ``name`` to the
+        inclusive range given by ``start`` and ``stop``.
+
+        For more information see `JSON.ARRTRIM <https://redis.io/commands/json.arrtrim>`_.
+        """  # noqa
+        return self.execute_command("JSON.ARRTRIM", name, str(path), start, stop)
+
+    def type(self, name: str, path: Optional[str] = Path.root_path()) -> List[str]:
+        """Get the type of the JSON value under ``path`` from key ``name``.
+
+        For more information see `JSON.TYPE <https://redis.io/commands/json.type>`_.
+        """  # noqa
+        return self.execute_command("JSON.TYPE", name, str(path), keys=[name])
+
+    def resp(self, name: str, path: Optional[str] = Path.root_path()) -> List:
+        """Return the JSON value under ``path`` at key ``name``.
+
+        For more information see `JSON.RESP <https://redis.io/commands/json.resp>`_.
+        """  # noqa
+        return self.execute_command("JSON.RESP", name, str(path), keys=[name])
+
+    def objkeys(
+        self, name: str, path: Optional[str] = Path.root_path()
+    ) -> List[Union[List[str], None]]:
+        """Return the key names in the dictionary JSON value under ``path`` at
+        key ``name``.
+
+        For more information see `JSON.OBJKEYS <https://redis.io/commands/json.objkeys>`_.
+        """  # noqa
+        return self.execute_command("JSON.OBJKEYS", name, str(path), keys=[name])
+
+    def objlen(
+        self, name: str, path: Optional[str] = Path.root_path()
+    ) -> List[Optional[int]]:
+        """Return the length of the dictionary JSON value under ``path`` at key
+        ``name``.
+
+        For more information see `JSON.OBJLEN <https://redis.io/commands/json.objlen>`_.
+        """  # noqa
+        return self.execute_command("JSON.OBJLEN", name, str(path), keys=[name])
+
+    def numincrby(self, name: str, path: str, number: int) -> str:
+        """Increment the numeric (integer or floating point) JSON value under
+        ``path`` at key ``name`` by the provided ``number``.
+
+        For more information see `JSON.NUMINCRBY <https://redis.io/commands/json.numincrby>`_.
+        """  # noqa
+        return self.execute_command(
+            "JSON.NUMINCRBY", name, str(path), self._encode(number)
+        )
+
+    @deprecated_function(version="4.0.0", reason="deprecated since redisjson 1.0.0")
+    def nummultby(self, name: str, path: str, number: int) -> str:
+        """Multiply the numeric (integer or floating point) JSON value under
+        ``path`` at key ``name`` with the provided ``number``.
+
+        For more information see `JSON.NUMMULTBY <https://redis.io/commands/json.nummultby>`_.
+        """  # noqa
+        return self.execute_command(
+            "JSON.NUMMULTBY", name, str(path), self._encode(number)
+        )
+
+    def clear(self, name: str, path: Optional[str] = Path.root_path()) -> int:
+        """Empty arrays and objects (to have zero slots/keys without deleting the
+        array/object).
+
+        Return the count of cleared paths (ignoring non-array and non-objects
+        paths).
+
+        For more information see `JSON.CLEAR <https://redis.io/commands/json.clear>`_.
+        """  # noqa
+        return self.execute_command("JSON.CLEAR", name, str(path))
+
+    def delete(self, key: str, path: Optional[str] = Path.root_path()) -> int:
+        """Delete the JSON value stored at key ``key`` under ``path``.
+
+        For more information see `JSON.DEL <https://redis.io/commands/json.del>`_.
+        """
+        return self.execute_command("JSON.DEL", key, str(path))
+
+    # forget is an alias for delete
+    forget = delete
+
+    def get(
+        self, name: str, *args, no_escape: Optional[bool] = False
+    ) -> Optional[List[JsonType]]:
+        """
+        Get the object stored as a JSON value at key ``name``.
+
+        ``args`` is zero or more paths, and defaults to root path
+        ```no_escape`` is a boolean flag to add no_escape option to get
+        non-ascii characters
+
+        For more information see `JSON.GET <https://redis.io/commands/json.get>`_.
+        """  # noqa
+        pieces = [name]
+        if no_escape:
+            pieces.append("noescape")
+
+        if len(args) == 0:
+            pieces.append(Path.root_path())
+
+        else:
+            for p in args:
+                pieces.append(str(p))
+
+        # Handle case where key doesn't exist. The JSONDecoder would raise a
+        # TypeError exception since it can't decode None
+        try:
+            return self.execute_command("JSON.GET", *pieces, keys=[name])
+        except TypeError:
+            return None
+
+    def mget(self, keys: List[str], path: str) -> List[JsonType]:
+        """
+        Get the objects stored as a JSON values under ``path``. ``keys``
+        is a list of one or more keys.
+
+        For more information see `JSON.MGET <https://redis.io/commands/json.mget>`_.
+        """  # noqa
+        pieces = []
+        pieces += keys
+        pieces.append(str(path))
+        return self.execute_command("JSON.MGET", *pieces, keys=keys)
+
+    def set(
+        self,
+        name: str,
+        path: str,
+        obj: JsonType,
+        nx: Optional[bool] = False,
+        xx: Optional[bool] = False,
+        decode_keys: Optional[bool] = False,
+    ) -> Optional[str]:
+        """
+        Set the JSON value at key ``name`` under the ``path`` to ``obj``.
+
+        ``nx`` if set to True, set ``value`` only if it does not exist.
+        ``xx`` if set to True, set ``value`` only if it exists.
+        ``decode_keys`` If set to True, the keys of ``obj`` will be decoded
+        with utf-8.
+
+        For the purpose of using this within a pipeline, this command is also
+        aliased to JSON.SET.
+
+        For more information see `JSON.SET <https://redis.io/commands/json.set>`_.
+        """
+        if decode_keys:
+            obj = decode_dict_keys(obj)
+
+        pieces = [name, str(path), self._encode(obj)]
+
+        # Handle existential modifiers
+        if nx and xx:
+            raise Exception(
+                "nx and xx are mutually exclusive: use one, the "
+                "other or neither - but not both"
+            )
+        elif nx:
+            pieces.append("NX")
+        elif xx:
+            pieces.append("XX")
+        return self.execute_command("JSON.SET", *pieces)
+
+    def mset(self, triplets: List[Tuple[str, str, JsonType]]) -> Optional[str]:
+        """
+        Set the JSON value at key ``name`` under the ``path`` to ``obj``
+        for one or more keys.
+
+        ``triplets`` is a list of one or more triplets of key, path, value.
+
+        For the purpose of using this within a pipeline, this command is also
+        aliased to JSON.MSET.
+
+        For more information see `JSON.MSET <https://redis.io/commands/json.mset>`_.
+        """
+        pieces = []
+        for triplet in triplets:
+            pieces.extend([triplet[0], str(triplet[1]), self._encode(triplet[2])])
+        return self.execute_command("JSON.MSET", *pieces)
+
+    def merge(
+        self,
+        name: str,
+        path: str,
+        obj: JsonType,
+        decode_keys: Optional[bool] = False,
+    ) -> Optional[str]:
+        """
+        Merges a given JSON value into matching paths. Consequently, JSON values
+        at matching paths are updated, deleted, or expanded with new children
+
+        ``decode_keys`` If set to True, the keys of ``obj`` will be decoded
+        with utf-8.
+
+        For more information see `JSON.MERGE <https://redis.io/commands/json.merge>`_.
+        """
+        if decode_keys:
+            obj = decode_dict_keys(obj)
+
+        pieces = [name, str(path), self._encode(obj)]
+
+        return self.execute_command("JSON.MERGE", *pieces)
+
+    def set_file(
+        self,
+        name: str,
+        path: str,
+        file_name: str,
+        nx: Optional[bool] = False,
+        xx: Optional[bool] = False,
+        decode_keys: Optional[bool] = False,
+    ) -> Optional[str]:
+        """
+        Set the JSON value at key ``name`` under the ``path`` to the content
+        of the json file ``file_name``.
+
+        ``nx`` if set to True, set ``value`` only if it does not exist.
+        ``xx`` if set to True, set ``value`` only if it exists.
+        ``decode_keys`` If set to True, the keys of ``obj`` will be decoded
+        with utf-8.
+
+        """
+
+        with open(file_name) as fp:
+            file_content = loads(fp.read())
+
+        return self.set(name, path, file_content, nx=nx, xx=xx, decode_keys=decode_keys)
+
+    def set_path(
+        self,
+        json_path: str,
+        root_folder: str,
+        nx: Optional[bool] = False,
+        xx: Optional[bool] = False,
+        decode_keys: Optional[bool] = False,
+    ) -> Dict[str, bool]:
+        """
+        Iterate over ``root_folder`` and set each JSON file to a value
+        under ``json_path`` with the file name as the key.
+
+        ``nx`` if set to True, set ``value`` only if it does not exist.
+        ``xx`` if set to True, set ``value`` only if it exists.
+        ``decode_keys`` If set to True, the keys of ``obj`` will be decoded
+        with utf-8.
+
+        """
+        set_files_result = {}
+        for root, dirs, files in os.walk(root_folder):
+            for file in files:
+                file_path = os.path.join(root, file)
+                try:
+                    file_name = file_path.rsplit(".")[0]
+                    self.set_file(
+                        file_name,
+                        json_path,
+                        file_path,
+                        nx=nx,
+                        xx=xx,
+                        decode_keys=decode_keys,
+                    )
+                    set_files_result[file_path] = True
+                except JSONDecodeError:
+                    set_files_result[file_path] = False
+
+        return set_files_result
+
+    def strlen(self, name: str, path: Optional[str] = None) -> List[Union[int, None]]:
+        """Return the length of the string JSON value under ``path`` at key
+        ``name``.
+
+        For more information see `JSON.STRLEN <https://redis.io/commands/json.strlen>`_.
+        """  # noqa
+        pieces = [name]
+        if path is not None:
+            pieces.append(str(path))
+        return self.execute_command("JSON.STRLEN", *pieces, keys=[name])
+
+    def toggle(
+        self, name: str, path: Optional[str] = Path.root_path()
+    ) -> Union[bool, List[Optional[int]]]:
+        """Toggle boolean value under ``path`` at key ``name``.
+        returning the new value.
+
+        For more information see `JSON.TOGGLE <https://redis.io/commands/json.toggle>`_.
+        """  # noqa
+        return self.execute_command("JSON.TOGGLE", name, str(path))
+
+    def strappend(
+        self, name: str, value: str, path: Optional[str] = Path.root_path()
+    ) -> Union[int, List[Optional[int]]]:
+        """Append to the string JSON value. If two options are specified after
+        the key name, the path is determined to be the first. If a single
+        option is passed, then the root_path (i.e Path.root_path()) is used.
+
+        For more information see `JSON.STRAPPEND <https://redis.io/commands/json.strappend>`_.
+        """  # noqa
+        pieces = [name, str(path), self._encode(value)]
+        return self.execute_command("JSON.STRAPPEND", *pieces)
+
+    def debug(
+        self,
+        subcommand: str,
+        key: Optional[str] = None,
+        path: Optional[str] = Path.root_path(),
+    ) -> Union[int, List[str]]:
+        """Return the memory usage in bytes of a value under ``path`` from
+        key ``name``.
+
+        For more information see `JSON.DEBUG <https://redis.io/commands/json.debug>`_.
+        """  # noqa
+        valid_subcommands = ["MEMORY", "HELP"]
+        if subcommand not in valid_subcommands:
+            raise DataError("The only valid subcommands are ", str(valid_subcommands))
+        pieces = [subcommand]
+        if subcommand == "MEMORY":
+            if key is None:
+                raise DataError("No key specified")
+            pieces.append(key)
+            pieces.append(str(path))
+        return self.execute_command("JSON.DEBUG", *pieces)
+
+    @deprecated_function(
+        version="4.0.0", reason="redisjson-py supported this, call get directly."
+    )
+    def jsonget(self, *args, **kwargs):
+        return self.get(*args, **kwargs)
+
+    @deprecated_function(
+        version="4.0.0", reason="redisjson-py supported this, call get directly."
+    )
+    def jsonmget(self, *args, **kwargs):
+        return self.mget(*args, **kwargs)
+
+    @deprecated_function(
+        version="4.0.0", reason="redisjson-py supported this, call get directly."
+    )
+    def jsonset(self, *args, **kwargs):
+        return self.set(*args, **kwargs)

venv/lib/python3.11/site-packages/redis/commands/json/decoders.py

@@ -0,0 +1,60 @@
+import copy
+import re
+
+from ..helpers import nativestr
+
+
+def bulk_of_jsons(d):
+    """Replace serialized JSON values with objects in a
+    bulk array response (list).
+    """
+
+    def _f(b):
+        for index, item in enumerate(b):
+            if item is not None:
+                b[index] = d(item)
+        return b
+
+    return _f
+
+
+def decode_dict_keys(obj):
+    """Decode the keys of the given dictionary with utf-8."""
+    newobj = copy.copy(obj)
+    for k in obj.keys():
+        if isinstance(k, bytes):
+            newobj[k.decode("utf-8")] = newobj[k]
+            newobj.pop(k)
+    return newobj
+
+
+def unstring(obj):
+    """
+    Attempt to parse string to native integer formats.
+    One can't simply call int/float in a try/catch because there is a
+    semantic difference between (for example) 15.0 and 15.
+    """
+    floatreg = "^\\d+.\\d+$"
+    match = re.findall(floatreg, obj)
+    if match != []:
+        return float(match[0])
+
+    intreg = "^\\d+$"
+    match = re.findall(intreg, obj)
+    if match != []:
+        return int(match[0])
+    return obj
+
+
+def decode_list(b):
+    """
+    Given a non-deserializable object, make a best effort to
+    return a useful set of results.
+    """
+    if isinstance(b, list):
+        return [nativestr(obj) for obj in b]
+    elif isinstance(b, bytes):
+        return unstring(nativestr(b))
+    elif isinstance(b, str):
+        return unstring(b)
+    return b

venv/lib/python3.11/site-packages/redis/commands/json/path.py

@@ -0,0 +1,16 @@
+class Path:
+    """This class represents a path in a JSON value."""
+
+    strPath = ""
+
+    @staticmethod
+    def root_path():
+        """Return the root path's string representation."""
+        return "."
+
+    def __init__(self, path):
+        """Make a new path based on the string representation in `path`."""
+        self.strPath = path
+
+    def __repr__(self):
+        return self.strPath