Skip to content

Automation

flaui.modules.automation.Automation(ui_automation_type, timeout=1000)

UIAutomation constructed wrapper for FlaUI usage.

FlaUI is written entirely on C# .Net, using it directly inside an IDE within a Python project would be painful since intellisense does not pick up the methods/typing hints.

This class is designed to overcome those challenges by providing Python compatible workstream.

Attributes: ui_automation_type (UIAutomationTypes): The type of UI automation to use (UIA2 or UIA3). timeout (int): The timeout value in milliseconds. automation_base (AutomationBase): Python facade for the C# automation (preferred for typed APIs). cs_automation (Any): Raw C# UIA2Automation or UIA3Automation (interop and backward compatibility). cf (ConditionFactory): The condition factory instance. tree_walker (RawViewWalker): The tree walker instance. application (Application): The application instance.

Initializes the UIAutomation wrapper.

Parameters:

Name Type Description Default
ui_automation_type UIAutomationTypes

The type of UI automation to use (UIA2 or UIA3).

 required
timeout int

The timeout value in milliseconds.

 1000
Source code in flaui/modules/automation.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(self, ui_automation_type: UIAutomationTypes, timeout: int = 1000) -> None:
    """Initializes the UIAutomation wrapper.

    :param ui_automation_type: The type of UI automation to use (UIA2 or UIA3).
    :param timeout: The timeout value in milliseconds.
    """
    self._ui_automation_types: UIAutomationTypes = ui_automation_type
    self.timeout: int = timeout
    self.automation_base: AutomationBase = (
        UIA3Automation() if ui_automation_type == UIAutomationTypes.UIA3 else UIA2Automation()
    )
    self.cs_automation: Any = self.automation_base.raw_automation
    self.cf = ConditionFactory(raw_cf=self.cs_automation.ConditionFactory)
    self.tree_walker: Any = self.cs_automation.TreeWalkerFactory.GetRawViewWalker()
    self.application: Application = Application()

__enter__()

Enter the runtime context and return the automation instance.

Enables with Automation(UIAutomationTypes.UIA3) as auto: usage. The managed application is closed and the underlying C# automation is disposed automatically on exit.

Returns:

Type Description
Automation

This automation instance.
Source code in flaui/modules/automation.py 
48
49
50
51
52
53
54
55
56
def __enter__(self) -> "Automation":
    """Enter the runtime context and return the automation instance.

    Enables ``with Automation(UIAutomationTypes.UIA3) as auto:`` usage. The managed application
    is closed and the underlying C# automation is disposed automatically on exit.

    :return: This automation instance.
    """
    return self

__exit__(exc_type, exc_value, traceback)

Exit the runtime context, closing the application and disposing the automation.

Never raises — cleanup failures are swallowed so they cannot mask an exception raised inside the with block.

Parameters:

Name Type Description Default
exc_type Any

The exception type raised in the context, if any.

 required
exc_value Any

The exception instance raised in the context, if any.

 required
traceback Any

The traceback for the exception, if any.

 required
Source code in flaui/modules/automation.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
    """Exit the runtime context, closing the application and disposing the automation.

    Never raises — cleanup failures are swallowed so they cannot mask an exception raised inside
    the ``with`` block.

    :param exc_type: The exception type raised in the context, if any.
    :param exc_value: The exception instance raised in the context, if any.
    :param traceback: The traceback for the exception, if any.
    """
    try:
        self.application.__exit__(exc_type, exc_value, traceback)
    except Exception:
        logging.debug("Application cleanup failed during automation context exit", exc_info=True)
    try:
        self.automation_base.dispose()
    except Exception:
        logging.debug("Automation dispose failed during context exit", exc_info=True)