feat: change default of is_cacheable flag to False

philipph-askui · philipph-askui · commit 835860a2a0d6 · 2026-02-25T11:13:11.000+01:00
diff --git a/src/askui/models/shared/tools.py b/src/askui/models/shared/tools.py
@@ -199,15 +199,14 @@ def name(self, value: str) -> None:
         """Sets the base name of the tool."""
         self.base_name = value
 
-    @property
-    def is_cacheable(self) -> bool:
-        """Whether this tool's actions can be cached and replayed.
-
-        Returns False by default. Override in subclasses for tools
-        that produce deterministic results and where side-effects during
-        replay are unlikely or tolerable.
-        """
-        return False
+    is_cacheable: bool = Field(
+        default=False,
+        description=(
+            "Whether this tool's actions can be cached and replayed. "
+            "False by default. Set to True for tools that produce deterministic "
+            "results and where side-effects during replay are unlikely or tolerable."
+        ),
+    )
 
     def to_params(
         self,
diff --git a/src/askui/tools/android/tools.py b/src/askui/tools/android/tools.py
@@ -28,6 +28,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> tuple[str, Image.Image]:
@@ -83,6 +84,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     @override
     def __call__(
@@ -134,6 +136,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, text: str) -> str:
@@ -191,6 +194,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, x1: int, y1: int, x2: int, y2: int, duration: int = 1000) -> str:
@@ -224,6 +228,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, key_name: ANDROID_KEY) -> str:
@@ -298,6 +303,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, x1: int, y1: int, x2: int, y2: int, duration: int = 1000) -> str:
@@ -354,6 +360,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, keys: list[ANDROID_KEY], duration: int = 100) -> str:
@@ -397,6 +404,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, command: str) -> str:
@@ -415,6 +423,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             description="Can be used to get all connected devices serial numbers.",
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -434,6 +443,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             "current selected device.",
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -455,6 +465,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             """,
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -488,6 +499,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, device_sn: str) -> str:
@@ -516,6 +528,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self, display_unique_id: int) -> str:
@@ -536,6 +549,7 @@ def __init__(self, agent_os: AndroidAgentOsFacade | None = None):
             """,
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
diff --git a/src/askui/tools/caching_tools.py b/src/askui/tools/caching_tools.py
@@ -32,6 +32,7 @@ def __init__(self, cache_dir: str, trajectories_format: str = ".json") -> None:
         )
         self._cache_dir = Path(cache_dir)
         self._trajectories_format = trajectories_format
+        self.is_cacheable = True
 
     @override
     @validate_call
diff --git a/src/askui/tools/computer/connect_tool.py b/src/askui/tools/computer/connect_tool.py
@@ -18,6 +18,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             ),
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         try:
diff --git a/src/askui/tools/computer/disconnect_tool.py b/src/askui/tools/computer/disconnect_tool.py
@@ -15,6 +15,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             ),
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         self.agent_os.disconnect()
diff --git a/src/askui/tools/computer/get_mouse_position_tool.py b/src/askui/tools/computer/get_mouse_position_tool.py
@@ -12,6 +12,7 @@ def __init__(self, agent_os: ComputerAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         cursor_position = self.agent_os.get_mouse_position()
diff --git a/src/askui/tools/computer/keyboard_pressed_tool.py b/src/askui/tools/computer/keyboard_pressed_tool.py
@@ -34,6 +34,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(
         self,
diff --git a/src/askui/tools/computer/keyboard_release_tool.py b/src/askui/tools/computer/keyboard_release_tool.py
@@ -34,6 +34,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(
         self,
diff --git a/src/askui/tools/computer/keyboard_tap_tool.py b/src/askui/tools/computer/keyboard_tap_tool.py
@@ -42,6 +42,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(
         self,
diff --git a/src/askui/tools/computer/list_displays_tool.py b/src/askui/tools/computer/list_displays_tool.py
@@ -11,6 +11,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             """,
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         return self.agent_os.list_displays().model_dump_json(
diff --git a/src/askui/tools/computer/mouse_click_tool.py b/src/askui/tools/computer/mouse_click_tool.py
@@ -32,6 +32,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self, mouse_button: MouseButton, number_of_clicks: int = 1) -> str:
         self.agent_os.click(mouse_button, number_of_clicks)
diff --git a/src/askui/tools/computer/mouse_hold_down_tool.py b/src/askui/tools/computer/mouse_hold_down_tool.py
@@ -24,6 +24,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self, mouse_button: MouseButton) -> str:
         self.agent_os.mouse_down(mouse_button)
diff --git a/src/askui/tools/computer/mouse_release_tool.py b/src/askui/tools/computer/mouse_release_tool.py
@@ -24,6 +24,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self, mouse_button: MouseButton) -> str:
         self.agent_os.mouse_up(mouse_button)
diff --git a/src/askui/tools/computer/mouse_scroll_tool.py b/src/askui/tools/computer/mouse_scroll_tool.py
@@ -32,6 +32,7 @@ def __init__(self, agent_os: ComputerAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     def __call__(self, dx: int, dy: int) -> str:
         self.agent_os.mouse_scroll(dx, dy)
diff --git a/src/askui/tools/computer/move_mouse_tool.py b/src/askui/tools/computer/move_mouse_tool.py
@@ -26,6 +26,7 @@ def __init__(self, agent_os: ComputerAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     def __call__(self, x: int, y: int) -> str:
         self.agent_os.mouse_move(x, y)
diff --git a/src/askui/tools/computer/retrieve_active_display_tool.py b/src/askui/tools/computer/retrieve_active_display_tool.py
@@ -12,6 +12,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             """,
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         return str(
diff --git a/src/askui/tools/computer/screenshot_tool.py b/src/askui/tools/computer/screenshot_tool.py
@@ -14,6 +14,7 @@ def __init__(self, agent_os: ComputerAgentOsFacade | None = None) -> None:
             agent_os=agent_os,
             required_tags=[ToolTags.SCALED_AGENT_OS.value],
         )
+        self.is_cacheable = True
 
     def __call__(self) -> tuple[str, Image.Image]:
         screenshot = self.agent_os.screenshot()
diff --git a/src/askui/tools/computer/set_active_display_tool.py b/src/askui/tools/computer/set_active_display_tool.py
@@ -21,6 +21,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self, display_id: int) -> None:
         self.agent_os.set_display(display_id)
diff --git a/src/askui/tools/computer/type_tool.py b/src/askui/tools/computer/type_tool.py
@@ -29,6 +29,7 @@ def __init__(self, agent_os: AgentOs | None = None) -> None:
             },
             agent_os=agent_os,
         )
+        self.is_cacheable = True
 
     def __call__(self, text: str, typing_speed: int = 50) -> str:
         self.agent_os.type(text, typing_speed)
diff --git a/src/askui/tools/playwright/tools.py b/src/askui/tools/playwright/tools.py
@@ -35,6 +35,7 @@ def __init__(self, agent_os: PlaywrightAgentOs) -> None:
             },
         )
         self._agent_os = agent_os
+        self.is_cacheable = True
 
     @override
     def __call__(self, url: str) -> str:
@@ -60,6 +61,7 @@ def __init__(self, agent_os: PlaywrightAgentOs) -> None:
             ),
         )
         self._agent_os = agent_os
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -85,6 +87,7 @@ def __init__(self, agent_os: PlaywrightAgentOs) -> None:
             ),
         )
         self._agent_os = agent_os
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -109,6 +112,7 @@ def __init__(self, agent_os: PlaywrightAgentOs) -> None:
             ),
         )
         self._agent_os = agent_os
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
@@ -133,6 +137,7 @@ def __init__(self, agent_os: PlaywrightAgentOs) -> None:
             ),
         )
         self._agent_os = agent_os
+        self.is_cacheable = True
 
     @override
     def __call__(self) -> str:
diff --git a/src/askui/tools/store/android/save_screenshot_tool.py b/src/askui/tools/store/android/save_screenshot_tool.py
@@ -69,6 +69,7 @@ def __init__(self, base_dir: str) -> None:
             },
         )
         self._base_dir = base_dir
+        self.is_cacheable = True
 
     def __call__(self, image_path: str) -> str:
         """
diff --git a/src/askui/tools/store/computer/save_screenshot_tool.py b/src/askui/tools/store/computer/save_screenshot_tool.py
@@ -69,6 +69,7 @@ def __init__(self, base_dir: str) -> None:
             },
         )
         self._base_dir = base_dir
+        self.is_cacheable = True
 
     def __call__(self, image_path: str) -> str:
         """
diff --git a/src/askui/tools/store/universal/get_current_time.py b/src/askui/tools/store/universal/get_current_time.py
@@ -40,6 +40,7 @@ def __init__(self) -> None:
                 "required": [],
             },
         )
+        self.is_cacheable = True
 
     def __call__(self) -> str:
         """
diff --git a/src/askui/tools/store/universal/list_files_tool.py b/src/askui/tools/store/universal/list_files_tool.py
@@ -69,7 +69,8 @@ def __init__(self, base_dir: str | Path) -> None:
                 "required": [],
             },
         )
-        self._base_dir = base_dir
+        self._base_dir = Path(base_dir)
+        self.is_cacheable = True
 
     def __call__(self, directory_path: str = "", recursive: bool = False) -> str:
         """
diff --git a/src/askui/tools/store/universal/print_to_console.py b/src/askui/tools/store/universal/print_to_console.py
@@ -61,6 +61,7 @@ def __init__(self, source_name: str | None = None):
             },
         )
         self._source_name = source_name
+        self.is_cacheable = False
 
     def __call__(self, content: str) -> str:
         """
diff --git a/src/askui/tools/store/universal/read_from_file_tool.py b/src/askui/tools/store/universal/read_from_file_tool.py
@@ -66,8 +66,9 @@ def __init__(
                 "required": ["file_path"],
             },
         )
-        self._base_dir = base_dir
         self._encodings = encodings or ["utf-8", "latin-1"]
+        self._base_dir = Path(base_dir)
+        self.is_cacheable = True
 
     def __call__(self, file_path: str) -> str:
         """
diff --git a/src/askui/tools/store/universal/wait_tool.py b/src/askui/tools/store/universal/wait_tool.py
@@ -58,6 +58,7 @@ def __init__(self, max_wait_time: int = 10 * 60) -> None:
             },
         )
         self._max_wait_time = max_wait_time
+        self.is_cacheable = True
 
     def __call__(self, wait_duration: int) -> str:
         """
diff --git a/src/askui/tools/store/universal/wait_until_condition_tool.py b/src/askui/tools/store/universal/wait_until_condition_tool.py
@@ -87,6 +87,7 @@ def __init__(
         )
         self._condition_check = condition_check
         self._max_wait_time = max_wait_time
+        self.is_cacheable = True
 
     def __call__(self, max_wait_time: int, check_interval: int = 1) -> str:
         """
diff --git a/src/askui/tools/store/universal/wait_with_progress_tool.py b/src/askui/tools/store/universal/wait_with_progress_tool.py
@@ -66,6 +66,7 @@ def __init__(self, max_wait_time: int = 10 * 60) -> None:
             },
         )
         self._max_wait_time = max_wait_time
+        self.is_cacheable = True
 
     def __call__(self, wait_duration: int, message: str = "Waiting") -> str:
         """
diff --git a/src/askui/tools/store/universal/write_to_file_tool.py b/src/askui/tools/store/universal/write_to_file_tool.py
@@ -94,7 +94,9 @@ def __init__(self, base_dir: str | Path) -> None:
                 "required": ["file_path", "content", "append"],
             },
         )
-        self._base_dir = base_dir
+        self._base_dir = Path(base_dir)
+        self._base_dir.mkdir(parents=True, exist_ok=True)
+        self.is_cacheable = False
 
     def __call__(self, file_path: str, content: str, append: bool) -> str:
         """

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ def __init__(self, cache_dir: str, trajectories_format: str = ".json") -> None:`
`32`	`32`	`)`
`33`	`33`	`self._cache_dir = Path(cache_dir)`
`34`	`34`	`self._trajectories_format = trajectories_format`
	`35`	`+ self.is_cacheable = True`
`35`	`36`
`36`	`37`	`@override`
`37`	`38`	`@validate_call`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ def __init__(self, agent_os: AgentOs \| None = None) -> None:`
`18`	`18`	`),`
`19`	`19`	`agent_os=agent_os,`
`20`	`20`	`)`
	`21`	`+ self.is_cacheable = True`
`21`	`22`
`22`	`23`	`def __call__(self) -> str:`
`23`	`24`	`try:`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ def __init__(self, agent_os: AgentOs \| None = None) -> None:`
`15`	`15`	`),`
`16`	`16`	`agent_os=agent_os,`
`17`	`17`	`)`
	`18`	`+ self.is_cacheable = True`
`18`	`19`
`19`	`20`	`def __call__(self) -> str:`
`20`	`21`	`self.agent_os.disconnect()`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ def __init__(self, agent_os: ComputerAgentOsFacade \| None = None) -> None:`
`12`	`12`	`agent_os=agent_os,`
`13`	`13`	`required_tags=[ToolTags.SCALED_AGENT_OS.value],`
`14`	`14`	`)`
	`15`	`+ self.is_cacheable = True`
`15`	`16`
`16`	`17`	`def __call__(self) -> str:`
`17`	`18`	`cursor_position = self.agent_os.get_mouse_position()`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ def __init__(self, agent_os: AgentOs \| None = None) -> None:`
`34`	`34`	`},`
`35`	`35`	`agent_os=agent_os,`
`36`	`36`	`)`
	`37`	`+ self.is_cacheable = True`
`37`	`38`
`38`	`39`	`def __call__(`
`39`	`40`	`self,`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ def __init__(self, agent_os: AgentOs \| None = None) -> None:`
`42`	`42`	`},`
`43`	`43`	`agent_os=agent_os,`
`44`	`44`	`)`
	`45`	`+ self.is_cacheable = True`
`45`	`46`
`46`	`47`	`def __call__(`
`47`	`48`	`self,`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ def __init__(self, agent_os: AgentOs \| None = None) -> None:`
`11`	`11`	`""",`
`12`	`12`	`agent_os=agent_os,`
`13`	`13`	`)`
	`14`	`+ self.is_cacheable = True`
`14`	`15`
`15`	`16`	`def __call__(self) -> str:`
`16`	`17`	`return self.agent_os.list_displays().model_dump_json(`