Desktop

Connects to the local macOS desktop and starts the bundled XCUITest runner automatically. Requires macOS 14 or newer, Xcode, and UI automation permission for the process running Xcode.

def connect(self, options: DesktopMacConnectOptions | None = None) -> MacDesktop

mac = desktop.mac.connect()

Launches an installed macOS application by bundle identifier. The returned app supports native locators, actions, text reads, waits, screenshots, and accessibility snapshots.

def launch(self, options: DesktopMacLaunchOptions) -> MacApp

app = mac.launch(DesktopMacLaunchOptions(app_id="com.apple.TextEdit"))

Uses native XCUITest selectors and the Playwright-style role, text, label, and test-id locator subset. App methods include click, fill, focus, press, count, text_content, inner_text, wait_for_selector, screenshot, and accessibility_snapshot.

def locator(self, selector: str) -> MacLocator
def get_by_role(self, role: str, options: RoleOptions | None = None) -> MacLocator