Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

refactor(python-sdk): share one envd HTTP client across the sync sandbox modules (#1655)

Mish Ushakov11912ffa0473
diff --git a/.changeset/python-share-sync-envd-api-client.md b/.changeset/python-share-sync-envd-api-client.md
new file mode 100644
index 000000000..60254ff2c
--- /dev/null
+++ b/.changeset/python-share-sync-envd-api-client.md
@@ -0,0 +1,11 @@
+---
+"@e2b/python-sdk": patch
+---
+
+Build the envd HTTP API client once per sync `Sandbox` and share it across the
+filesystem, commands, and PTY modules, which now receive it instead of each
+constructing their own — matching `AsyncSandbox`. No behavior change: the
+pyqwest transport underneath is already cached process-wide per
+`(proxy, for_streaming)`, so the separate clients shared one connection pool
+either way. `Filesystem` still builds the streaming sibling client whose
+transport carries the idle read timeout, in both flavors.
diff --git a/packages/python-sdk/e2b/sandbox_async/commands/command.py b/packages/python-sdk/e2b/sandbox_async/commands/command.py
index b345843af..19d7e2364 100644
--- a/packages/python-sdk/e2b/sandbox_async/commands/command.py
+++ b/packages/python-sdk/e2b/sandbox_async/commands/command.py
@@ -43,12 +43,15 @@ class Commands:
) -> None:
self._connection_config = connection_config
self._envd_version = envd_version
- self._check_health = lambda: acheck_sandbox_health(envd_api)
self._rpc = create_rpc_client(
process_connect.ProcessClient,
envd_api_url,
connection_config,
)
+ self._envd_api = envd_api
+
+ async def _check_health(self) -> Optional[bool]:
+ return await acheck_sandbox_health(self._envd_api)
async def list(
self,
diff --git a/packages/python-sdk/e2b/sandbox_async/commands/pty.py b/packages/python-sdk/e2b/sandbox_async/commands/pty.py
index 15d75b1bb..dda9d2e6f 100644
--- a/packages/python-sdk/e2b/sandbox_async/commands/pty.py
+++ b/packages/python-sdk/e2b/sandbox_async/commands/pty.py
@@ -44,12 +44,15 @@ class Pty:
) -> None:
self._connection_config = connection_config
self._envd_version = envd_version
- self._check_health = lambda: acheck_sandbox_health(envd_api)
self._rpc = create_rpc_client(
process_connect.ProcessClient,
envd_api_url,
connection_config,
)
+ self._envd_api = envd_api
+
+ async def _check_health(self) -> Optional[bool]:
+ return await acheck_sandbox_health(self._envd_api)
async def kill(
self,
diff --git a/packages/python-sdk/e2b/sandbox_async/filesystem/filesystem.py b/packages/python-sdk/e2b/sandbox_async/filesystem/filesystem.py
index f58c0a2bf..c36a21c86 100644
--- a/packages/python-sdk/e2b/sandbox_async/filesystem/filesystem.py
+++ b/packages/python-sdk/e2b/sandbox_async/filesystem/filesystem.py
@@ -94,6 +94,11 @@ class Filesystem:
self._envd_api_url = envd_api_url
self._envd_version = envd_version
self._connection_config = connection_config
+ self._rpc = create_rpc_client(
+ filesystem_connect.FilesystemClient,
+ envd_api_url,
+ connection_config,
+ )
self._envd_api = envd_api
# Streamed downloads default to a sibling client whose transport
# carries the idle read timeout (see `get_envd_transport`).
@@ -101,12 +106,6 @@ class Filesystem:
connection_config, envd_api_url, for_streaming=True
)
- self._rpc = create_rpc_client(
- filesystem_connect.FilesystemClient,
- envd_api_url,
- connection_config,
- )
-
@overload
async def read(
self,
diff --git a/packages/python-sdk/e2b/sandbox_sync/commands/command.py b/packages/python-sdk/e2b/sandbox_sync/commands/command.py
index a60610519..0198c42c5 100644
--- a/packages/python-sdk/e2b/sandbox_sync/commands/command.py
+++ b/packages/python-sdk/e2b/sandbox_sync/commands/command.py
@@ -1,9 +1,9 @@
from typing import Callable, Dict, List, Literal, Optional, Union, overload
+import httpx
from connectrpc.code import Code
from connectrpc.errors import ConnectError
from packaging.version import Version
-from e2b.api.client_sync import get_envd_api
from e2b.connection_config import (
ConnectionConfig,
Username,
@@ -38,8 +38,8 @@ class Commands:
envd_api_url: str,
connection_config: ConnectionConfig,
envd_version: Version,
+ envd_api: httpx.Client,
) -> None:
- self._envd_api_url = envd_api_url
self._connection_config = connection_config
self._envd_version = envd_version
self._rpc = create_rpc_client(
@@ -47,9 +47,7 @@ class Commands:
envd_api_url,
connection_config,
)
- # Like the RPC client, the pyqwest transport underneath is
- # thread-safe, so one client serves all threads.
- self._envd_api = get_envd_api(connection_config, envd_api_url)
+ self._envd_api = envd_api
def _check_health(self) -> Optional[bool]:
return check_sandbox_health(self._envd_api)
diff --git a/packages/python-sdk/e2b/sandbox_sync/commands/pty.py b/packages/python-sdk/e2b/sandbox_sync/commands/pty.py
index 34b32cdc2..946500775 100644
--- a/packages/python-sdk/e2b/sandbox_sync/commands/pty.py
+++ b/packages/python-sdk/e2b/sandbox_sync/commands/pty.py
@@ -1,9 +1,10 @@
from typing import Dict, Optional
+import httpx
+
from connectrpc.code import Code
from connectrpc.errors import ConnectError
from packaging.version import Version
-from e2b.api.client_sync import get_envd_api
from protobuf import Oneof
from e2b.envd.process import process_connect, process_pb
@@ -35,8 +36,8 @@ class Pty:
envd_api_url: str,
connection_config: ConnectionConfig,
envd_version: Version,
+ envd_api: httpx.Client,
) -> None:
- self._envd_api_url = envd_api_url
self._connection_config = connection_config
self._envd_version = envd_version
self._rpc = create_rpc_client(
@@ -44,9 +45,7 @@ class Pty:
envd_api_url,
connection_config,
)
- # Like the RPC client, the pyqwest transport underneath is
- # thread-safe, so one client serves all threads.
- self._envd_api = get_envd_api(connection_config, envd_api_url)
+ self._envd_api = envd_api
def _check_health(self) -> Optional[bool]:
return check_sandbox_health(self._envd_api)
diff --git a/packages/python-sdk/e2b/sandbox_sync/filesystem/filesystem.py b/packages/python-sdk/e2b/sandbox_sync/filesystem/filesystem.py
index bcd12877e..f249c9895 100644
--- a/packages/python-sdk/e2b/sandbox_sync/filesystem/filesystem.py
+++ b/packages/python-sdk/e2b/sandbox_sync/filesystem/filesystem.py
@@ -83,6 +83,7 @@ class Filesystem:
envd_api_url: str,
envd_version: Version,
connection_config: ConnectionConfig,
+ envd_api: httpx.Client,
) -> None:
self._envd_api_url = envd_api_url
self._envd_version = envd_version
@@ -92,10 +93,11 @@ class Filesystem:
envd_api_url,
connection_config,
)
- # Like the RPC client, the pyqwest transports underneath are
- # thread-safe, so one client (and its streaming sibling, whose
- # transport carries the idle read timeout) serves all threads.
- self._envd_api = get_envd_api(connection_config, envd_api_url)
+ self._envd_api = envd_api
+ # Streamed downloads default to a sibling client whose transport
+ # carries the idle read timeout (see `get_envd_transport`). Like the
+ # RPC client, the pyqwest transports underneath are thread-safe, so
+ # one client serves all threads.
self._envd_api_streaming = get_envd_api(
connection_config, envd_api_url, for_streaming=True
)
diff --git a/packages/python-sdk/e2b/sandbox_sync/main.py b/packages/python-sdk/e2b/sandbox_sync/main.py
index 5046c2f78..1350b4f68 100644
--- a/packages/python-sdk/e2b/sandbox_sync/main.py
+++ b/packages/python-sdk/e2b/sandbox_sync/main.py
@@ -10,6 +10,7 @@ from packaging.version import Version
from typing_extensions import Self, Unpack
from e2b.api.client.types import Unset
+from e2b.api.client_sync import get_envd_api
from e2b.connection_config import ApiParams, ConnectionConfig
from e2b.envd.api import ENVD_API_HEALTH_ROUTE, handle_envd_api_exception
from e2b.envd.versions import ENVD_DEBUG_FALLBACK
@@ -102,27 +103,27 @@ class Sandbox(SandboxApi):
"""
super().__init__(**opts)
+ self._envd_api = get_envd_api(self.connection_config, self.envd_api_url)
self._filesystem = Filesystem(
self.envd_api_url,
self._envd_version,
self.connection_config,
+ self._envd_api,
)
self._commands = Commands(
self.envd_api_url,
self.connection_config,
self._envd_version,
+ self._envd_api,
)
self._pty = Pty(
self.envd_api_url,
self.connection_config,
self._envd_version,
+ self._envd_api,
)
self._git = Git(self._commands)
- @property
- def _envd_api(self) -> httpx.Client:
- return self._filesystem._envd_api
-
def is_running(self, request_timeout: Optional[float] = None) -> bool:
"""
Check if the sandbox is running.
diff --git a/packages/python-sdk/tests/sync/sandbox_sync/test_sync_client_lifecycle.py b/packages/python-sdk/tests/sync/sandbox_sync/test_sync_client_lifecycle.py
index cdbe42a75..5325994bf 100644
--- a/packages/python-sdk/tests/sync/sandbox_sync/test_sync_client_lifecycle.py
+++ b/packages/python-sdk/tests/sync/sandbox_sync/test_sync_client_lifecycle.py
@@ -1,10 +1,9 @@
"""Client lifecycle in the sync sandbox modules: the httpx `envd_api`
clients and the connectrpc RPC clients are both cheap stateless wrappers
-over shared, process-global pyqwest transports — built once per module and
-shared across threads."""
+over shared, process-global pyqwest transports — built once per sandbox and
+shared across the modules and across threads."""
from concurrent.futures import ThreadPoolExecutor
-from types import SimpleNamespace
from unittest.mock import Mock, sentinel
import httpx
@@ -25,16 +24,23 @@ def run_in_worker_thread(fn):
return executor.submit(fn).result()
-def test_sync_sandbox_envd_api_delegates_to_filesystem(monkeypatch, test_api_key):
+def test_sync_sandbox_shares_one_envd_api_across_modules(monkeypatch, test_api_key):
config = ConnectionConfig(api_key=test_api_key)
main_api = Mock(spec=httpx.Client)
- filesystem = SimpleNamespace(_envd_api=main_api)
+ received = {}
+
+ def record(name):
+ def factory(*args, **kwargs):
+ received[name] = args[-1]
+ return object()
+
+ return factory
monkeypatch.setattr(
- sandbox_sync_main, "Filesystem", lambda *args, **kwargs: filesystem
+ sandbox_sync_main, "get_envd_api", lambda *_args, **_kwargs: main_api
)
- monkeypatch.setattr(sandbox_sync_main, "Commands", lambda *args, **kwargs: object())
- monkeypatch.setattr(sandbox_sync_main, "Pty", lambda *args, **kwargs: object())
+ for module in ("Filesystem", "Commands", "Pty"):
+ monkeypatch.setattr(sandbox_sync_main, module, record(module))
monkeypatch.setattr(sandbox_sync_main, "Git", lambda *args, **kwargs: object())
sandbox = sandbox_sync_main.Sandbox(
@@ -47,7 +53,7 @@ def test_sync_sandbox_envd_api_delegates_to_filesystem(monkeypatch, test_api_key
)
assert sandbox._envd_api is main_api
- assert sandbox._envd_api is sandbox.files._envd_api
+ assert received == {"Filesystem": main_api, "Commands": main_api, "Pty": main_api}
assert not hasattr(sandbox, "_transport")
@@ -60,9 +66,7 @@ def test_sync_filesystem_clients_are_shared_across_threads(monkeypatch, test_api
monkeypatch.setattr(
filesystem_sync,
"get_envd_api",
- lambda *_args, **kwargs: streaming_api
- if kwargs.get("for_streaming")
- else shared_api,
+ lambda *_args, **_kwargs: streaming_api,
)
monkeypatch.setattr(
filesystem_sync,
@@ -74,6 +78,7 @@ def test_sync_filesystem_clients_are_shared_across_threads(monkeypatch, test_api
ENVD_API_URL,
ENVD_VERSION,
config,
+ shared_api,
)
assert fs._envd_api is shared_api