scalebox-sdk 0.1.0__py3-none-any.whl

scalebox/cli.py

@@ -0,0 +1,125 @@
+"""
+Command-line interface for ScaleBox Python SDK
+"""
+
+import argparse
+import asyncio
+import sys
+from typing import Optional
+
+from . import __version__
+from .code_interpreter import AsyncSandbox, Sandbox
+from .connection_config import ConnectionConfig
+
+
+def create_parser() -> argparse.ArgumentParser:
+    """Create the command-line argument parser."""
+    parser = argparse.ArgumentParser(
+        prog="scalebox",
+        description="ScaleBox Python SDK - Multi-language code execution sandbox",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"ScaleBox Python SDK {__version__}",
+    )
+
+    subparsers = parser.add_subparsers(dest="command", help="Available commands")
+
+    # Sandbox command
+    sandbox_parser = subparsers.add_parser("sandbox", help="Sandbox operations")
+    sandbox_parser.add_argument(
+        "--create", action="store_true", help="Create a new sandbox"
+    )
+    sandbox_parser.add_argument("--list", action="store_true", help="List sandboxes")
+    sandbox_parser.add_argument("--destroy", help="Destroy a sandbox by ID")
+
+    # Code execution command
+    exec_parser = subparsers.add_parser("exec", help="Execute code")
+    exec_parser.add_argument("--code", required=True, help="Code to execute")
+    exec_parser.add_argument(
+        "--language", default="python", help="Programming language"
+    )
+    exec_parser.add_argument("--sandbox-id", help="Sandbox ID to use")
+    exec_parser.add_argument(
+        "--async-mode", action="store_true", help="Use async execution"
+    )
+
+    # Configuration
+    parser.add_argument("--api-key", help="API key for authentication")
+    parser.add_argument("--domain", help="API domain")
+    parser.add_argument("--debug", action="store_true", help="Enable debug mode")
+
+    return parser
+
+
+async def async_main():
+    """Async main function."""
+    parser = create_parser()
+    args = parser.parse_args()
+
+    if not args.command:
+        parser.print_help()
+        return
+
+    # Create connection config
+    config = ConnectionConfig(
+        api_key=args.api_key,
+        domain=args.domain,
+        debug=args.debug,
+    )
+
+    if args.command == "sandbox":
+        if args.create:
+            print("Creating sandbox...")
+            if args.async_mode:
+                sandbox = await AsyncSandbox.create()
+                print(f"Created async sandbox: {sandbox.id}")
+            else:
+                sandbox = Sandbox.create()
+                print(f"Created sandbox: {sandbox.id}")
+        elif args.list:
+            print("Listing sandboxes...")
+            # TODO: Implement sandbox listing
+            print("Sandbox listing not implemented yet")
+        elif args.destroy:
+            print(f"Destroying sandbox: {args.destroy}")
+            # TODO: Implement sandbox destruction
+            print("Sandbox destruction not implemented yet")
+
+    elif args.command == "exec":
+        print(f"Executing {args.language} code...")
+        print(f"Code: {args.code}")
+
+        if args.async_mode:
+            sandbox = await AsyncSandbox.create()
+            try:
+                result = await sandbox.run_code(args.code, language=args.language)
+                print(f"Result: {result.logs.stdout}")
+            finally:
+                await sandbox.close()
+        else:
+            sandbox = Sandbox.create()
+            try:
+                result = sandbox.run_code(args.code, language=args.language)
+                print(f"Result: {result.logs.stdout}")
+            finally:
+                sandbox.close()
+
+
+def main():
+    """Main entry point."""
+    try:
+        asyncio.run(async_main())
+    except KeyboardInterrupt:
+        print("\nOperation cancelled by user")
+        sys.exit(1)
+    except Exception as e:
+        print(f"Error: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

scalebox/client/aclient.py

@@ -0,0 +1,57 @@
+# import sys, os
+# sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../scalebox'))
+import asyncio
+
+import aiohttp
+from generated import api_pb2
+from generated.api_pb2_connect import AsyncFilesystemClient
+
+
+async def watch_directory_example():
+    # 创建 aiohttp 客户端会话
+    async with aiohttp.ClientSession() as session:
+        # 创建文件系统客户端
+        client = AsyncFilesystemClient(
+            base_url="http://localhost:8080",
+            http_client=session,
+            # protocol=ConnectProtocol.CONNECT_PROTOBUF  # 如果需要指定协议
+        )
+
+        # 创建监视请求
+        request = api_pb2.WatchDirRequest(path="/root")
+
+        # 可选：添加额外的请求头
+        extra_headers = {
+            "Authorization": "Bearer root",
+            "X-Custom-Header": "custom-value",
+        }
+
+        try:
+            # 使用 async for 循环处理流式响应
+            async for response in client.watch_dir(
+                request, extra_headers=extra_headers
+            ):
+                print(f"Received event: {response}")
+                # 在这里处理每个事件
+                # 例如，根据事件类型执行不同的操作
+
+                # 如果收到特定事件，可以中断循环
+                # if response.event_type == api_pb2.WatchDirResponse.EVENT_TYPE_STOP:
+                #     break
+
+        except Exception as e:
+            print(f"Error during directory watching: {e}")
+
+        finally:
+            # 关闭会话（在 with 语句中会自动关闭，但这里为了清晰展示）
+            await session.close()
+
+
+async def main():
+    # 运行监视示例
+    await watch_directory_example()
+
+
+if __name__ == "__main__":
+    # 运行异步主函数
+    asyncio.run(main())

scalebox/client/api.proto

@@ -0,0 +1,460 @@
+syntax = "proto3";
+package sandboxagent;
+import "google/protobuf/timestamp.proto";
+option go_package = "./pb";
+
+
+service Filesystem {
+  rpc Stat(StatRequest) returns (StatResponse);
+  rpc MakeDir(MakeDirRequest) returns (MakeDirResponse);
+  rpc Move(MoveRequest) returns (MoveResponse);
+  rpc ListDir(ListDirRequest) returns (ListDirResponse);
+  rpc Remove(RemoveRequest) returns (RemoveResponse);
+
+  rpc WatchDir(WatchDirRequest) returns (stream WatchDirResponse);
+
+  // Non-streaming versions of WatchDir
+  rpc CreateWatcher(CreateWatcherRequest) returns (CreateWatcherResponse);
+  rpc GetWatcherEvents(GetWatcherEventsRequest) returns (GetWatcherEventsResponse);
+  rpc RemoveWatcher(RemoveWatcherRequest) returns (RemoveWatcherResponse);
+}
+
+message MoveRequest {
+  string source = 1;
+  string destination = 2;
+}
+
+message MoveResponse {
+  EntryInfo entry = 1;
+}
+
+message MakeDirRequest {
+  string path = 1;
+}
+
+message MakeDirResponse {
+  EntryInfo entry = 1;
+}
+
+message RemoveRequest {
+  string path = 1;
+}
+
+message RemoveResponse {}
+
+message StatRequest {
+  string path = 1;
+}
+
+message StatResponse {
+  EntryInfo entry = 1;
+}
+
+message EntryInfo {
+  string name = 1;
+  FileType type = 2;
+  string path = 3;
+  int64 size = 4;
+  uint32 mode = 5;
+  string permissions = 6;
+  string owner = 7;
+  string group = 8;
+  google.protobuf.Timestamp modified_time = 9;
+  // If the entry is a symlink, this field contains the target of the symlink.
+  optional string symlink_target = 10;
+}
+
+enum FileType {
+  FILE_TYPE_UNSPECIFIED = 0;
+  FILE_TYPE_FILE = 1;
+  FILE_TYPE_DIRECTORY = 2;
+}
+
+message ListDirRequest {
+  string path = 1;
+  uint32 depth = 2;
+}
+
+message ListDirResponse {
+  repeated EntryInfo entries = 1;
+}
+
+message WatchDirRequest {
+  string path = 1;
+  bool recursive = 2;
+}
+
+message FilesystemEvent {
+  string name = 1;
+  EventType type = 2;
+}
+
+message WatchDirResponse {
+  oneof event {
+    StartEvent start = 1;
+    FilesystemEvent filesystem = 2;
+    KeepAlive keepalive = 3;
+  }
+
+  message StartEvent {}
+
+  message KeepAlive {}
+}
+
+message CreateWatcherRequest {
+  string path = 1;
+  bool recursive = 2;
+}
+
+message CreateWatcherResponse {
+  string watcher_id = 1;
+}
+
+message GetWatcherEventsRequest {
+  string watcher_id = 1;
+}
+
+message GetWatcherEventsResponse {
+  repeated FilesystemEvent events = 1;
+}
+
+message RemoveWatcherRequest {
+  string watcher_id = 1;
+}
+
+message RemoveWatcherResponse {}
+
+enum EventType {
+  EVENT_TYPE_UNSPECIFIED = 0;
+  EVENT_TYPE_CREATE = 1;
+  EVENT_TYPE_WRITE = 2;
+  EVENT_TYPE_REMOVE = 3;
+  EVENT_TYPE_RENAME = 4;
+  EVENT_TYPE_CHMOD = 5;
+}
+
+
+service Process {
+  rpc List(ListRequest) returns (ListResponse);
+
+  rpc Connect(ConnectRequest) returns (stream ConnectResponse);
+  rpc Start(StartRequest) returns (stream StartResponse);
+
+  rpc Update(UpdateRequest) returns (UpdateResponse);
+
+  // Client input stream ensures ordering of messages
+  rpc StreamInput(stream StreamInputRequest) returns (StreamInputResponse);
+  rpc SendInput(SendInputRequest) returns (SendInputResponse);
+  rpc SendSignal(SendSignalRequest) returns (SendSignalResponse);
+}
+
+message PTY {
+  Size size = 1;
+
+  message Size {
+    uint32 cols = 1;
+    uint32 rows = 2;
+  }
+}
+
+message ProcessConfig {
+  string cmd = 1;
+  repeated string args = 2;
+
+  map<string, string> envs = 3;
+  optional string cwd = 4;
+}
+
+message ListRequest {}
+
+message ProcessInfo {
+  ProcessConfig config = 1;
+  uint32 pid = 2;
+  optional string tag = 3;
+}
+
+message ListResponse {
+  repeated ProcessInfo processes = 1;
+}
+
+message StartRequest {
+  ProcessConfig process = 1;
+  optional PTY pty = 2;
+  optional string tag = 3;
+}
+
+message UpdateRequest {
+  ProcessSelector process = 1;
+
+  optional PTY pty = 2;
+}
+
+message UpdateResponse {}
+
+message ProcessEvent {
+  oneof event {
+    StartEvent start = 1;
+    DataEvent data = 2;
+    EndEvent end = 3;
+    KeepAlive keepalive = 4;
+  }
+
+  message StartEvent {
+    uint32 pid = 1;
+  }
+
+  message DataEvent {
+    oneof output {
+      bytes stdout = 1;
+      bytes stderr = 2;
+      bytes pty = 3;
+    }
+  }
+
+  message EndEvent {
+    sint32 exit_code = 1;
+    bool exited = 2;
+    string status = 3;
+    optional string error = 4;
+  }
+
+  message KeepAlive {}
+}
+
+message StartResponse {
+  ProcessEvent event = 1;
+}
+
+message ConnectResponse {
+  ProcessEvent event = 1;
+}
+
+message SendInputRequest {
+  ProcessSelector process = 1;
+
+  ProcessInput input = 2;
+}
+
+message SendInputResponse {}
+
+message ProcessInput {
+  oneof input {
+    bytes stdin = 1;
+    bytes pty = 2;
+  }
+}
+
+message StreamInputRequest {
+  oneof event {
+    StartEvent start = 1;
+    DataEvent data = 2;
+    KeepAlive keepalive = 3;
+  }
+
+  message StartEvent {
+    ProcessSelector process = 1;
+  }
+
+  message DataEvent {
+    ProcessInput input = 2;
+  }
+
+  message KeepAlive {}
+}
+
+message StreamInputResponse {}
+
+enum Signal {
+  SIGNAL_UNSPECIFIED = 0;
+  SIGNAL_SIGTERM = 15;
+  SIGNAL_SIGKILL = 9;
+}
+
+message SendSignalRequest {
+  ProcessSelector process = 1;
+
+  Signal signal = 2;
+}
+
+message SendSignalResponse {}
+
+message ConnectRequest {
+  ProcessSelector process = 1;
+}
+
+message ProcessSelector {
+  oneof selector {
+    uint32 pid = 1;
+    string tag = 2;
+  }
+}
+
+service ExecutionService {
+  // 执行代码接口 (HTTP POST /execute)
+  rpc Execute(ExecuteRequest) returns (stream ExecuteResponse) {}
+}
+
+service ContextService {
+  // 创建执行上下文 (HTTP POST /contexts)
+  rpc CreateContext(CreateContextRequest) returns (Context) {}
+
+  // 销毁执行上下文 (HTTP DELETE /contexts/{id})
+  rpc DestroyContext(DestroyContextRequest) returns (DestroyContextResponse) {}
+}
+
+// ========== 执行请求 ==========
+message ExecuteRequest {
+  string context_id = 1;    // 执行上下文ID
+  string code = 2;          // 要执行的代码
+  string language = 3;      // 编程语言 (e.g., "python", "javascript")
+  map<string, string> env_vars = 4;  // 环境变量 (字典格式)
+}
+
+// ========== 流式响应事件 ==========
+message ExecuteResponse {
+  oneof event {
+    Output stdout = 1;       // 标准输出事件
+    Output stderr = 2;       // 标准错误事件
+    Result result = 3;       // 最终结果事件
+    Error error = 4;         // 错误事件
+  }
+}
+
+// 输出内容
+message Output {
+  string content = 1;       // 输出内容
+}
+
+// 执行结果
+message Result {
+  int32 exit_code = 1;      // 进程退出码
+  google.protobuf.Timestamp started_at = 2;  // 开始时间
+  google.protobuf.Timestamp finished_at = 3; // 结束时间
+  // 多种输出格式
+  string text = 4;
+  string html = 5;
+  string markdown = 6;
+  string svg = 7;
+  string png = 8;
+  string jpeg = 9;
+  string pdf = 10;
+  string latex = 11;
+  string json = 12;
+  string javascript = 13;
+  string data = 14;
+  Chart chart =15;
+
+  // 执行计数
+  int32 execution_count = 16;
+
+  // 是否为主要结果
+  bool is_main_result = 17;
+
+  // 额外数据
+  map<string, string> extra = 18;
+}
+
+// 错误信息
+message Error {
+  string name = 1;       // 错误消息
+  string value = 2;          // 错误类型
+  string traceback = 3;
+}
+
+message Chart {
+  string type = 1;
+  string title = 2;
+  repeated ChartElement elements = 3;
+  map<string, string> extra = 4;
+}
+
+message ChartElement {
+  oneof element {
+    PointData point_data = 1;
+    BarData bar_data = 2;
+    PieData pie_data = 3;
+    BoxAndWhiskerData box_whisker_data = 4;
+    Chart nested_chart = 5;
+  }
+}
+
+message PointData {
+  string label = 1;
+  repeated Point points = 2;
+}
+
+message Point {
+  oneof x_value {
+    string x_str = 1;
+    double x_num = 2;
+  }
+  oneof y_value {
+    string y_str = 3;
+    double y_num = 4;
+  }
+}
+
+message BarData {
+  string label = 1;
+  string group = 2;
+  string value = 3;
+}
+
+message PieData {
+  string label = 1;
+  double angle = 2;
+  double radius = 3;
+}
+
+message BoxAndWhiskerData {
+  string label = 1;
+  double min = 2;
+  double first_quartile = 3;
+  double median = 4;
+  double third_quartile = 5;
+  double max = 6;
+  repeated double outliers = 7;
+}
+
+message Chart2D {
+  string x_label = 1;
+  string y_label = 2;
+  string x_unit = 3;
+  string y_unit = 4;
+  Chart chart = 5;
+}
+
+message PointChart {
+  repeated string x_ticks = 1;
+  repeated string x_tick_labels = 2;
+  string x_scale = 3;
+  repeated string y_ticks = 4;
+  repeated string y_tick_labels = 5;
+  string y_scale = 6;
+  Chart2D chart_2d = 7;
+}
+
+// ========== 上下文管理 ==========
+// 创建上下文请求
+message CreateContextRequest {
+  string language = 1;      // 编程语言 (可选)
+  string cwd = 2;           // 工作目录 (可选)
+  // 注意: 根据您的代码，env_vars 未在创建上下文时使用
+}
+
+// 创建上下文响应
+message Context {
+  string id = 1;          // 上下文唯一ID
+  string language = 2;    // 编程语言
+  string cwd = 3;         // 工作目录
+  google.protobuf.Timestamp created_at = 4;  // 创建时间
+  map<string, string> env_vars = 5;  // 当前环境变量
+}
+
+message DestroyContextRequest {
+  string context_id = 1;  // 要销毁的上下文ID
+}
+
+message DestroyContextResponse {
+  bool success = 1;
+}

scalebox/client/buf.gen.yaml

@@ -0,0 +1,8 @@
+version: v2
+plugins:
+  - remote: buf.build/protocolbuffers/python
+    out: ./generated
+  - remote: buf.build/protocolbuffers/pyi
+    out: ./generated
+  - local: protoc-gen-connect_python
+    out: ./generated