openhands-tools 1.9.1__tar.gz → 1.11.0__tar.gz

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhands-tools
-Version: 1.9.1
+Version: 1.11.0
 Summary: OpenHands Tools - Runtime tools for AI agents
 Project-URL: Source, https://github.com/OpenHands/software-agent-sdk
 Project-URL: Homepage, https://github.com/OpenHands/software-agent-sdk

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/browser_use/impl.py

@@ -14,6 +14,7 @@ if TYPE_CHECKING:
 
 from openhands.sdk.logger import DEBUG, get_logger
 from openhands.sdk.tool import ToolExecutor
+from openhands.sdk.utils import sanitized_env
 from openhands.sdk.utils.async_executor import AsyncExecutor
 from openhands.tools.browser_use.definition import BrowserAction, BrowserObservation
 from openhands.tools.browser_use.server import CustomBrowserUseServer
@@ -43,6 +44,7 @@ def _install_chromium() -> bool:
             capture_output=True,
             text=True,
             timeout=300,  # 5 minutes timeout for installation
+            env=sanitized_env(),
         )
 
         if result.returncode == 0:

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/browser_use/logging_fix.py

@@ -15,7 +15,7 @@ from openhands.sdk.utils.deprecation import warn_cleanup
 
 warn_cleanup(
     "Monkey patching to prevent browser_use logging interference",
-    cleanup_by="1.10.0",
+    cleanup_by="1.15.0",
     details=(
         "This workaround should be removed once browser_use PR #3717 "
         "(https://github.com/browser-use/browser-use/pull/3717) is merged "

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/file_editor/utils/shell.py

@@ -2,6 +2,7 @@ import os
 import subprocess
 import time
 
+from openhands.sdk.utils import sanitized_env
 from openhands.sdk.utils.truncate import maybe_truncate
 from openhands.tools.file_editor.utils.constants import (
     CONTENT_TRUNCATED_NOTICE,
@@ -32,7 +33,12 @@ def run_shell_cmd(
     process: subprocess.Popen[str] | None = None
     try:
         process = subprocess.Popen(
-            cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
+            cmd,
+            shell=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            env=sanitized_env(),
         )
 
         stdout, stderr = process.communicate(timeout=timeout)
@@ -65,6 +71,7 @@ def check_tool_installed(tool_name: str) -> bool:
             check=True,
             cwd=os.getcwd(),
             capture_output=True,
+            env=sanitized_env(),
         )
         return True
     except (subprocess.CalledProcessError, FileNotFoundError):

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/glob/impl.py

@@ -8,6 +8,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 from openhands.sdk.tool import ToolExecutor
+from openhands.sdk.utils import sanitized_env
 
 
 if TYPE_CHECKING:
@@ -149,7 +150,12 @@ class GlobExecutor(ToolExecutor[GlobAction, GlobObservation]):
 
         # Execute ripgrep
         result = subprocess.run(
-            cmd, capture_output=True, text=True, timeout=30, check=False
+            cmd,
+            capture_output=True,
+            text=True,
+            timeout=30,
+            check=False,
+            env=sanitized_env(),
         )
 
         # Parse output into file paths

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/grep/impl.py

@@ -6,6 +6,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 from openhands.sdk.tool import ToolExecutor
+from openhands.sdk.utils import sanitized_env
 
 
 if TYPE_CHECKING:
@@ -154,7 +155,12 @@ class GrepExecutor(ToolExecutor[GrepAction, GrepObservation]):
 
         # Execute ripgrep
         result = subprocess.run(
-            cmd, capture_output=True, text=True, timeout=30, check=False
+            cmd,
+            capture_output=True,
+            text=True,
+            timeout=30,
+            check=False,
+            env=sanitized_env(),
         )
 
         # Parse output into file paths
@@ -209,7 +215,12 @@ class GrepExecutor(ToolExecutor[GrepAction, GrepObservation]):
 
         # Execute grep
         result = subprocess.run(
-            cmd, capture_output=True, text=True, timeout=30, check=False
+            cmd,
+            capture_output=True,
+            text=True,
+            timeout=30,
+            check=False,
+            env=sanitized_env(),
         )
 
         # Parse output into file paths

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/planning_file_editor/definition.py

@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from openhands.sdk.conversation.state import ConversationState
 
+from openhands.sdk.logger import get_logger
 from openhands.sdk.tool import (
     ToolAnnotations,
     ToolDefinition,
@@ -20,7 +21,12 @@ from openhands.tools.file_editor.definition import (
 )
 
 
-# Hardcoded plan filename
+logger = get_logger(__name__)
+
+# Default config directory and plan filename
+# PLAN.md is now stored in .agents_tmp/ to keep workspace root clean
+# and separate agent temporary files from user content
+DEFAULT_CONFIG_DIR = ".agents_tmp"
 PLAN_FILENAME = "PLAN.md"
 
 
@@ -62,11 +68,17 @@ class PlanningFileEditorTool(
     def create(
         cls,
         conv_state: "ConversationState",
+        plan_path: str | None = None,
     ) -> Sequence["PlanningFileEditorTool"]:
         """Initialize PlanningFileEditorTool.
 
         Args:
             conv_state: Conversation state to get working directory from.
+            plan_path: Optional absolute path to PLAN.md file. If not provided,
+                defaults to {working_dir}/.agents_tmp/PLAN.md.
+
+        Raises:
+            ValueError: If plan_path is provided but is not an absolute path.
         """
         # Import here to avoid circular imports
         from openhands.tools.planning_file_editor.impl import (
@@ -74,8 +86,31 @@ class PlanningFileEditorTool(
         )
 
         working_dir = conv_state.workspace.working_dir
-        workspace_root = Path(working_dir).resolve()
-        plan_path = str(workspace_root / PLAN_FILENAME)
+
+        # Validate plan_path is absolute if provided
+        if plan_path is not None and not Path(plan_path).is_absolute():
+            raise ValueError(f"plan_path must be an absolute path, got: {plan_path}")
+
+        # Use provided plan_path or fall back to .agents_tmp/PLAN.md at workspace root
+        if plan_path is None:
+            workspace_root = Path(working_dir).resolve()
+
+            # Check for legacy PLAN.md at workspace root
+            legacy_plan_path = workspace_root / PLAN_FILENAME
+            if legacy_plan_path.exists():
+                # Use legacy location for backward compatibility
+                new_recommended_path = (
+                    workspace_root / DEFAULT_CONFIG_DIR / PLAN_FILENAME
+                )
+                logger.warning(
+                    f"Found PLAN.md at legacy location {legacy_plan_path}. "
+                    f"Consider moving it to {new_recommended_path} "
+                    f"for consistency with OpenHands conventions."
+                )
+                plan_path = str(legacy_plan_path)
+            else:
+                # Use new default location
+                plan_path = str(workspace_root / DEFAULT_CONFIG_DIR / PLAN_FILENAME)
 
         # Initialize PLAN.md with headers if it doesn't exist
         plan_file = Path(plan_path)
@@ -83,7 +118,10 @@ class PlanningFileEditorTool(
             # Import here to avoid circular imports
             from openhands.tools.preset.planning import get_plan_headers
 
+            # Ensure parent directory exists
+            plan_file.parent.mkdir(parents=True, exist_ok=True)
             plan_file.write_text(get_plan_headers())
+            logger.info(f"Created new PLAN.md at {plan_path}")
 
         # Create executor with restricted edit access to PLAN.md only
         executor = PlanningFileEditorExecutor(

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/preset/planning.py

@@ -102,9 +102,13 @@ def register_planning_tools() -> None:
     logger.debug("Tool: PlanningFileEditorTool registered.")
 
 
-def get_planning_tools() -> list[Tool]:
+def get_planning_tools(plan_path: str | None = None) -> list[Tool]:
     """Get the planning agent tool specifications.
 
+    Args:
+        plan_path: Optional absolute path to PLAN.md file. If provided, will be
+            passed to PlanningFileEditorTool via params.
+
     Returns:
         List of tools optimized for planning and analysis tasks, including
         file viewing and PLAN.md editing capabilities for advanced
@@ -117,10 +121,15 @@ def get_planning_tools() -> list[Tool]:
     from openhands.tools.grep import GrepTool
     from openhands.tools.planning_file_editor import PlanningFileEditorTool
 
+    # Build params for PlanningFileEditorTool if plan_path is provided
+    planning_tool_params = {}
+    if plan_path:
+        planning_tool_params["plan_path"] = plan_path
+
     return [
         Tool(name=GlobTool.name),
         Tool(name=GrepTool.name),
-        Tool(name=PlanningFileEditorTool.name),
+        Tool(name=PlanningFileEditorTool.name, params=planning_tool_params),
     ]
 
 

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/terminal/terminal/factory.py

@@ -5,6 +5,7 @@ import subprocess
 from typing import Literal
 
 from openhands.sdk.logger import get_logger
+from openhands.sdk.utils import sanitized_env
 from openhands.tools.terminal.terminal.terminal_session import TerminalSession
 
 
@@ -19,6 +20,7 @@ def _is_tmux_available() -> bool:
             capture_output=True,
             text=True,
             timeout=5.0,
+            env=sanitized_env(),
         )
         return result.returncode == 0
     except (subprocess.TimeoutExpired, FileNotFoundError):
@@ -40,6 +42,7 @@ def _is_powershell_available() -> bool:
             capture_output=True,
             text=True,
             timeout=5.0,
+            env=sanitized_env(),
         )
         return result.returncode == 0
     except (subprocess.TimeoutExpired, FileNotFoundError):

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/terminal/terminal/subprocess_terminal.py

@@ -13,6 +13,7 @@ import time
 from collections import deque
 
 from openhands.sdk.logger import get_logger
+from openhands.sdk.utils import sanitized_env
 from openhands.tools.terminal.constants import (
     CMD_OUTPUT_PS1_BEGIN,
     CMD_OUTPUT_PS1_END,
@@ -106,7 +107,7 @@ class SubprocessTerminal(TerminalInterface):
         logger.info(f"Using shell: {resolved_shell_path}")
 
         # Inherit environment variables from the parent process
-        env = os.environ.copy()
+        env = sanitized_env()
         env["PS1"] = self.PS1
         env["PS2"] = ""
         env["TERM"] = "xterm-256color"

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/terminal/terminal/terminal_session.py

@@ -5,8 +5,10 @@ import time
 from enum import Enum
 
 from openhands.sdk.logger import get_logger
+from openhands.sdk.utils import maybe_truncate
 from openhands.tools.terminal.constants import (
     CMD_OUTPUT_PS1_END,
+    MAX_CMD_OUTPUT_SIZE,
     NO_CHANGE_TIMEOUT_SECONDS,
     POLL_INTERVAL,
     TIMEOUT_MESSAGE_TEMPLATE,
@@ -183,6 +185,10 @@ class TerminalSession(TerminalSessionBase):
             raw_command_output,
             metadata,
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
+
         self.prev_status = TerminalCommandStatus.COMPLETED
         self.prev_output = ""  # Reset previous command output
         self._ready_for_next_command()
@@ -221,6 +227,9 @@ class TerminalSession(TerminalSessionBase):
             metadata,
             continue_prefix="[Below is the output of the previous command.]\n",
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
         return TerminalObservation.from_text(
             command=command,
             text=command_output,
@@ -257,6 +266,9 @@ class TerminalSession(TerminalSessionBase):
             metadata,
             continue_prefix="[Below is the output of the previous command.]\n",
         )
+        command_output = maybe_truncate(
+            command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+        )
         return TerminalObservation.from_text(
             command=command,
             exit_code=metadata.exit_code,
@@ -391,6 +403,9 @@ class TerminalSession(TerminalSessionBase):
                 metadata,
                 continue_prefix="[Below is the output of the previous command.]\n",
             )
+            command_output = maybe_truncate(
+                command_output, truncate_after=MAX_CMD_OUTPUT_SIZE
+            )
             obs = TerminalObservation.from_text(
                 command=command,
                 text=command_output,

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/terminal/terminal/tmux_terminal.py

@@ -1,12 +1,13 @@
 """Tmux-based terminal backend implementation."""
 
-import os
 import time
 import uuid
 
 import libtmux
+from libtmux.exc import TmuxObjectDoesNotExist
 
 from openhands.sdk.logger import get_logger
+from openhands.sdk.utils import sanitized_env
 from openhands.tools.terminal.constants import HISTORY_LIMIT
 from openhands.tools.terminal.metadata import CmdOutputMetadata
 from openhands.tools.terminal.terminal import TerminalInterface
@@ -41,7 +42,8 @@ class TmuxTerminal(TerminalInterface):
         if self._initialized:
             return
 
-        self.server = libtmux.Server()
+        env = sanitized_env()
+        self.server = libtmux.Server(environment=env)
         _shell_command = "/bin/bash"
         if self.username in ["root", "openhands"]:
             # This starts a non-login (new) shell for the given user
@@ -51,14 +53,36 @@ class TmuxTerminal(TerminalInterface):
 
         logger.debug(f"Initializing tmux terminal with command: {window_command}")
         session_name = f"openhands-{self.username}-{uuid.uuid4()}"
-        self.session = self.server.new_session(
-            session_name=session_name,
-            start_directory=self.work_dir,
-            kill_session=True,
-            x=1000,
-            y=1000,
-        )
-        for k, v in os.environ.items():
+
+        # Retry session creation to handle race conditions in libtmux
+        # where the session is created but can't be found immediately
+        max_retries = 3
+        retry_delay = 0.5
+        last_error = None
+        for attempt in range(max_retries):
+            try:
+                self.session = self.server.new_session(
+                    session_name=session_name,
+                    start_directory=self.work_dir,
+                    kill_session=True,
+                    x=1000,
+                    y=1000,
+                )
+                break
+            except TmuxObjectDoesNotExist as e:
+                last_error = e
+                if attempt < max_retries - 1:
+                    logger.warning(
+                        f"Tmux session creation failed (attempt {attempt + 1}/"
+                        f"{max_retries}), retrying in {retry_delay}s: {e}"
+                    )
+                    time.sleep(retry_delay)
+                    retry_delay *= 2  # Exponential backoff
+        else:
+            raise RuntimeError(
+                f"Failed to create tmux session after {max_retries} attempts"
+            ) from last_error
+        for k, v in env.items():
             self.session.set_environment(k, v)
 
         # Set history limit to a large number to avoid losing history

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands/tools/terminal/utils/command.py

@@ -141,7 +141,7 @@ def escape_bash_special_chars(command: str) -> str:
         remaining = command[last_pos:]
         parts.append(remaining)
         return "".join(parts)
-    except (ParsingError, NotImplementedError, TypeError):
+    except (ParsingError, NotImplementedError, TypeError, AttributeError):
         logger.debug(
             f"Failed to parse bash commands for special characters escape\n[input]: "
             f"{command}\n[warning]: {traceback.format_exc()}\nThe original command "

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/openhands_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhands-tools
-Version: 1.9.1
+Version: 1.11.0
 Summary: OpenHands Tools - Runtime tools for AI agents
 Project-URL: Source, https://github.com/OpenHands/software-agent-sdk
 Project-URL: Homepage, https://github.com/OpenHands/software-agent-sdk

{openhands_tools-1.9.1 → openhands_tools-1.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "openhands-tools"
-version = "1.9.1"
+version = "1.11.0"
 description = "OpenHands Tools - Runtime tools for AI agents"
 
 requires-python = ">=3.12"