input properties included

Author: seanjh

stagehand/utils.py

@@ -5,7 +5,7 @@
 from pydantic import AnyUrl, BaseModel, Field, HttpUrl, create_model
 from pydantic.fields import FieldInfo
 
-from stagehand.types.a11y import AccessibilityNode
+from stagehand.types.a11y import AccessibilityNode, AXProperty, AXValue
 
 
 def snake_to_camel(snake_str: str) -> str:
@@ -95,11 +95,85 @@ def convert_dict_keys_to_snake_case(data: Any) -> Any:
     return data
 
 
+INCLUDED_NODE_PROPERTY_NAMES = {
+    "selected",
+    "checked",
+    "value",
+    "valuemin",
+    "valuemax",
+    "valuetext",
+}
+"""
+AX Property names included in the simplified tree.
+"""
+
+
+def _format_ax_value(value_type: str, value: AXValue) -> Union[str, None]:
+    """
+    Formats the accessibility value, or returns None if the value is unsupported.
+
+    NOTE:
+        Refer to "Accessible Rich Internet Applications (WAI-ARIA) 1.2"
+        for details.
+        https://www.w3.org/TR/wai-aria-1.2/#propcharacteristic_value
+    """
+    if value_type == "tristate" and value in ["true", "mixed"]:
+        return str(value)
+    elif value_type == "booleanOrUndefined" and value in [True, "true"]:
+        return "true"
+    elif value_type == "number" and isinstance(value, (int, float)):
+        return str(value)
+    elif value_type == "string" and value:
+        return str(value)
+    return None
+
+
+def _format_property(property: AXProperty) -> Union[str, None]:
+    name = property.get("name")
+    if name is None or (value_obj := property.get("value")) is None:
+        return None
+    value_type = value_obj["type"]
+    value = value_obj["value"]
+    value_formatted: Union[str, None] = None
+
+    if (value_formatted := _format_ax_value(value_type, value)) is not None:
+        return f"{name}={value_formatted}"
+    return None
+
+
+def _format_properties(node: AccessibilityNode) -> str:
+    """Formats the properties of a node into a simplified string representation."""
+    included_properties: list[AXProperty] = [
+        property
+        for property in (node.get("properties") or [])
+        if property["name"] in INCLUDED_NODE_PROPERTY_NAMES
+    ]
+
+    formatted = ", ".join(
+        formatted
+        for property in included_properties
+        if (formatted := _format_property(property)) is not None
+    )
+
+    if formatted:
+        return f"({formatted})"
+    return ""
+
+
 def format_simplified_tree(node: AccessibilityNode, level: int = 0) -> str:
     """Formats a node and its children into a simplified string representation."""
     indent = "  " * level
     name_part = f": {node.get('name')}" if node.get("name") else ""
-    result = f"{indent}[{node.get('nodeId')}] {node.get('role')}{name_part}\n"
+    value_part = f" value={node.get('value')}" if node.get("value") else ""
+    properties_part = (
+        f" {formatted_properties}"
+        if (formatted_properties := _format_properties(node))
+        else ""
+    )
+    result = (
+        f"{indent}[{node.get('nodeId')}] {node.get('role')}{name_part}"
+        f"{value_part}{properties_part}\n"
+    )
 
     children = node.get("children", [])
     if children:

tests/fixtures/ax_trees/input-range.json

@@ -61,7 +61,7 @@
         "3"
       ],
       "backendDOMNodeId": 2,
-      "frameId": "EB14D1D07B8B11BC38CA8A242657286A"
+      "frameId": "4C8AFBFB04749B93F2BA71C9854C9B01"
     },
     {
       "nodeId": "3",
@@ -317,7 +317,7 @@
       },
       "value": {
         "type": "number",
-        "value": 6
+        "value": 5
       },
       "properties": [
         {

tests/fixtures/html_pages/input-range.html

@@ -8,7 +8,7 @@
     <section>
       <h1>Range Input</h1>
       <div>
-        <input type="range" id="volume" name="volume" min="0" max="11" />
+        <input type="range" id="volume" name="volume" min="0" max="11" step="1" value="5" />
         <label for="volume">Volume</label>
       </div>
     </section>

tests/unit/a11y/test_utils.py

@@ -79,11 +79,11 @@ async def test_select_tag_included_in_simplified(self, mock_stagehand_page: Stag
     [10] heading: Select Menus
     [11] LabelText
       [29] StaticText: Choose a pet:
-    [12] select: Choose a pet:
+    [12] select: Choose a pet: value=Hamster
       [15] MenuListPopup
         [19] option: Dog
         [22] option: Cat
-        [25] option: Hamster
+        [25] option: Hamster (selected=true)
 """
         )
         assert actual["iframes"] == []
@@ -104,7 +104,7 @@ async def test_input_type_radio(self, mock_stagehand_page: StagehandPage, mock_s
     [10] group: Select a maintenance drone:
       [11] Legend
         [22] StaticText: Select a maintenance drone:
-      [13] radio: Huey
+      [13] radio: Huey (checked=true)
       [16] radio: Dewey
       [19] radio: Louie
 """
@@ -125,7 +125,7 @@ async def test_input_type_range(self, mock_stagehand_page: StagehandPage, mock_s
   [8] generic
     [9] heading: Range Input
     [10] generic
-      [11] slider: Volume
+      [11] slider: Volume value=5 (valuemin=0, valuemax=11)
       [15] LabelText
         [17] StaticText: Volume
 """