stop() — langchain Function Reference

Architecture documentation for the stop() function in shell_tool.py from the langchain codebase.

Function python LangChainCore MessageInterface calls 1 called by 3

Entity Profile

LangChainCore→ MessageInterface→ stop() — langchain Function Reference

Dependency Diagram

graph TD
  8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4["stop()"]
  cf4eeaa4_4bcc_69d9_a0f3_664b1eecb4e8["ShellSession"]
  8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4 -->|defined in| cf4eeaa4_4bcc_69d9_a0f3_664b1eecb4e8
  3fc9d5a9_a23d_6df7_d3e2_bba6248f9184["_cleanup_resources()"]
  3fc9d5a9_a23d_6df7_d3e2_bba6248f9184 -->|calls| 8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4
  376fc508_1bee_23a7_7de6_267e13821247["restart()"]
  376fc508_1bee_23a7_7de6_267e13821247 -->|calls| 8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4
  3d2455b7_eaeb_053d_fc17_21aaa32050ca["_create_resources()"]
  3d2455b7_eaeb_053d_fc17_21aaa32050ca -->|calls| 8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4
  689aee59_b72f_671f_1bc6_26e76e9d6fba["_kill_process()"]
  8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4 -->|calls| 689aee59_b72f_671f_1bc6_26e76e9d6fba
  style 8e7ca27f_5ba4_f43b_b7dd_ea19f14cf7c4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain_v1/langchain/agents/middleware/shell_tool.py lines 191–215

    def stop(self, timeout: float) -> None:
        """Stop the shell subprocess."""
        if not self._process:
            return

        if self._process.poll() is None and not self._terminated:
            try:
                self._stdin.write("exit\n")
                self._stdin.flush()
            except (BrokenPipeError, OSError):
                LOGGER.debug(
                    "Failed to write exit command; terminating shell session.",
                    exc_info=True,
                )

        try:
            if self._process.wait(timeout=timeout) is None:
                self._kill_process()
        except subprocess.TimeoutExpired:
            self._kill_process()
        finally:
            self._terminated = True
            with contextlib.suppress(Exception):
                self._stdin.close()
            self._process = None