update tests & docs & add invoke_script cluster mode variant

Signed-off-by: TJ Zhang <tj.zhang@improving.com>

Author: tjzhang-BQ

CHANGELOG.md

@@ -102,6 +102,7 @@
 * Node: Added XGROUP SETID command ([#2135]((https://github.com/valkey-io/valkey-glide/pull/2135))
 * Node: Added binary variant to string commands ([#2183](https://github.com/valkey-io/valkey-glide/pull/2183))
 * Node: Added binary variant to stream commands ([#2200](https://github.com/valkey-io/valkey-glide/pull/2200))
+* Python: Add Script commands ([#2208](https://github.com/valkey-io/valkey-glide/pull/2208))
 
 #### Breaking Changes
 * Node: (Refactor) Convert classes to types ([#2005](https://github.com/valkey-io/valkey-glide/pull/2005))

python/python/glide/async_commands/cluster_commands.py

@@ -25,7 +25,7 @@
 from glide.protobuf.command_request_pb2 import RequestType
 from glide.routes import Route
 
-from ..glide import ClusterScanCursor
+from ..glide import ClusterScanCursor, Script
 
 
 class ClusterCommands(CoreCommands):
@@ -1283,7 +1283,7 @@ async def script_exists(
 
         Args:
             sha1s (List[TEncodable]): List of SHA1 digests of the scripts to check.
-            route (Optional[Route]): The command will be routed automatically based on the passed command's default request policy, unless `route` is provided, in which
+            route (Optional[Route]): The command will be routed to all primaries, unless `route` is provided, in which
             case the client will route the command to the nodes defined by `route`. Defaults to None.
 
         Returns:
@@ -1308,8 +1308,8 @@ async def script_flush(
 
         Args:
             mode (Optional[FlushMode]): The flushing mode, could be either `SYNC` or `ASYNC`.
-            route (Optional[Route]): The command will be routed automatically based on the passed command's default request policy, unless `route` is provided, in which
-            case the client will route the command to the nodes defined by `route`. Defaults to None.
+            route (Optional[Route]): The command will be routed automatically to all nodes, unless `route` is provided, in which
+                case the client will route the command to the nodes defined by `route`. Defaults to None.
 
         Returns:
             TOK: A simple `OK` response.
@@ -1338,11 +1338,44 @@ async def script_kill(self, route: Optional[Route] = None) -> TClusterResponse[T
 
         Returns:
             TOK: A simple `OK` response.
-            route (Optional[Route]): The command will be routed automatically based on the passed command's default request policy, unless `route` is provided, in which
-            case the client will route the command to the nodes defined by `route`. Defaults to None.
+            route (Optional[Route]): The command will be routed automatically to all nodes, unless `route` is provided, in which
+                case the client will route the command to the nodes defined by `route`. Defaults to None.
 
         Examples:
             >>> await client.script_kill()
                 "OK"
         """
         return cast(TOK, await self._execute_command(RequestType.ScriptKill, [], route))
+
+    async def invoke_script(
+        self,
+        script: Script,
+        keys: Optional[List[TEncodable]] = None,
+        args: Optional[List[TEncodable]] = None,
+        route: Optional[Route] = None,
+    ) -> TClusterResponse[TResult]:
+        """
+        Invokes a Lua script with its keys and arguments.
+        This method simplifies the process of invoking scripts on a server by using an object that represents a Lua script.
+        The script loading, argument preparation, and execution will all be handled internally.
+        If the script has not already been loaded, it will be loaded automatically using the `SCRIPT LOAD` command.
+        After that, it will be invoked using the `EVALSHA` command.
+
+        See https://valkey.io/commands/script-load/ and https://valkey.io/commands/evalsha/ for more details.
+
+        Args:
+            script (Script): The Lua script to execute.
+            keys (Optional[List[TEncodable]]): The keys that are used in the script.
+            args (Optional[List[TEncodable]]): The arguments for the script.
+            route (Optional[Route]): The command will be routed automatically to all nodes, unless `route` is provided, in which
+                case the client will route the command to the nodes defined by `route`. Defaults to None.
+
+        Returns:
+            TResult: a value that depends on the script that was executed.
+
+        Examples:
+            >>> lua_script = Script("return { KEYS[1], ARGV[1] }")
+            >>> await invoke_script(lua_script, keys=["foo"], args=["bar"] );
+                [b"foo", b"bar"]
+        """
+        return await self._execute_script(script.get_hash(), keys, args, route)

python/python/glide/async_commands/standalone_commands.py

@@ -1078,7 +1078,6 @@ async def script_flush(self, mode: Optional[FlushMode] = None) -> TOK:
     async def script_kill(self) -> TOK:
         """
         Kill the currently executing Lua script, assuming no write operation was yet performed by the script.
-        The command is routed to all nodes, and aggregates the response to a single array.
 
         See https://valkey.io/commands/script-kill for more details.
 

python/python/tests/test_async_client.py

@@ -10298,32 +10298,40 @@ async def test_script_flush(self, glide_client: TGlideClient):
         assert await glide_client.script_exists([script.get_hash()]) == [False]
 
     @pytest.mark.parametrize("cluster_mode", [True, False])
+    @pytest.mark.parametrize("single_route", [True, False])
     @pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])
     async def test_script_kill(
-        self, request, cluster_mode, protocol, glide_client: TGlideClient
+        self,
+        request,
+        cluster_mode,
+        protocol,
+        glide_client: TGlideClient,
+        single_route: bool,
     ):
+        is_cluster = isinstance(glide_client, GlideClusterClient)
+        route = SlotKeyRoute(SlotType.PRIMARY, "1") if single_route else AllPrimaries()
+
         # Verify that script_kill raises an error when no script is running
         with pytest.raises(RequestError) as e:
             await glide_client.script_kill()
         assert "No scripts in execution right now" in str(e)
 
         # Create a long-running script
         long_script = Script(create_long_running_lua_script(10))
-        # long_script = Script("while true do end")
 
         # Create a second client to run the script
         test_client = await create_client(
             request, cluster_mode=cluster_mode, protocol=protocol, timeout=30000
         )
 
-        # Create a second client to kill the script
-        test_client2 = await create_client(
-            request, cluster_mode=cluster_mode, protocol=protocol, timeout=15000
-        )
-
         async def run_long_script():
             with pytest.raises(RequestError) as e:
-                await test_client.invoke_script(long_script)
+                if is_cluster:
+                    await cast(GlideClusterClient, test_client).invoke_script(
+                        long_script, route=route
+                    )
+                else:
+                    await test_client.invoke_script(long_script)
             assert "Script killed by user" in str(e)
 
         async def wait_and_kill_script():
@@ -10332,7 +10340,12 @@ async def wait_and_kill_script():
             while timeout <= 5:
                 # keep trying to kill until we get an "OK"
                 try:
-                    result = await glide_client.script_kill()
+                    if is_cluster:
+                        result = await cast(
+                            GlideClusterClient, glide_client
+                        ).script_kill(route=route)
+                    else:
+                        result = await glide_client.script_kill()
                     #  we expect to get success
                     assert result == "OK"
                     break
@@ -10350,11 +10363,13 @@ async def wait_and_kill_script():
 
         # Verify that script_kill raises an error when no script is running
         with pytest.raises(RequestError) as e:
-            await glide_client.script_kill()
+            if is_cluster:
+                await cast(GlideClusterClient, glide_client).script_kill(route=route)
+            else:
+                await glide_client.script_kill()
         assert "No scripts in execution right now" in str(e)
 
         await test_client.close()
-        await test_client2.close()
 
     @pytest.mark.parametrize("cluster_mode", [True, False])
     @pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])

python/python/tests/utils/utils.py

@@ -266,7 +266,8 @@ def create_lua_lib_with_long_running_function(
 
 def create_long_running_lua_script(timeout: int) -> str:
     """
-    Create a lua script
+    Create a lua script which runs an endless loop up to timeout sec.
+    Execution takes at least 5 sec regardless of the timeout configured.
     """
     script = (
         "  local started = tonumber(redis.pcall('time')[1])\n"