change ipc api

core/addon_communication/ipc_client.py → nvda/addon_communication/ipc_client.py

@@ -12,9 +12,18 @@ class Actions:
     def addon_server_endpoint() -> Tuple[str, str, str]:
         """Returns the address, port, and valid commands for the addon server"""
 
-    def send_ipc_commands(commands: list[IPC_COMMAND] | IPC_COMMAND):
+    def send_ipc_commands(commands: list[IPC_COMMAND]):
         """Sends a command or commands to the screenreader"""
 
+    def send_ipc_command(command: IPC_COMMAND):
+        """
+        Sends a single command to the screenreader.
+        This is its own function since old versions of talon
+        don't support union type hints and having a separate
+        function is a workaround a clearer API than passing in a list
+        for a single command
+        """
+
 NVDAContext = Context()
 NVDAContext.matches = r"""
 tag: user.nvda_running
@@ -44,14 +53,10 @@ def addon_server_endpoint() -> Tuple[str, str, str]:
 
         return address, port, valid_commands
 
-
-    def send_ipc_commands(commands: list[IPC_COMMAND] | IPC_COMMAND):
+    def send_ipc_commands(commands: list[IPC_COMMAND]):
         """Sends a list of commands or a single command string to the NVDA screenreader"""
         ip, port, valid_commands = actions.user.addon_server_endpoint()
 
-        if isinstance(commands, str):
-            commands = [commands]
-
         for command in commands:
             if command not in valid_commands:
                 raise ValueError(f"Invalid command: {command}")
@@ -85,7 +90,11 @@ def send_ipc_commands(commands: list[IPC_COMMAND] | IPC_COMMAND):
             except: 
                 print("Error Communicating with NVDA extension")
             finally:
-                sock.close()            
+                sock.close()      
+
+    def send_ipc_command(command: IPC_COMMAND):
+        """Sends a single command to the screenreader"""
+        actions.user.send_ipc_commands([command])      
 
 ORCAContext = Context()
 ORCAContext.matches = r"""

nvda/addon_communication/ipc_schema.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+# Exhaustive list of commands that can be sent to the NVDA addon server
+IPC_COMMAND = Literal[
+    "disableSpeechInterruptForCharacters",
+    "enableSpeechInterruptForCharacters",
+    "disableSpeakTypedWords",
+    "enableSpeakTypedWords",
+    "disableSpeakTypedCharacters",
+    "enableSpeakTypedCharacters",
+    "debug"
+]

nvda/debug-nvda.talon

@@ -7,3 +7,6 @@ test reader add on:
 
 test controller client:
     user.test_controller_client()
+
+key(ctrl-alt-shift-g):
+    user.test_reader_addon()

nvda/nvda.py

@@ -86,7 +86,7 @@ def test_controller_client():
 
     def test_reader_addon():
         """Tests the reader addon"""
-        actions.user.send_ipc_commands(["debug"])
+        actions.user.send_ipc_command("debug")
 
 ctxWindowsNVDARunning = Context()
 ctxWindowsNVDARunning.matches = r"""