redisjson support (#1636)

Author: chayim

docker-compose.yml

@@ -1 +1,3 @@
-FROM redis:6.2.5-buster
+FROM redis:6.2.6-buster
+
+CMD ["redis-server", "/redis.conf"]

docker/base/Dockerfile

@@ -0,0 +1,3 @@
+FROM redis:6.2.6-buster
+
+CMD ["redis-sentinel", "/sentinel.conf"]

docker/base/Dockerfile.sentinel

@@ -0,0 +1 @@
+Dockers in this folder are built, and uploaded to the redisfab dockerhub store.

docker/base/README.md

@@ -1,3 +1,2 @@
-bind master 127.0.0.1
 port 6379
 save ""

docker/master/Dockerfile

@@ -1,4 +1,3 @@
-bind replica 127.0.0.1
 port 6380
 save ""
 replicaof master 6379

docker/master/redis.conf

@@ -1,7 +1,6 @@
-bind sentinel_1 127.0.0.1
 port 26379
 
-sentinel monitor redis-py-test master 6379 2
+sentinel monitor redis-py-test 127.0.0.1 6379 2
 sentinel down-after-milliseconds redis-py-test 5000
 sentinel failover-timeout redis-py-test 60000
 sentinel parallel-syncs redis-py-test 1

docker/replica/Dockerfile

@@ -1,7 +1,6 @@
-bind sentinel_2 127.0.0.1
 port 26380
 
-sentinel monitor redis-py-test master 6379 2
+sentinel monitor redis-py-test 127.0.0.1 6379 2
 sentinel down-after-milliseconds redis-py-test 5000
 sentinel failover-timeout redis-py-test 60000
 sentinel parallel-syncs redis-py-test 1

docker/replica/redis.conf

@@ -1,7 +1,6 @@
-bind sentinel_3 127.0.0.1
 port 26381
 
-sentinel monitor redis-py-test master 6379 2
+sentinel monitor redis-py-test 127.0.0.1 6379 2
 sentinel down-after-milliseconds redis-py-test 5000
 sentinel failover-timeout redis-py-test 60000
 sentinel parallel-syncs redis-py-test 1

docker/sentinel_1/Dockerfile

@@ -6,10 +6,7 @@
 import threading
 import time
 import warnings
-from redis.commands import (
-    list_or_args,
-    Commands
-)
+from redis.commands import CoreCommands, RedisModuleCommands, list_or_args
 from redis.connection import (ConnectionPool, UnixDomainSocketConnection,
                               SSLConnection)
 from redis.lock import Lock
@@ -609,7 +606,7 @@ def parse_set_result(response, **options):
     return response and str_if_bytes(response) == 'OK'
 
 
-class Redis(Commands, object):
+class Redis(RedisModuleCommands, CoreCommands, object):
     """
     Implementation of the Redis protocol.
 
@@ -898,6 +895,47 @@ def set_response_callback(self, command, callback):
         "Set a custom Response Callback"
         self.response_callbacks[command] = callback
 
+    def load_external_module(self, modname, funcname, func):
+        """
+        This function can be used to add externally defined redis modules,
+        and their namespaces to the redis client.
+        modname - A string containing the name of the redis module to look for
+                  in the redis info block.
+        funcname - A string containing the name of the function to create
+        func - The function, being added to this class.
+
+        ex: Assume that one has a custom redis module named foomod that
+        creates command named 'foo.dothing' and 'foo.anotherthing' in redis.
+        To load function functions into this namespace:
+
+        from redis import Redis
+        from foomodule import F
+        r = Redis()
+        r.load_external_module("foomod", "foo", F)
+        r.foo().dothing('your', 'arguments')
+
+        For a concrete example see the reimport of the redisjson module in
+        tests/test_connection.py::test_loading_external_modules
+        """
+        mods = self.loaded_modules
+        if modname.lower() not in mods:
+            raise ModuleError("{} is not loaded in redis.".format(modname))
+        setattr(self, funcname, func)
+
+    @property
+    def loaded_modules(self):
+        key = '__redis_modules__'
+        mods = getattr(self, key, None)
+        if mods is not None:
+            return mods
+
+        try:
+            mods = [f.get('name').lower() for f in self.info().get('modules')]
+        except TypeError:
+            mods = []
+        setattr(self, key, mods)
+        return mods
+
     def pipeline(self, transaction=True, shard_hint=None):
         """
         Return a new pipeline object that can queue multiple commands for

docker/sentinel_1/sentinel.conf

@@ -0,0 +1,11 @@
+from .core import CoreCommands
+from .redismodules import RedisModuleCommands
+from .helpers import list_or_args
+from .sentinel import SentinelCommands
+
+__all__ = [
+    'CoreCommands',
+    'RedisModuleCommands',
+    'SentinelCommands',
+    'list_or_args'
+]

docker/sentinel_2/Dockerfile

@@ -3,6 +3,7 @@
 import warnings
 import hashlib
 
+from .helpers import list_or_args
 from redis.exceptions import (
     ConnectionError,
     DataError,
@@ -11,24 +12,7 @@
 )
 
 
-def list_or_args(keys, args):
-    # returns a single new list combining keys and args
-    try:
-        iter(keys)
-        # a string or bytes instance can be iterated, but indicates
-        # keys wasn't passed as a list
-        if isinstance(keys, (bytes, str)):
-            keys = [keys]
-        else:
-            keys = list(keys)
-    except TypeError:
-        keys = [keys]
-    if args:
-        keys.extend(args)
-    return keys
-
-
-class Commands:
+class CoreCommands:
     """
     A class containing all of the implemented redis commands. This class is
     to be used as a mixin.
@@ -1173,16 +1157,16 @@ def set(self, name, value,
         if ex is not None:
             pieces.append('EX')
             if isinstance(ex, datetime.timedelta):
-                ex = int(ex.total_seconds())
-            if isinstance(ex, int):
+                pieces.append(int(ex.total_seconds()))
+            elif isinstance(ex, int):
                 pieces.append(ex)
             else:
                 raise DataError("ex must be datetime.timedelta or int")
         if px is not None:
             pieces.append('PX')
             if isinstance(px, datetime.timedelta):
-                px = int(px.total_seconds() * 1000)
-            if isinstance(px, int):
+                pieces.append(int(px.total_seconds() * 1000))
+            elif isinstance(px, int):
                 pieces.append(px)
             else:
                 raise DataError("px must be datetime.timedelta or int")
@@ -3413,99 +3397,3 @@ def execute(self):
         command = self.command
         self.reset()
         return self.client.execute_command(*command)
-
-
-class SentinelCommands:
-    """
-    A class containing the commands specific to redis sentinal. This class is
-    to be used as a mixin.
-    """
-
-    def sentinel(self, *args):
-        "Redis Sentinel's SENTINEL command."
-        warnings.warn(
-            DeprecationWarning('Use the individual sentinel_* methods'))
-
-    def sentinel_get_master_addr_by_name(self, service_name):
-        "Returns a (host, port) pair for the given ``service_name``"
-        return self.execute_command('SENTINEL GET-MASTER-ADDR-BY-NAME',
-                                    service_name)
-
-    def sentinel_master(self, service_name):
-        "Returns a dictionary containing the specified masters state."
-        return self.execute_command('SENTINEL MASTER', service_name)
-
-    def sentinel_masters(self):
-        "Returns a list of dictionaries containing each master's state."
-        return self.execute_command('SENTINEL MASTERS')
-
-    def sentinel_monitor(self, name, ip, port, quorum):
-        "Add a new master to Sentinel to be monitored"
-        return self.execute_command('SENTINEL MONITOR', name, ip, port, quorum)
-
-    def sentinel_remove(self, name):
-        "Remove a master from Sentinel's monitoring"
-        return self.execute_command('SENTINEL REMOVE', name)
-
-    def sentinel_sentinels(self, service_name):
-        "Returns a list of sentinels for ``service_name``"
-        return self.execute_command('SENTINEL SENTINELS', service_name)
-
-    def sentinel_set(self, name, option, value):
-        "Set Sentinel monitoring parameters for a given master"
-        return self.execute_command('SENTINEL SET', name, option, value)
-
-    def sentinel_slaves(self, service_name):
-        "Returns a list of slaves for ``service_name``"
-        return self.execute_command('SENTINEL SLAVES', service_name)
-
-    def sentinel_reset(self, pattern):
-        """
-        This command will reset all the masters with matching name.
-        The pattern argument is a glob-style pattern.
-
-        The reset process clears any previous state in a master (including a
-        failover in progress), and removes every slave and sentinel already
-        discovered and associated with the master.
-        """
-        return self.execute_command('SENTINEL RESET', pattern, once=True)
-
-    def sentinel_failover(self, new_master_name):
-        """
-        Force a failover as if the master was not reachable, and without
-        asking for agreement to other Sentinels (however a new version of the
-        configuration will be published so that the other Sentinels will
-        update their configurations).
-        """
-        return self.execute_command('SENTINEL FAILOVER', new_master_name)
-
-    def sentinel_ckquorum(self, new_master_name):
-        """
-        Check if the current Sentinel configuration is able to reach the
-        quorum needed to failover a master, and the majority needed to
-        authorize the failover.
-
-        This command should be used in monitoring systems to check if a
-        Sentinel deployment is ok.
-        """
-        return self.execute_command('SENTINEL CKQUORUM',
-                                    new_master_name,
-                                    once=True)
-
-    def sentinel_flushconfig(self):
-        """
-        Force Sentinel to rewrite its configuration on disk, including the
-        current Sentinel state.
-
-        Normally Sentinel rewrites the configuration every time something
-        changes in its state (in the context of the subset of the state which
-        is persisted on disk across restart).
-        However sometimes it is possible that the configuration file is lost
-        because of operation errors, disk failures, package upgrade scripts or
-        configuration managers. In those cases a way to to force Sentinel to
-        rewrite the configuration file is handy.
-
-        This command works even if the previous configuration file is
-        completely missing.
-        """
-        return self.execute_command('SENTINEL FLUSHCONFIG')