Adding support for non-decodable commands (#1731)

Author: chayim

redis/client.py

@@ -27,6 +27,9 @@
 SYM_EMPTY = b''
 EMPTY_RESPONSE = 'EMPTY_RESPONSE'
 
+# some responses (ie. dump) are binary, and just meant to never be decoded
+NEVER_DECODE = 'NEVER_DECODE'
+
 
 def timestamp_to_datetime(response):
     "Converts a unix timestamp to a Python datetime object"
@@ -1106,7 +1109,10 @@ def execute_command(self, *args, **options):
     def parse_response(self, connection, command_name, **options):
         "Parses a response from the Redis server"
         try:
-            response = connection.read_response()
+            if NEVER_DECODE in options:
+                response = connection.read_response(disable_decoding=True)
+            else:
+                response = connection.read_response()
         except ResponseError:
             if EMPTY_RESPONSE in options:
                 return options[EMPTY_RESPONSE]

redis/commands/core.py

@@ -1008,7 +1008,10 @@ def dump(self, name):
 
         For more information check https://redis.io/commands/dump
         """
-        return self.execute_command('DUMP', name)
+        from redis.client import NEVER_DECODE
+        options = {}
+        options[NEVER_DECODE] = []
+        return self.execute_command('DUMP', name, **options)
 
     def exists(self, *names):
         """

redis/connection.py

@@ -315,7 +315,7 @@ def on_disconnect(self):
     def can_read(self, timeout):
         return self._buffer and self._buffer.can_read(timeout)
 
-    def read_response(self):
+    def read_response(self, disable_decoding=False):
         raw = self._buffer.readline()
         if not raw:
             raise ConnectionError(SERVER_CLOSED_CONNECTION_ERROR)
@@ -355,8 +355,9 @@ def read_response(self):
             length = int(response)
             if length == -1:
                 return None
-            response = [self.read_response() for i in range(length)]
-        if isinstance(response, bytes):
+            response = [self.read_response(disable_decoding=disable_decoding)
+                        for i in range(length)]
+        if isinstance(response, bytes) and disable_decoding is False:
             response = self.encoder.decode(response)
         return response
 
@@ -450,7 +451,7 @@ def read_from_socket(self, timeout=SENTINEL, raise_on_timeout=True):
             if custom_timeout:
                 sock.settimeout(self._socket_timeout)
 
-    def read_response(self):
+    def read_response(self, disable_decoding=False):
         if not self._reader:
             raise ConnectionError(SERVER_CLOSED_CONNECTION_ERROR)
 
@@ -758,10 +759,12 @@ def can_read(self, timeout=0):
             self.connect()
         return self._parser.can_read(timeout)
 
-    def read_response(self):
+    def read_response(self, disable_decoding=False):
         """Read the response from a previously sent command"""
         try:
-            response = self._parser.read_response()
+            response = self._parser.read_response(
+                disable_decoding=disable_decoding
+            )
         except socket.timeout:
             self.disconnect()
             raise TimeoutError("Timeout reading from %s:%s" %

redis/sentinel.py

@@ -51,9 +51,9 @@ def connect(self):
                     continue
             raise SlaveNotFoundError  # Never be here
 
-    def read_response(self):
+    def read_response(self, disable_decoding=False):
         try:
-            return super().read_response()
+            return super().read_response(disable_decoding=disable_decoding)
         except ReadOnlyError:
             if self.connection_pool.is_master:
                 # When talking to a master, a ReadOnlyError when likely