agentscope-runtime 0.1.6__py3-none-any.whl → 0.2.0__py3-none-any.whl

agentscope_runtime/sandbox/box/base/base_sandbox.py

@@ -5,13 +5,14 @@ from ...utils import build_image_uri
 from ...registry import SandboxRegistry
 from ...enums import SandboxType
 from ...box.sandbox import Sandbox
+from ...constant import TIMEOUT
 
 
 @SandboxRegistry.register(
     build_image_uri("runtime-sandbox-base"),
     sandbox_type=SandboxType.BASE,
     security_level="medium",
-    timeout=30,
+    timeout=TIMEOUT,
     description="Base Sandbox",
 )
 class BaseSandbox(Sandbox):

agentscope_runtime/sandbox/box/browser/browser_sandbox.py

@@ -8,6 +8,7 @@ from ...registry import SandboxRegistry
 from ...enums import SandboxType
 from ...box.base import BaseSandbox
 from ...box.gui import GUIMixin
+from ...constant import TIMEOUT
 
 
 def http_to_ws(url, use_localhost=True):
@@ -31,7 +32,7 @@ def http_to_ws(url, use_localhost=True):
     build_image_uri("runtime-sandbox-browser"),
     sandbox_type=SandboxType.BROWSER,
     security_level="medium",
-    timeout=60,
+    timeout=TIMEOUT,
     description="Browser sandbox",
 )
 class BrowserSandbox(GUIMixin, BaseSandbox):

agentscope_runtime/sandbox/box/dummy/dummy_sandbox.py

@@ -4,13 +4,14 @@ from typing import Optional
 from ...registry import SandboxRegistry
 from ...enums import SandboxType
 from ...box.sandbox import Sandbox
+from ...constant import TIMEOUT
 
 
 @SandboxRegistry.register(
     "",
     sandbox_type=SandboxType.DUMMY,
     security_level="low",
-    timeout=30,
+    timeout=TIMEOUT,
     description="Dummy Sandbox",
 )
 class DummySandbox(Sandbox):

agentscope_runtime/sandbox/box/filesystem/filesystem_sandbox.py

@@ -7,13 +7,14 @@ from ...registry import SandboxRegistry
 from ...enums import SandboxType
 from ...box.base import BaseSandbox
 from ...box.gui import GUIMixin
+from ...constant import TIMEOUT
 
 
 @SandboxRegistry.register(
     build_image_uri("runtime-sandbox-filesystem"),
     sandbox_type=SandboxType.FILESYSTEM,
     security_level="medium",
-    timeout=60,
+    timeout=TIMEOUT,
     description="Filesystem sandbox",
 )
 class FilesystemSandbox(GUIMixin, BaseSandbox):

agentscope_runtime/sandbox/box/gui/gui_sandbox.py

@@ -8,6 +8,7 @@ from ...utils import build_image_uri, get_platform
 from ...registry import SandboxRegistry
 from ...enums import SandboxType
 from ...box.base import BaseSandbox
+from ...constant import TIMEOUT
 
 logger = logging.getLogger(__name__)
 
@@ -36,7 +37,7 @@ class GUIMixin:
     build_image_uri("runtime-sandbox-gui"),
     sandbox_type=SandboxType.GUI,
     security_level="high",
-    timeout=30,
+    timeout=TIMEOUT,
     description="GUI Sandbox",
 )
 class GuiSandbox(GUIMixin, BaseSandbox):

agentscope_runtime/sandbox/box/training_box/training_box.py

@@ -300,45 +300,3 @@ class BFCLSandbox(TrainingSandbox):
             bearer_token,
             sandbox_type,
         )
-
-
-@SandboxRegistry.register(
-    build_image_uri("runtime-sandbox-webshop", arm64_compatible=False),
-    sandbox_type=SandboxType.WEBSHOP,
-    runtime_config={"shm_size": "5.06gb"},
-    security_level="medium",
-    timeout=30,
-    description="webshop Sandbox",
-)
-class WebShopSandbox(TrainingSandbox):
-    """
-    Training Sandbox class for managing and executing training-related tasks.
-
-    This class provides methods to create, manage, and interact with
-    training environment instances using specialized tool calls.
-    """
-
-    def __init__(
-        self,
-        sandbox_id: Optional[str] = None,
-        timeout: int = 3000,
-        base_url: Optional[str] = None,
-        bearer_token: Optional[str] = None,
-        sandbox_type: SandboxType = SandboxType.WEBSHOP,
-    ):
-        """
-        Initialize the Training Sandbox.
-
-        Args:
-            sandbox_id (Optional[str]): Unique identifier for the sandbox.
-            timeout (int): Maximum time allowed for sandbox operations.
-            base_url (Optional[str]): Base URL for sandbox API.
-            bearer_token (Optional[str]): Authentication token for API access.
-        """
-        super().__init__(
-            sandbox_id,
-            timeout,
-            base_url,
-            bearer_token,
-            sandbox_type,
-        )

agentscope_runtime/sandbox/client/http_client.py

@@ -11,6 +11,8 @@ from pydantic import Field
 from ..model import ContainerModel
 
 
+DEFAULT_TIMEOUT = 60
+
 logging.getLogger("httpx").setLevel(logging.CRITICAL)
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
@@ -84,7 +86,8 @@ class SandboxHttpClient:
             "fastapi",
         )
 
-        self.timeout = timeout
+        self.start_timeout = timeout
+        self.timeout = model.timeout or DEFAULT_TIMEOUT
         self.session = requests.Session()
         self.built_in_tools = []
         self.secret = model.runtime_token
@@ -106,6 +109,11 @@ class SandboxHttpClient:
     def __exit__(self, exc_type, exc_value, traceback):
         pass
 
+    def _request(self, method: str, url: str, **kwargs):
+        if "timeout" not in kwargs:
+            kwargs["timeout"] = self.timeout
+        return self.session.request(method, url, **kwargs)
+
     def check_health(self) -> bool:
         """
         Checks if the runtime service is running by verifying the health
@@ -126,7 +134,7 @@ class SandboxHttpClient:
         Waits until the runtime service is running for a specified timeout.
         """
         start_time = time.time()
-        while time.time() - start_time < self.timeout:
+        while time.time() - start_time < self.start_timeout:
             if self.check_health():
                 return
             time.sleep(1)
@@ -140,7 +148,8 @@ class SandboxHttpClient:
         """
         try:
             endpoint = f"{self.base_url}/mcp/add_servers"
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 json={
                     "server_configs": server_configs,
@@ -159,7 +168,10 @@ class SandboxHttpClient:
     def list_tools(self, tool_type=None, **kwargs) -> dict:
         try:
             endpoint = f"{self.base_url}/mcp/list_tools"
-            response = self.session.get(endpoint)
+            response = self._request(
+                "get",
+                endpoint,
+            )
             response.raise_for_status()
             mcp_tools = response.json()
             mcp_tools["generic"] = self.generic_tools
@@ -189,7 +201,8 @@ class SandboxHttpClient:
 
         try:
             endpoint = f"{self.base_url}/mcp/call_tool"
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 json={
                     "tool_name": name,
@@ -215,7 +228,8 @@ class SandboxHttpClient:
         """Run an IPython cell."""
         try:
             endpoint = f"{self.base_url}/tools/run_ipython_cell"
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 json={"code": code},
             )
@@ -237,7 +251,11 @@ class SandboxHttpClient:
         """Run a shell command."""
         try:
             endpoint = f"{self.base_url}/tools/run_shell_command"
-            response = self.session.post(endpoint, json={"command": command})
+            response = self._request(
+                "post",
+                endpoint,
+                json={"command": command},
+            )
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
@@ -258,7 +276,8 @@ class SandboxHttpClient:
         """
         try:
             endpoint = f"{self.base_url}/watcher/commit_changes"
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 json={"commit_message": commit_message},
             )
@@ -282,7 +301,8 @@ class SandboxHttpClient:
         """
         try:
             endpoint = f"{self.base_url}/watcher/generate_diff"
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 json={"commit_a": commit_a, "commit_b": commit_b},
             )
@@ -301,7 +321,10 @@ class SandboxHttpClient:
         """
         try:
             endpoint = f"{self.base_url}/watcher/git_logs"
-            response = self.session.get(endpoint)
+            response = self._request(
+                "get",
+                endpoint,
+            )
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
@@ -318,7 +341,11 @@ class SandboxHttpClient:
         try:
             endpoint = f"{self.base_url}/workspace/files"
             params = {"file_path": file_path}
-            response = self.session.get(endpoint, params=params)
+            response = self._request(
+                "get",
+                endpoint,
+                params=params,
+            )
             response.raise_for_status()
             # Return the binary content of the file
             # Check for empty content
@@ -351,7 +378,8 @@ class SandboxHttpClient:
             endpoint = f"{self.base_url}/workspace/files"
             params = {"file_path": file_path}
             data = {"content": content}
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 params=params,
                 json=data,
@@ -378,7 +406,8 @@ class SandboxHttpClient:
         try:
             endpoint = f"{self.base_url}/workspace/list-directories"
             params = {"directory": directory}
-            response = self.session.get(
+            response = self._request(
+                "get",
                 endpoint,
                 params=params,
             )
@@ -398,7 +427,8 @@ class SandboxHttpClient:
         try:
             endpoint = f"{self.base_url}/workspace/directories"
             params = {"directory_path": directory_path}
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 params=params,
             )
@@ -420,7 +450,8 @@ class SandboxHttpClient:
         try:
             endpoint = f"{self.base_url}/workspace/files"
             params = {"file_path": file_path}
-            response = self.session.delete(
+            response = self._request(
+                "delete",
                 endpoint,
                 params=params,
             )
@@ -446,7 +477,8 @@ class SandboxHttpClient:
         try:
             endpoint = f"{self.base_url}/workspace/directories"
             params = {"directory_path": directory_path, "recursive": recursive}
-            response = self.session.delete(
+            response = self._request(
+                "delete",
                 endpoint,
                 params=params,
             )
@@ -475,7 +507,8 @@ class SandboxHttpClient:
                 "source_path": source_path,
                 "destination_path": destination_path,
             }
-            response = self.session.put(
+            response = self._request(
+                "put",
                 endpoint,
                 params=params,
             )
@@ -505,7 +538,8 @@ class SandboxHttpClient:
                 "source_path": source_path,
                 "destination_path": destination_path,
             }
-            response = self.session.post(
+            response = self._request(
+                "post",
                 endpoint,
                 params=params,
             )

agentscope_runtime/sandbox/constant.py

@@ -26,3 +26,6 @@ IMAGE_NAMESPACE = os.getenv("RUNTIME_SANDBOX_IMAGE_NAMESPACE", "agentscope")
 
 # Image Tag
 IMAGE_TAG = os.getenv("RUNTIME_SANDBOX_IMAGE_TAG", "latest")
+
+# Timeout
+TIMEOUT = int(os.getenv("RUNTIME_SANDBOX_TIMEOUT", "60"))

agentscope_runtime/sandbox/custom/custom_sandbox.py

@@ -7,6 +7,7 @@ from ..utils import build_image_uri
 from ..registry import SandboxRegistry
 from ..enums import SandboxType
 from ..box.sandbox import Sandbox
+from ..constant import TIMEOUT
 
 SANDBOX_TYPE = "custom_sandbox"
 
@@ -15,7 +16,7 @@ SANDBOX_TYPE = "custom_sandbox"
     build_image_uri(f"runtime-sandbox-{SANDBOX_TYPE}"),
     sandbox_type=SANDBOX_TYPE,
     security_level="medium",
-    timeout=60,
+    timeout=TIMEOUT,
     description="my sandbox",
     environment={
         "TAVILY_API_KEY": os.getenv("TAVILY_API_KEY", ""),

agentscope_runtime/sandbox/custom/example.py

@@ -5,6 +5,7 @@ from ..utils import build_image_uri
 from ..registry import SandboxRegistry
 from ..enums import SandboxType
 from ..box.sandbox import Sandbox
+from ..constant import TIMEOUT
 
 SANDBOX_TYPE = "example"
 
@@ -13,7 +14,7 @@ SANDBOX_TYPE = "example"
     build_image_uri(f"runtime-sandbox-{SANDBOX_TYPE}"),
     sandbox_type=SANDBOX_TYPE,
     security_level="medium",
-    timeout=60,
+    timeout=TIMEOUT,
     description="Example sandbox",
 )
 class ExampleSandbox(Sandbox):

agentscope_runtime/sandbox/enums.py

@@ -68,4 +68,3 @@ class SandboxType(DynamicEnum):
     GUI = "gui"
     APPWORLD = "appworld"
     BFCL = "bfcl"
-    WEBSHOP = "webshop"

agentscope_runtime/sandbox/manager/sandbox_manager.py

@@ -1,39 +1,36 @@
 # -*- coding: utf-8 -*-
 # pylint: disable=redefined-outer-name, protected-access
 # pylint: disable=too-many-branches, too-many-statements
+# pylint: disable=redefined-outer-name, protected-access, too-many-branches
+import inspect
+import json
 import logging
 import os
-import json
 import secrets
-import inspect
 import traceback
-
 from functools import wraps
 from typing import Optional, Dict, Union, List
 
-import shortuuid
 import requests
+import shortuuid
 
-from .container_clients.docker_client import DockerClient
-from .container_clients.kubernetes_client import KubernetesClient
+from ..client import SandboxHttpClient, TrainingSandboxClient
+from ..enums import SandboxType
+from ..manager.storage import (
+    LocalStorage,
+    OSSStorage,
+)
 from ..model import (
     ContainerModel,
     SandboxManagerEnvConfig,
 )
-from ..enums import SandboxType
 from ..registry import SandboxRegistry
-from ..client import SandboxHttpClient, TrainingSandboxClient
-
-from ..manager.collections import (
+from ...common.collections import (
     RedisMapping,
     RedisQueue,
     InMemoryMapping,
     InMemoryQueue,
 )
-from ..manager.storage import (
-    LocalStorage,
-    OSSStorage,
-)
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
@@ -174,11 +171,21 @@ class SandboxManager:
 
         if base_url is None:
             if self.container_deployment == "docker":
+                from ...common.container_clients.docker_client import (
+                    DockerClient,
+                )
+
                 self.client = DockerClient(config=self.config)
             elif self.container_deployment == "k8s":
+                from ...common.container_clients.kubernetes_client import (
+                    KubernetesClient,
+                )
+
                 self.client = KubernetesClient(config=self.config)
             elif self.container_deployment == "agentrun":
-                from .container_clients.agentrun_client import AgentRunClient
+                from ...common.container_clients.agentrun_client import (
+                    AgentRunClient,
+                )
 
                 self.client = AgentRunClient(config=self.config)
             else:
@@ -447,18 +454,17 @@ class SandboxManager:
         else:
             target_sandbox_type = self.default_type[0]
 
-        image = SandboxRegistry.get_image_by_type(target_sandbox_type)
-        if not image:
+        config = SandboxRegistry.get_config_by_type(target_sandbox_type)
+
+        if not config:
             logger.warning(
-                f"No image found for sandbox {target_sandbox_type}, "
-                f"using default",
+                f"Not found sandbox {target_sandbox_type}, " f"using default",
             )
-            image = SandboxRegistry.get_image_by_type(
+            config = SandboxRegistry.get_config_by_type(
                 self.default_type[0],
             )
+        image = config.image_name
 
-        # TODO: enable for timeout for the sandbox (auto cleanup)
-        config = SandboxRegistry.get_config_by_type(target_sandbox_type)
         environment = {
             **(config.environment if config.environment else {}),
             **(environment if environment else {}),
@@ -569,6 +575,7 @@ class SandboxManager:
                 runtime_token=runtime_token,
                 version=image,
                 meta=meta or {},
+                timeout=config.timeout,
             )
 
             # Register in mapping

agentscope_runtime/sandbox/model/container.py

@@ -53,5 +53,11 @@ class ContainerModel(BaseModel):
 
     meta: Optional[Dict] = Field(default_factory=dict)
 
+    timeout: Optional[int] = Field(
+        None,
+        description="Timeout in seconds for container operations",
+        ge=0,
+    )
+
     class Config:
         extra = "allow"

agentscope_runtime/sandbox/registry.py

@@ -42,7 +42,7 @@ class SandboxRegistry:
         sandbox_type: SandboxType | str,
         resource_limits: Dict = None,
         security_level: str = "medium",  # Not used for now
-        timeout: int = 300,
+        timeout: int = 60,
         description: str = "",
         environment: Dict = None,
         runtime_config: Optional[Dict] = None,

agentscope_runtime/sandbox/tools/tool.py

@@ -37,6 +37,10 @@ class Tool(ABC):
         self._name = name
         self._tool_type = tool_type
 
+    @property
+    def __name__(self) -> str:
+        return self.name
+
     @property
     @abstractmethod
     def name(self) -> str:

agentscope_runtime/version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = "v0.1.6"
+__version__ = "v0.2.0"