Files
2026-07-13 12:47:58 +08:00

258 lines
8.6 KiB
Python

from typing import Dict, Optional
import e2b_connect
import httpcore
import httpx
from packaging.version import Version
from e2b.envd.process import process_connect, process_pb2
from e2b.connection_config import (
Username,
ConnectionConfig,
KEEPALIVE_PING_HEADER,
KEEPALIVE_PING_INTERVAL_SEC,
)
from e2b.exceptions import SandboxException
from e2b.envd.api import acheck_sandbox_health
from e2b.envd.rpc import authentication_header, ahandle_rpc_exception_with_health
from e2b.sandbox.commands.command_handle import PtySize
from e2b.sandbox_async.commands.command_handle import (
AsyncCommandHandle,
OutputHandler,
PtyOutput,
)
class Pty:
"""
Module for interacting with PTYs (pseudo-terminals) in the sandbox.
"""
def __init__(
self,
envd_api_url: str,
connection_config: ConnectionConfig,
pool: httpcore.AsyncConnectionPool,
envd_version: Version,
envd_api: httpx.AsyncClient,
) -> None:
self._connection_config = connection_config
self._envd_version = envd_version
self._check_health = lambda: acheck_sandbox_health(envd_api)
self._rpc = process_connect.ProcessClient(
envd_api_url,
# TODO: Fix and enable compression again — the headers compression is not solved for streaming.
# compressor=e2b_connect.GzipCompressor,
async_pool=pool,
json=True,
headers=connection_config.sandbox_headers,
logger=connection_config.logger,
)
async def kill(
self,
pid: int,
request_timeout: Optional[float] = None,
) -> bool:
"""
Kill PTY.
:param pid: Process ID of the PTY
:param request_timeout: Timeout for the request in **seconds**
:return: `true` if the PTY was killed, `false` if the PTY was not found
"""
try:
await self._rpc.asend_signal(
process_pb2.SendSignalRequest(
process=process_pb2.ProcessSelector(pid=pid),
signal=process_pb2.Signal.SIGNAL_SIGKILL,
),
request_timeout=self._connection_config.get_request_timeout(
request_timeout
),
)
return True
except Exception as e:
if isinstance(e, e2b_connect.ConnectException):
if e.status == e2b_connect.Code.not_found:
return False
raise await ahandle_rpc_exception_with_health(e, self._check_health)
async def send_stdin(
self,
pid: int,
data: bytes,
request_timeout: Optional[float] = None,
) -> None:
"""
Send input to a PTY.
:param pid: Process ID of the PTY
:param data: Input data to send
:param request_timeout: Timeout for the request in **seconds**
"""
try:
await self._rpc.asend_input(
process_pb2.SendInputRequest(
process=process_pb2.ProcessSelector(pid=pid),
input=process_pb2.ProcessInput(
pty=data,
),
),
request_timeout=self._connection_config.get_request_timeout(
request_timeout
),
)
except Exception as e:
raise await ahandle_rpc_exception_with_health(e, self._check_health)
async def create(
self,
size: PtySize,
on_data: OutputHandler[PtyOutput],
user: Optional[Username] = None,
cwd: Optional[str] = None,
envs: Optional[Dict[str, str]] = None,
timeout: Optional[float] = 60,
request_timeout: Optional[float] = None,
) -> AsyncCommandHandle:
"""
Start a new PTY (pseudo-terminal).
:param size: Size of the PTY
:param on_data: Callback to handle PTY data
:param user: User to use for the PTY
:param cwd: Working directory for the PTY
:param envs: Environment variables for the PTY
:param timeout: Timeout for the PTY in **seconds**
:param request_timeout: Timeout for the request in **seconds**
:return: Handle to interact with the PTY
"""
envs = dict(envs) if envs else {}
envs.setdefault("TERM", "xterm-256color")
envs.setdefault("LANG", "C.UTF-8")
envs.setdefault("LC_ALL", "C.UTF-8")
events = self._rpc.astart(
process_pb2.StartRequest(
process=process_pb2.ProcessConfig(
cmd="/bin/bash",
envs=envs,
args=["-i", "-l"],
cwd=cwd,
),
pty=process_pb2.PTY(
size=process_pb2.PTY.Size(rows=size.rows, cols=size.cols)
),
),
headers={
**authentication_header(self._envd_version, user),
KEEPALIVE_PING_HEADER: str(KEEPALIVE_PING_INTERVAL_SEC),
},
timeout=timeout,
request_timeout=self._connection_config.get_request_timeout(
request_timeout
),
)
try:
start_event = await events.__anext__()
if not start_event.HasField("event"):
raise SandboxException(
f"Failed to start process: expected start event, got {start_event}"
)
return AsyncCommandHandle(
pid=start_event.event.start.pid,
handle_kill=lambda: self.kill(start_event.event.start.pid),
events=events,
on_pty=on_data,
check_health=self._check_health,
)
except Exception as e:
try:
await events.aclose()
except Exception:
pass
raise await ahandle_rpc_exception_with_health(e, self._check_health)
async def connect(
self,
pid: int,
on_data: OutputHandler[PtyOutput],
timeout: Optional[float] = 60,
request_timeout: Optional[float] = None,
) -> AsyncCommandHandle:
"""
Connect to a running PTY.
:param pid: Process ID of the PTY to connect to. You can get the list of running PTYs using `sandbox.pty.list()`.
:param on_data: Callback to handle PTY data
:param timeout: Timeout for the PTY connection in **seconds**. Using `0` will not limit the connection time
:param request_timeout: Timeout for the request in **seconds**
:return: Handle to interact with the PTY
"""
events = self._rpc.aconnect(
process_pb2.ConnectRequest(
process=process_pb2.ProcessSelector(pid=pid),
),
timeout=timeout,
request_timeout=self._connection_config.get_request_timeout(
request_timeout
),
headers={
KEEPALIVE_PING_HEADER: str(KEEPALIVE_PING_INTERVAL_SEC),
},
)
try:
start_event = await events.__anext__()
if not start_event.HasField("event"):
raise SandboxException(
f"Failed to connect to process: expected start event, got {start_event}"
)
return AsyncCommandHandle(
pid=start_event.event.start.pid,
handle_kill=lambda: self.kill(start_event.event.start.pid),
events=events,
on_pty=on_data,
check_health=self._check_health,
)
except Exception as e:
try:
await events.aclose()
except Exception:
pass
raise await ahandle_rpc_exception_with_health(e, self._check_health)
async def resize(
self,
pid: int,
size: PtySize,
request_timeout: Optional[float] = None,
) -> None:
"""
Resize PTY.
Call this when the terminal window is resized and the number of columns and rows has changed.
:param pid: Process ID of the PTY
:param size: New size of the PTY
:param request_timeout: Timeout for the request in **seconds**
"""
await self._rpc.aupdate(
process_pb2.UpdateRequest(
process=process_pb2.ProcessSelector(pid=pid),
pty=process_pb2.PTY(
size=process_pb2.PTY.Size(rows=size.rows, cols=size.cols),
),
),
request_timeout=self._connection_config.get_request_timeout(
request_timeout
),
)