add send_keys and clear_text method (#48)

Author: codeskyblue

uiautodev/command_proxy.py

@@ -13,7 +13,7 @@
 from pydantic import BaseModel
 
 from uiautodev.command_types import AppLaunchRequest, AppTerminateRequest, By, Command, CurrentAppResponse, \
-    DumpResponse, FindElementRequest, FindElementResponse, InstallAppRequest, InstallAppResponse, TapRequest, \
+    DumpResponse, FindElementRequest, FindElementResponse, InstallAppRequest, InstallAppResponse, SendKeysRequest, TapRequest, \
     WindowSizeResponse
 from uiautodev.driver.base_driver import BaseDriver
 from uiautodev.exceptions import ElementNotFoundError
@@ -39,7 +39,7 @@ def get_command_params_type(command: Command) -> Optional[BaseModel]:
     return type_hints.get("params")
 
 
-def send_command(driver: BaseDriver, command: Union[str, Command], params=None):
+def send_command(driver: BaseDriver, command: Command, params=None):
     if command not in COMMANDS:
         raise NotImplementedError(f"command {command} not implemented")
     func = COMMANDS[command]
@@ -142,6 +142,14 @@ def dump(driver: BaseDriver) -> DumpResponse:
 def wake_up(driver: BaseDriver):
     driver.wake_up()
 
+@register(Command.SEND_KEYS)
+def send_keys(driver: BaseDriver, params: SendKeysRequest):
+    driver.send_keys(params.text)
+
+@register(Command.CLEAR_TEXT)
+def clear_text(driver: BaseDriver):
+    driver.clear_text()
+
 
 def node_match(node: Node, by: By, value: str) -> bool:
     if by == By.ID:

uiautodev/command_types.py

@@ -39,6 +39,8 @@ class Command(str, enum.Enum):
     VOLUME_UP = "volumeUp"
     VOLUME_DOWN = "volumeDown"
     VOLUME_MUTE = "volumeMute"
+    SEND_KEYS = "sendKeys"
+    CLEAR_TEXT = "clearText"
 
 
 class TapRequest(BaseModel):
@@ -94,4 +96,8 @@ class FindElementRequest(BaseModel):
 
 class FindElementResponse(BaseModel):
     count: int
-    value: List[Node]
+    value: List[Node]
+
+
+class SendKeysRequest(BaseModel):
+    text: str

uiautodev/driver/android.py

@@ -127,7 +127,7 @@ def volume_down(self):
     def volume_mute(self):
         self.adb_device.keyevent("VOLUME_MUTE")
 
-    def get_app_version(self, package_name: str) -> Optional[dict]:
+    def get_app_version(self, package_name: str) -> dict:
         """
         Get the version information of an app, including mainVersion and subVersion.
 
@@ -172,11 +172,17 @@ def app_list(self) -> List[AppInfo]:
 
     def open_app_file(self, package: str) -> Iterator[bytes]:
         line = self.adb_device.shell(f"pm path {package}")
+        assert isinstance(line, str)
         if not line.startswith("package:"):
             raise AndroidDriverException(f"Failed to get package path: {line}")
         remote_path = line.split(':', 1)[1]
         yield from self.adb_device.sync.iter_content(remote_path)
-
+    
+    def send_keys(self, text: str):
+        self.ud.send_keys(text)
+    
+    def clear_text(self):
+        self.ud.clear_text()
 
 
 def parse_xml(xml_data: str, wsize: WindowSize, display_id: Optional[int] = None) -> Node:

uiautodev/driver/base_driver.py

@@ -102,4 +102,11 @@ def app_list(self) -> List[AppInfo]:
     def open_app_file(self, package: str) -> Iterator[bytes]:
         """ open app file """
         raise NotImplementedError()
-        
+    
+    def send_keys(self, text: str):
+        """ send keys to device """
+        raise NotImplementedError()
+
+    def clear_text(self):
+        """ clear text input on device """
+        raise NotImplementedError()

uiautodev/router/proxy.py

@@ -1,11 +1,10 @@
 import asyncio
+import logging
 
 import httpx
 import websockets
 from fastapi import APIRouter, HTTPException, Request, WebSocket, WebSocketDisconnect
 from fastapi.responses import Response
-import logging
-
 
 logger = logging.getLogger(__name__)
 router = APIRouter()