Some PR fixes

Author: AvitalFineRedis

redisai/client.py

@@ -622,6 +622,7 @@ def scriptdel(self, key: AnyStr) -> str:
         res = self.execute_command(*args)
         return res if not self.enable_postprocess else processor.scriptdel(res)
 
+    @deprecated(version="1.2.0", reason="Use scriptexecute instead")
     def scriptrun(
         self,
         key: AnyStr,
@@ -642,7 +643,7 @@ def scriptrun(
             Tensor(s) which is already saved in the RedisAI using a tensorset call. These
             tensors will be used as the input for the modelrun
         outputs : Union[AnyStr, List[AnyStr]]
-            keys on which the outputs to be saved. If those keys exist already, modelrun
+            keys on which the outputs to be saved. If those keys exist already, scriptrun
             will overwrite them with new values
 
         Returns
@@ -662,37 +663,38 @@ def scriptrun(
     def scriptexecute(
         self,
         key: AnyStr,
-        function: AnyStr,
+        function: str,
         keys: Union[AnyStr, Sequence[AnyStr]],
-        inputs: Union[AnyStr, Sequence[AnyStr]] = None,
-        list_inputs: Sequence[Sequence[AnyStr]] = None,
+        inputs: Union[AnyStr, Sequence[Union[AnyStr, Sequence[AnyStr]]]] = None,
         outputs: Union[AnyStr, Sequence[AnyStr]] = None,
         timeout: int = None,
     ) -> str:
         """
-        Run an already set script. Similar to modelrun
+        Run an already set script. Similar to modelexecute
 
         Parameters
         ----------
         key : AnyStr
             Script key
-        function : AnyStr
+        function : str
             Name of the function in the ``script``
         keys : Union[AnyStr, Sequence[AnyStr]]
             Either a squence of key names that the script will access before, during and
             after its execution, or a tag which all those keys share.
-        inputs : Union[AnyStr, List[AnyStr]]
-            Tensor(s) which is already saved in the RedisAI using a tensorset call. These
-            tensors will be used as the input for the modelrun
-        list_inputs : Sequence[Sequence[AnyStr]]
-            list of inputs.
+        inputs : Union[AnyStr, Sequence[Union[AnyStr, Sequence[AnyStr]]]]
+            The inputs can be tensor key name, string , int or float.
+            These inputs will be used as the input for the scriptexecute function.
+            The order of the input should be aligned with the order of their respected
+            parameter at the function signature.
+            When one of the elements in the inputs list is a list (or a tuple), that element
+            will be treated as LIST_INPUTS in the command executaion.
         outputs : Union[AnyStr, List[AnyStr]]
-            keys on which the outputs to be saved. If those keys exist already, modelrun
-            will overwrite them with new values
+            keys on which the outputs to be saved. If those keys exist already, scriptexecute
+            will overwrite them with new values.
         timeout : int
             The max number on milisecinds that may pass before the request is prossced
             (meaning that the result will not be computed after that time and TIMEDOUT
-            is returned in that case)
+            is returned in that case).
 
         Returns
         -------
@@ -703,10 +705,15 @@ def scriptexecute(
         -------
         >>> con.scriptexecute('ket', 'bar', keys=['a', 'b', 'c'], inputs=['a', 'b'], outputs=['c'])
         'OK'
+        >>> con.scriptexecute('myscript{tag}', 'addn',
+        >>>                   keys=['{tag}'],
+        >>>                   inputs=['mytensor1{tag}', ['mytensor2{tag}', 'mytensor3{tag}']],
+        >>>                   outputs=['result{tag}'])
+        'OK'
         """
-        args = builder.scriptexecute(key, function, keys, inputs, list_inputs, outputs, timeout)
+        args = builder.scriptexecute(key, function, keys, inputs, outputs, timeout)
         res = self.execute_command(*args)
-        return res if not self.enable_postprocess else processor.scriptrun(res)
+        return res if not self.enable_postprocess else processor.scriptexecute(res)
 
     def scriptscan(self) -> List[List[AnyStr]]:
         """

redisai/command_builder.py

@@ -228,10 +228,12 @@ def scriptdel(name: AnyStr) -> Sequence:
 
 def scriptrun(
     name: AnyStr,
-    function: AnyStr,
+    function: str,
     inputs: Union[AnyStr, Sequence[AnyStr]],
     outputs: Union[AnyStr, Sequence[AnyStr]],
 ) -> Sequence:
+    if name is None or function is None:
+        raise ValueError("Missing required arguments for script run command")
     args = (
         "AI.SCRIPTRUN",
         name,
@@ -245,13 +247,14 @@ def scriptrun(
 
 def scriptexecute(
     name: AnyStr,
-    function: AnyStr,
+    function: str,
     keys: Union[AnyStr, Sequence[AnyStr]],
-    inputs: Union[AnyStr, Sequence[AnyStr]],
-    list_inputs: Sequence[Sequence[AnyStr]],
+    inputs: Union[AnyStr, Sequence[Union[AnyStr, Sequence[AnyStr]]]],
     outputs: Union[AnyStr, Sequence[AnyStr]],
     timeout: int,
 ) -> Sequence:
+    if name is None or function is None or keys is None:
+        raise ValueError("Missing required arguments for script execute command")
     args = [
         "AI.SCRIPTEXECUTE",
         name,
@@ -262,10 +265,20 @@ def scriptexecute(
     ]
 
     if inputs is not None:
-        args += ["INPUTS", len(utils.listify(inputs)), *utils.listify(inputs)]
-    if list_inputs is not None:
-        for li in list_inputs:
-            args += ["LIST_INPUTS", len(li), *li]
+        temp_inputs = []
+        if not isinstance(inputs, (list, tuple)):
+            args += ["INPUTS", 1, inputs]
+        else:
+            for elem in inputs:
+                if isinstance(elem, (list, tuple)):
+                    if temp_inputs:
+                        args += ["INPUTS", len(temp_inputs), *temp_inputs]
+                        temp_inputs = []
+                    args += ["LIST_INPUTS", len(utils.listify(elem)), *utils.listify(elem)]
+                else:
+                    temp_inputs.append(elem)
+            if temp_inputs:
+                args += ["INPUTS", len(temp_inputs), *temp_inputs]
     if outputs is not None:
         args += ["OUTPUTS", len(utils.listify(outputs)), *utils.listify(outputs)]
     if timeout is not None:

redisai/postprocessor.py

@@ -70,7 +70,7 @@ def infoget(res):
     "scriptset",
     "scriptdel",
     "scriptrun",
-    "scriptexecute"
+    "scriptexecute",
     "inforeset",
 )
 for fn in decoding_functions: