agentrun-sdk 0.0.4__py3-none-any.whl

agentrun/sandbox/api/__code_interpreter_data_async_template.py

@@ -0,0 +1,206 @@
+"""代码解释器沙箱数据API模板 / Code Interpreter Sandbox Data API Template
+
+此模板用于生成代码解释器沙箱数据API代码。
+This template is used to generate code interpreter sandbox data API code.
+"""
+
+from typing import Any, Dict, Optional
+
+from agentrun.sandbox.model import CodeLanguage
+from agentrun.utils.config import Config
+
+from .sandbox_data import SandboxDataAPI
+
+
+class CodeInterpreterDataAPI(SandboxDataAPI):
+
+    def __init__(
+        self,
+        sandbox_id: str,
+        config: Optional[Config] = None,
+    ):
+
+        super().__init__(
+            sandbox_id=sandbox_id,
+            config=config,
+        )
+
+    async def list_directory_async(
+        self,
+        path: Optional[str] = None,
+        depth: Optional[int] = None,
+    ):
+        query = {}
+        if path is not None:
+            query["path"] = path
+        if depth is not None:
+            query["depth"] = depth
+
+        return await self.get_async("/filesystem", query=query)
+
+    async def stat_async(
+        self,
+        path: str,
+    ):
+        query = {
+            "path": path,
+        }
+        return await self.get_async("/filesystem/stat", query=query)
+
+    async def mkdir_async(
+        self,
+        path: str,
+        parents: Optional[bool] = True,
+        mode: Optional[str] = "0755",
+    ):
+        data = {
+            "path": path,
+            "parents": parents,
+            "mode": mode,
+        }
+        return await self.post_async("/filesystem/mkdir", data=data)
+
+    async def move_file_async(
+        self,
+        source: str,
+        destination: str,
+    ):
+        data = {
+            "source": source,
+            "destination": destination,
+        }
+        return await self.post_async("/filesystem/move", data=data)
+
+    async def remove_file_async(
+        self,
+        path: str,
+    ):
+        data = {
+            "path": path,
+        }
+        return await self.post_async("/filesystem/remove", data=data)
+
+    async def list_contexts_async(self):
+        return await self.get_async("/contexts")
+
+    async def create_context_async(
+        self,
+        language: Optional[CodeLanguage] = CodeLanguage.PYTHON,
+        cwd: str = "/home/user",
+    ):
+        # Validate language parameter
+        if language not in ("python", "javascript"):
+            raise ValueError(
+                f"language must be 'python' or 'javascript', got: {language}"
+            )
+
+        data: Dict[str, Any] = {
+            "cwd": cwd,
+            "language": language,
+        }
+        return await self.post_async("/contexts", data=data)
+
+    async def get_context_async(
+        self,
+        context_id: str,
+    ):
+        return await self.get_async(f"/contexts/{context_id}")
+
+    async def execute_code_async(
+        self,
+        code: str,
+        context_id: Optional[str],
+        language: Optional[CodeLanguage] = None,
+        timeout: Optional[int] = 30,
+    ):
+        if language and language not in ("python", "javascript"):
+            raise ValueError(
+                f"language must be 'python' or 'javascript', got: {language}"
+            )
+
+        data: Dict[str, Any] = {
+            "code": code,
+        }
+        if timeout is not None:
+            data["timeout"] = timeout
+        if language is not None:
+            data["language"] = language
+        if context_id is not None:
+            data["contextId"] = context_id
+        return await self.post_async(f"/contexts/execute", data=data)
+
+    async def delete_context_async(
+        self,
+        context_id: str,
+    ):
+        return await self.delete_async(f"/contexts/{context_id}")
+
+    async def read_file_async(
+        self,
+        path: str,
+    ):
+        query = {
+            "path": path,
+        }
+        return await self.get_async("/files", query=query)
+
+    async def write_file_async(
+        self,
+        path: str,
+        content: str,
+        mode: Optional[str] = "644",
+        encoding: Optional[str] = "utf-8",
+        create_dir: Optional[bool] = True,
+    ):
+        data = {
+            "path": path,
+            "content": content,
+            "mode": mode,
+            "encoding": encoding,
+            "createDir": create_dir,
+        }
+        return await self.post_async("/files", data=data)
+
+    async def upload_file_async(
+        self,
+        local_file_path: str,
+        target_file_path: str,
+    ):
+        return await self.post_file_async(
+            path="/filesystem/upload",
+            local_file_path=local_file_path,
+            target_file_path=target_file_path,
+        )
+
+    async def download_file_async(
+        self,
+        path: str,
+        save_path: str,
+    ):
+        query = {"path": path}
+        return await self.get_file_async(
+            path="/filesystem/download", save_path=save_path, query=query
+        )
+
+    async def cmd_async(
+        self,
+        command: str,
+        cwd: str,
+        timeout: Optional[int] = 30,
+    ):
+        data: Dict[str, Any] = {
+            "command": command,
+            "cwd": cwd,
+        }
+        if timeout is not None:
+            data["timeout"] = timeout
+        return await self.post_async("/processes/cmd", data=data)
+
+    async def list_processes_async(self):
+        return await self.get_async("/processes")
+
+    async def get_process_async(self, pid: str):
+        return await self.get_async(f"/processes/{pid}")
+
+    async def kill_process_async(self, pid: str):
+        return await self.delete_async(f"/processes/{pid}")

agentrun/sandbox/api/__init__.py

@@ -0,0 +1,17 @@
+"""Sandbox API 模块 / Sandbox API Module
+
+此模块包含沙箱环境的 API 接口。
+This module contains API interfaces for sandbox environments.
+"""
+
+from .browser_data import BrowserDataAPI
+from .code_interpreter_data import CodeInterpreterDataAPI
+from .control import SandboxControlAPI
+from .sandbox_data import SandboxDataAPI
+
+__all__ = [
+    "SandboxControlAPI",
+    "SandboxDataAPI",
+    "CodeInterpreterDataAPI",
+    "BrowserDataAPI",
+]

agentrun/sandbox/api/__sandbox_data_async_template.py

@@ -0,0 +1,100 @@
+"""Sandbox数据API模板 / Sandbox Data API Template
+
+此模板用于生成沙箱数据API代码。
+This template is used to generate sandbox data API code.
+"""
+
+from typing import Optional
+
+from agentrun.utils.config import Config
+from agentrun.utils.data_api import DataAPI, ResourceType
+
+
+class SandboxDataAPI(DataAPI):
+
+    def __init__(
+        self,
+        *,
+        sandbox_id: Optional[str] = None,
+        template_name: Optional[str] = None,
+        config: Optional[Config] = None,
+    ):
+
+        super().__init__(
+            resource_name="",
+            resource_type=ResourceType.Template,
+            namespace="sandboxes",
+            config=config,
+        )
+        self.access_token_map = {}
+
+        if sandbox_id or template_name:
+            self.__refresh_access_token(
+                sandbox_id=sandbox_id,
+                template_name=template_name,
+                config=config,
+            )
+
+    def __refresh_access_token(
+        self,
+        *,
+        sandbox_id: Optional[str] = None,
+        template_name: Optional[str] = None,
+        config: Optional[Config] = None,
+    ):
+        cfg = Config.with_configs(config, self.config)
+        token = self.access_token_map.get(sandbox_id or template_name)
+        if sandbox_id:
+            self.resource_name = sandbox_id
+            self.resource_type = ResourceType.Sandbox
+            self.namespace = f"sandboxes/{sandbox_id}"
+        else:
+            self.resource_name = template_name
+            self.resource_type = ResourceType.Template
+            self.namespace = "sandboxes"
+
+        if token:
+            self.access_token = token
+            return
+
+        # 没有缓存过的 token
+
+        self.access_token = None
+        self.auth(config=cfg)
+        self.access_token_map[sandbox_id or template_name] = self.access_token
+
+    async def check_health_async(self):
+        return await self.get_async("/health")
+
+    async def create_sandbox_async(
+        self,
+        template_name: str,
+        sandbox_idle_timeout_seconds: Optional[int] = 600,
+        config: Optional[Config] = None,
+    ):
+        self.__refresh_access_token(template_name=template_name, config=config)
+        return await self.post_async(
+            "/",
+            data={
+                "templateName": template_name,
+                "sandboxIdleTimeoutSeconds": sandbox_idle_timeout_seconds,
+            },
+        )
+
+    async def delete_sandbox_async(
+        self, sandbox_id: str, config: Optional[Config] = None
+    ):
+        self.__refresh_access_token(sandbox_id=sandbox_id, config=config)
+        return await self.delete_async("/")
+
+    async def stop_sandbox_async(
+        self, sandbox_id: str, config: Optional[Config] = None
+    ):
+        self.__refresh_access_token(sandbox_id=sandbox_id, config=config)
+        return await self.post_async("/stop")
+
+    async def get_sandbox_async(
+        self, sandbox_id: str, config: Optional[Config] = None
+    ):
+        self.__refresh_access_token(sandbox_id=sandbox_id, config=config)
+        return await self.get_async("/")

agentrun/sandbox/api/browser_data.py

@@ -0,0 +1,172 @@
+"""
+This file is auto generated by the code generation script.
+Do not modify this file manually.
+Use the `make codegen` command to regenerate.
+
+当前文件为自动生成的控制 API 客户端代码。请勿手动修改此文件。
+使用 `make codegen` 命令重新生成。
+
+source: agentrun/sandbox/api/__browser_data_async_template.py
+
+浏览器沙箱数据API模板 / Browser Sandbox Data API Template
+
+此模板用于生成浏览器沙箱数据API代码。
+This template is used to generate browser sandbox data API code.
+"""
+
+from typing import Optional
+from urllib.parse import parse_qs, urlencode, urlparse
+
+from agentrun.utils.config import Config
+
+from .sandbox_data import SandboxDataAPI
+
+
+class BrowserDataAPI(SandboxDataAPI):
+
+    def __init__(
+        self,
+        sandbox_id: str,
+        config: Optional[Config] = None,
+    ):
+        self.sandbox_id = sandbox_id
+        super().__init__(
+            sandbox_id=sandbox_id,
+            config=config,
+        )
+
+    def get_cdp_url(self, record: Optional[bool] = False):
+        """
+        Generate the WebSocket URL for Chrome DevTools Protocol (CDP) connection.
+
+        This method constructs a WebSocket URL by:
+        1. Converting the HTTP endpoint to WebSocket protocol (ws://)
+        2. Parsing the existing URL and query parameters
+        3. Adding the session ID to the query parameters
+        4. Reconstructing the complete WebSocket URL
+
+        Returns:
+            str: The complete WebSocket URL for CDP automation connection,
+                 including the session ID in the query parameters.
+
+        Example:
+            >>> api = BrowserDataAPI("browser123", "session456")
+            >>> api.get_cdp_url()
+            'ws://example.com/ws/automation?sessionId=session456'
+        """
+        cdp_url = self.with_path("/ws/automation").replace("http", "ws")
+        u = urlparse(cdp_url)
+        query_dict = parse_qs(u.query)
+        query_dict["tenantId"] = [self.config.get_account_id()]
+        if record:
+            query_dict["recording"] = ["true"]
+        new_query = urlencode(query_dict, doseq=True)
+        new_u = u._replace(query=new_query)
+        return new_u.geturl()
+
+    def get_vnc_url(self, record: Optional[bool] = False):
+        """
+        Generate the WebSocket URL for VNC (Virtual Network Computing) live view connection.
+
+        This method constructs a WebSocket URL for real-time browser viewing by:
+        1. Converting the HTTP endpoint to WebSocket protocol (ws://)
+        2. Parsing the existing URL and query parameters
+        3. Adding the session ID to the query parameters
+        4. Reconstructing the complete WebSocket URL
+
+        Returns:
+            str: The complete WebSocket URL for VNC live view connection,
+                 including the session ID in the query parameters.
+
+        Example:
+            >>> api = BrowserDataAPI("browser123", "session456")
+            >>> api.get_vnc_url()
+            'ws://example.com/ws/liveview?sessionId=session456'
+        """
+        vnc_url = self.with_path("/ws/liveview").replace("http", "ws")
+        u = urlparse(vnc_url)
+        query_dict = parse_qs(u.query)
+        query_dict["tenantId"] = [self.config.get_account_id()]
+        if record:
+            query_dict["recording"] = ["true"]
+        new_query = urlencode(query_dict, doseq=True)
+        new_u = u._replace(query=new_query)
+        return new_u.geturl()
+
+    def sync_playwright(
+        self,
+        browser_type: str = "chrome",
+        record: Optional[bool] = False,
+        config: Optional[Config] = None,
+    ):
+        from .playwright_sync import BrowserPlaywrightSync
+
+        cfg = Config.with_configs(self.config, config)
+        _, headers, _ = self.auth(headers=cfg.get_headers(), config=cfg)
+        return BrowserPlaywrightSync(
+            self.get_cdp_url(record=record),
+            browser_type=browser_type,
+            headers=headers,
+        )
+
+    def async_playwright(
+        self,
+        browser_type: str = "chrome",
+        record: Optional[bool] = False,
+        config: Optional[Config] = None,
+    ):
+        from .playwright_async import BrowserPlaywrightAsync
+
+        cfg = Config.with_configs(self.config, config)
+        _, headers, _ = self.auth(headers=cfg.get_headers(), config=cfg)
+        return BrowserPlaywrightAsync(
+            self.get_cdp_url(record=record),
+            browser_type=browser_type,
+            headers=headers,
+        )
+
+    async def list_recordings_async(self):
+        return await self.get_async("/recordings")
+
+    def list_recordings(self):
+        return self.get("/recordings")
+
+    async def delete_recording_async(self, filename: str):
+        return await self.delete_async(f"/recordings/{filename}")
+
+    def delete_recording(self, filename: str):
+        return self.delete(f"/recordings/{filename}")
+
+    async def download_recording_async(self, filename: str, save_path: str):
+        """
+        Asynchronously download a recording video file and save it to local path.
+
+        Args:
+            filename: The name of the recording file to download
+            save_path: Local file path to save the downloaded video file (.mkv)
+
+        Returns:
+            Dictionary with 'saved_path' and 'size' keys
+
+        Examples:
+            >>> await api.download_recording_async("recording.mp4", "/local/video.mkv")
+        """
+        return await self.get_video_async(
+            f"/recordings/{filename}", save_path=save_path
+        )
+
+    def download_recording(self, filename: str, save_path: str):
+        """
+        Synchronously download a recording video file and save it to local path.
+
+        Args:
+            filename: The name of the recording file to download
+            save_path: Local file path to save the downloaded video file (.mkv)
+
+        Returns:
+            Dictionary with 'saved_path' and 'size' keys
+
+        Examples:
+            >>> api.download_recording("recording.mp4", "/local/video.mkv")
+        """
+        return self.get_video(f"/recordings/{filename}", save_path=save_path)