allwright 0.2.0__tar.gz → 0.2.1__tar.gz

{allwright-0.2.0 → allwright-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: allwright
-Version: 0.2.0
+Version: 0.2.1
 Summary: High-level Python client for the allwright engine
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{allwright-0.2.0 → allwright-0.2.1}/allwright/__init__.py

@@ -11,6 +11,8 @@ from .client import (
     AndroidDevice,
     NativeApp,
     AndroidApp,
+    DesktopApp,
+    DesktopWindow,
     DesktopMacConnectOptions,
     DesktopMacLaunchOptions,
     MacApp,
@@ -81,6 +83,8 @@ __all__ = [
     "AndroidDevice",
     "NativeApp",
     "AndroidApp",
+    "DesktopApp",
+    "DesktopWindow",
     "DesktopMacConnectOptions",
     "DesktopMacLaunchOptions",
     "MacApp",

{allwright-0.2.0 → allwright-0.2.1}/allwright/_bootstrap.py

@@ -25,7 +25,7 @@ ALLWRIGHT_HOME_ENV_VAR = "ALLWRIGHT_HOME"
 ALLWRIGHT_REPOSITORY_ENV_VAR = "ALLWRIGHT_REPOSITORY"
 ALLWRIGHT_VERSION_ENV_VAR = "ALLWRIGHT_VERSION"
 DEFAULT_RELEASE_REPOSITORY = "allwright-dev/allwright"
-DEFAULT_RELEASE_VERSION = "0.2.0"
+DEFAULT_RELEASE_VERSION = "0.2.1"
 
 _bootstrap_lock = threading.Lock()
 _managed_server: subprocess.Popen[bytes] | None = None

{allwright-0.2.0 → allwright-0.2.1}/allwright/_desktop.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import threading
 
+from ._hooks import Hook, HookType
 from ._mobile import NativeApp, NativeLocator
 from ._proto import engine_pb2
 from ._transport import RuntimeClient, StreamHandle
@@ -26,12 +27,117 @@ class DesktopMacLaunchOptions:
         self.timeout_ms = timeout_ms
 
 
-MacApp = NativeApp
 MacLocator = NativeLocator
-WindowsApp = NativeApp
 WindowsLocator = NativeLocator
 
 
+class DesktopWindow(NativeApp):
+    def __init__(self, runtime: RuntimeClient, surface_session_id: str, session_id: str,
+                 window_id: str, title: str, is_main: bool) -> None:
+        super().__init__(runtime, surface_session_id, session_id)
+        self.window_id, self.title, self.is_main = window_id, title, is_main
+
+    def close(self) -> None:
+        with self._lock:
+            handle = self._ensure_handle()
+            self._ensure_open()
+            handle.send(engine_pb2.ContextSessionCommand(
+                surface_session_id=self._surface_session_id,
+                context_session_id=self._session_id,
+                close_desktop_window=engine_pb2.CloseDesktopWindowCommand(),
+            ))
+            while True:
+                event = handle.recv("close desktop window")
+                kind = event.WhichOneof("event")
+                if kind == "desktop_window_closed" and event.desktop_window_closed.window_id == self.window_id:
+                    self._closed = True
+                    return
+                if kind == "error":
+                    raise AllwrightError(event.error.message)
+
+
+class DesktopApp(NativeApp):
+    def windows(self) -> list[DesktopWindow]:
+        with self._lock:
+            handle = self._ensure_handle()
+            self._ensure_open()
+            handle.send(engine_pb2.ContextSessionCommand(
+                surface_session_id=self._surface_session_id,
+                context_session_id=self._session_id,
+                list_desktop_windows=engine_pb2.ListDesktopWindowsCommand(),
+            ))
+            while True:
+                event = handle.recv("list desktop windows")
+                kind = event.WhichOneof("event")
+                if kind == "desktop_windows_resolved":
+                    return [self._window(result) for result in event.desktop_windows_resolved.windows]
+                if kind == "error":
+                    raise AllwrightError(event.error.message)
+
+    def main_window(self) -> DesktopWindow:
+        for window in self.windows():
+            if window.is_main:
+                return window
+        raise AllwrightError("desktop application does not currently expose a main window")
+
+    def register_hook(self, hook_type: HookType):
+        if hook_type.name != "window":
+            return super().register_hook(hook_type)
+        with self._lock:
+            handle = self._ensure_handle()
+            self._ensure_open()
+            handle.send(engine_pb2.ContextSessionCommand(
+                surface_session_id=self._surface_session_id,
+                context_session_id=self._session_id,
+                register_hook=engine_pb2.RegisterHookCommand(
+                    desktop_window=engine_pb2.RegisterDesktopWindowHook()
+                ),
+            ))
+            while True:
+                event = handle.recv("register desktop window hook")
+                kind = event.WhichOneof("event")
+                if kind == "hook_registered":
+                    return Hook(self, event.hook_registered.hook_id, hook_type)
+                if kind == "error":
+                    raise AllwrightError(event.error.message)
+
+    def _wait_for_hook(self, hook_id, hook_type, options):
+        if hook_type.name != "window":
+            return super()._wait_for_hook(hook_id, hook_type, options)
+        from ._runtime import retry_options
+
+        with self._lock:
+            handle = self._ensure_handle()
+            self._ensure_open()
+            handle.send(engine_pb2.ContextSessionCommand(
+                surface_session_id=self._surface_session_id,
+                context_session_id=self._session_id,
+                wait_for_hook=engine_pb2.WaitForHookCommand(
+                    hook_id=hook_id,
+                    retry_options=retry_options(getattr(options, "timeout_ms", None)),
+                ),
+            ))
+            while True:
+                event = handle.recv("wait for desktop window hook")
+                kind = event.WhichOneof("event")
+                if kind == "hook_completed" and event.hook_completed.hook_id == hook_id:
+                    if event.hook_completed.WhichOneof("result") != "desktop_window":
+                        raise AllwrightError("desktop window hook returned an invalid result")
+                    return self._window(event.hook_completed.desktop_window.window)
+                if kind == "error":
+                    raise AllwrightError(event.error.message)
+
+    def _window(self, result) -> DesktopWindow:
+        if not result.context_session_id or not result.window_id:
+            raise AllwrightError("desktop window result is missing its context or window id")
+        return DesktopWindow(self._runtime, self._surface_session_id, result.context_session_id,
+                             result.window_id, result.title, result.is_main)
+
+
+MacApp = DesktopApp
+WindowsApp = DesktopApp
+
+
 class MacDesktop:
     def __init__(
         self,
@@ -47,7 +153,7 @@ class MacDesktop:
         self._closed = False
         self._session_id = session_id
         self._surface_session_id = surface_session_id
-        self._app = NativeApp(runtime, surface_session_id, initial_app_session_id)
+        self._app = DesktopApp(runtime, surface_session_id, initial_app_session_id)
 
     @property
     def session_id(self) -> str:
@@ -73,7 +179,7 @@ class MacDesktop:
                 event = self._stream.recv("receive macOS app launch event")
                 match event.WhichOneof("event"):
                     case "desktop_app_launched":
-                        self._app = NativeApp(
+                        self._app = DesktopApp(
                             self._runtime,
                             self._surface_session_id,
                             event.desktop_app_launched.app_session_id,

{allwright-0.2.0 → allwright-0.2.1}/allwright/_hooks.py

@@ -4,6 +4,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Generic, Iterable, TypeVar
 
 if TYPE_CHECKING:
+    from ._desktop import DesktopWindow
     from ._page import Page
     from ._types import CommandOptions
 
@@ -80,12 +81,14 @@ class _Hooks:
     new_page: HookType[Page]
     file_chooser: HookType[FileChooser]
     download: HookType[Download]
+    window: HookType[DesktopWindow]
 
     def __init__(self) -> None:
         self.dialog = HookType("dialog")
         self.new_page = HookType("new_page")
         self.file_chooser = HookType("file_chooser")
         self.download = HookType("download")
+        self.window = HookType("window")
 
 
 hooks = _Hooks()

{allwright-0.2.0 → allwright-0.2.1}/allwright/client.py

@@ -22,6 +22,8 @@ from ._mobile import (
     mobile,
 )
 from ._desktop import (
+    DesktopApp,
+    DesktopWindow,
     DesktopMacConnectOptions,
     DesktopMacLaunchOptions,
     MacApp,

{allwright-0.2.0 → allwright-0.2.1}/allwright/proto/core/v1/context.proto

@@ -6,6 +6,7 @@ option java_package = "dev.allwright.engine.v1";
 option java_multiple_files = true;
 
 import "core/v1/common.proto";
+import "surfaces/desktop/v1/desktop.proto";
 import "surfaces/mobile/v1/mobile.proto";
 import "surfaces/web/v1/web.proto";
 
@@ -40,6 +41,8 @@ message ContextSessionCommand {
     ResolveFrameCommand resolve_frame = 26;
     CaptureCommand capture = 27;
     HandleDialogCommand handle_dialog = 28;
+    ListDesktopWindowsCommand list_desktop_windows = 29;
+    CloseDesktopWindowCommand close_desktop_window = 30;
   }
 }
 
@@ -82,6 +85,8 @@ message ContextSessionEvent {
     FrameResolvedEvent frame_resolved = 28;
     CaptureResolvedEvent capture_resolved = 29;
     DialogHandledEvent dialog_handled = 30;
+    DesktopWindowsResolvedEvent desktop_windows_resolved = 31;
+    DesktopWindowClosedEvent desktop_window_closed = 32;
   }
 }
 
@@ -109,6 +114,7 @@ message RegisterHookCommand {
     RegisterMobileFileChooserHook mobile_file_chooser = 4;
     RegisterMobileDownloadHook mobile_download = 5;
     RegisterDialogHook dialog = 6;
+    RegisterDesktopWindowHook desktop_window = 7;
   }
 }
 
@@ -131,6 +137,7 @@ message HookCompletedEvent {
     MobileFileChooserHookResult mobile_file_chooser = 5;
     MobileDownloadHookResult mobile_download = 6;
     DialogHookResult dialog = 7;
+    DesktopWindowHookResult desktop_window = 8;
   }
 }
 

{allwright-0.2.0 → allwright-0.2.1}/allwright/proto/surfaces/desktop/v1/desktop.proto

@@ -39,3 +39,26 @@ message DesktopAppLaunchedEvent {
   string app_id = 2;
   string note = 3;
 }
+
+message ListDesktopWindowsCommand {}
+message CloseDesktopWindowCommand {}
+message RegisterDesktopWindowHook {}
+
+message DesktopWindowInfo {
+  string context_session_id = 1;
+  string window_id = 2;
+  string title = 3;
+  bool is_main = 4;
+}
+
+message DesktopWindowsResolvedEvent {
+  repeated DesktopWindowInfo windows = 1;
+}
+
+message DesktopWindowClosedEvent {
+  string window_id = 1;
+}
+
+message DesktopWindowHookResult {
+  DesktopWindowInfo window = 1;
+}

{allwright-0.2.0 → allwright-0.2.1}/allwright.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: allwright
-Version: 0.2.0
+Version: 0.2.1
 Summary: High-level Python client for the allwright engine
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{allwright-0.2.0 → allwright-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "allwright"
-version = "0.2.0"
+version = "0.2.1"
 description = "High-level Python client for the allwright engine"
 readme = "README.md"
 requires-python = ">=3.10"