Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/en/docs/api/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Configuration API

This page lists the configuration data models (Pydantic) for sandboxes and managers. All fields, defaults, and validators are auto-generated from source.

## Manager Configuration

::: ms_enclave.sandbox.model.config.SandboxManagerConfig

::: ms_enclave.sandbox.model.config.VolcengineSandboxManagerConfig

## Sandbox Configuration

::: ms_enclave.sandbox.model.config.SandboxConfig

::: ms_enclave.sandbox.model.config.DockerSandboxConfig

::: ms_enclave.sandbox.model.config.DockerNotebookConfig

::: ms_enclave.sandbox.model.config.VolcengineSandboxConfig

## Tool Configuration

::: ms_enclave.sandbox.model.config.ToolConfig

::: ms_enclave.sandbox.model.config.PythonExecutorConfig

::: ms_enclave.sandbox.model.config.ShellExecutorConfig

::: ms_enclave.sandbox.model.config.FileOperationConfig
2 changes: 2 additions & 0 deletions docs/en/docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ This section is generated by mkdocstrings from the source code and covers the co
- Managers: `SandboxManager`, `SandboxManagerFactory`
- Sandboxes: `Sandbox`, `SandboxFactory`
- Tools: `Tool`, `ToolFactory`
- Configuration: `SandboxManagerConfig`, `SandboxConfig`, `DockerSandboxConfig`, `DockerNotebookConfig`, `VolcengineSandboxConfig`, `VolcengineSandboxManagerConfig`, `ToolConfig`, etc.
- Data models: request/response models (`ExecuteCodeRequest`, `ToolResult`, `SandboxInfo`, ...) and enums (`SandboxStatus`, `SandboxType`, `ExecutionStatus`, ...)

Signatures, parameters, and return values are derived from type hints and docstrings in the code.

Expand Down
39 changes: 39 additions & 0 deletions docs/en/docs/api/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Data Models API

This page lists request, response, and enum data models.

## Enums

::: ms_enclave.sandbox.model.base.SandboxStatus

::: ms_enclave.sandbox.model.base.SandboxType

::: ms_enclave.sandbox.model.base.SandboxManagerType

::: ms_enclave.sandbox.model.base.ExecutionStatus

::: ms_enclave.sandbox.model.base.ToolType

## Request Models

::: ms_enclave.sandbox.model.requests.ExecuteCodeRequest

::: ms_enclave.sandbox.model.requests.ExecuteCommandRequest

::: ms_enclave.sandbox.model.requests.ToolExecutionRequest

::: ms_enclave.sandbox.model.requests.FileOperationRequest

::: ms_enclave.sandbox.model.requests.ReadFileRequest

::: ms_enclave.sandbox.model.requests.WriteFileRequest

## Response Models

::: ms_enclave.sandbox.model.responses.SandboxInfo

::: ms_enclave.sandbox.model.responses.ToolResult

::: ms_enclave.sandbox.model.responses.CommandResult

::: ms_enclave.sandbox.model.responses.HealthCheckResult
2 changes: 2 additions & 0 deletions docs/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ nav:
- Manager: api/manager.md
- Sandbox: api/sandbox.md
- Tools: api/tools.md
- Configuration: api/config.md
- Data Models: api/models.md

theme:
name: material
Expand Down
29 changes: 29 additions & 0 deletions docs/zh/docs/api/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 配置 API

本页列出沙箱与管理器的配置数据模型(基于 Pydantic)。所有字段、默认值与校验规则均从源码自动生成。

## 管理器配置

::: ms_enclave.sandbox.model.config.SandboxManagerConfig

::: ms_enclave.sandbox.model.config.VolcengineSandboxManagerConfig

## 沙箱配置

::: ms_enclave.sandbox.model.config.SandboxConfig

::: ms_enclave.sandbox.model.config.DockerSandboxConfig

::: ms_enclave.sandbox.model.config.DockerNotebookConfig

::: ms_enclave.sandbox.model.config.VolcengineSandboxConfig

## 工具配置

::: ms_enclave.sandbox.model.config.ToolConfig

::: ms_enclave.sandbox.model.config.PythonExecutorConfig

::: ms_enclave.sandbox.model.config.ShellExecutorConfig

::: ms_enclave.sandbox.model.config.FileOperationConfig
2 changes: 2 additions & 0 deletions docs/zh/docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
- 管理器:`SandboxManager`、`SandboxManagerFactory`
- 沙箱:`Sandbox`、`SandboxFactory`
- 工具:`Tool`、`ToolFactory`
- 配置:`SandboxManagerConfig`、`SandboxConfig`、`DockerSandboxConfig`、`DockerNotebookConfig`、`VolcengineSandboxConfig`、`VolcengineSandboxManagerConfig`、`ToolConfig` 等
- 数据模型:请求/响应模型(`ExecuteCodeRequest`、`ToolResult`、`SandboxInfo` 等)与枚举类型(`SandboxStatus`、`SandboxType`、`ExecutionStatus` 等)

使用方式:页面中的签名、参数与返回值来自源码的类型注解与文档字符串,请以源码为准。

Expand Down
39 changes: 39 additions & 0 deletions docs/zh/docs/api/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 数据模型 API

本页列出请求、响应及枚举类型的数据模型。

## 枚举类型

::: ms_enclave.sandbox.model.base.SandboxStatus

::: ms_enclave.sandbox.model.base.SandboxType

::: ms_enclave.sandbox.model.base.SandboxManagerType

::: ms_enclave.sandbox.model.base.ExecutionStatus

::: ms_enclave.sandbox.model.base.ToolType

## 请求模型

::: ms_enclave.sandbox.model.requests.ExecuteCodeRequest

::: ms_enclave.sandbox.model.requests.ExecuteCommandRequest

::: ms_enclave.sandbox.model.requests.ToolExecutionRequest

::: ms_enclave.sandbox.model.requests.FileOperationRequest

::: ms_enclave.sandbox.model.requests.ReadFileRequest

::: ms_enclave.sandbox.model.requests.WriteFileRequest

## 响应模型

::: ms_enclave.sandbox.model.responses.SandboxInfo

::: ms_enclave.sandbox.model.responses.ToolResult

::: ms_enclave.sandbox.model.responses.CommandResult

::: ms_enclave.sandbox.model.responses.HealthCheckResult
2 changes: 2 additions & 0 deletions docs/zh/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ nav:
- 管理器: api/manager.md
- 沙箱: api/sandbox.md
- 工具: api/tools.md
- 配置: api/config.md
- 数据模型: api/models.md

theme:
name: material
Expand Down
2 changes: 1 addition & 1 deletion ms_enclave/sandbox/boxes/docker_notebook.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def build_image():
logger.error(f"[📦 {self.id}] {log['error']}")
return build_logs[0] # Return the built image

await asyncio.get_event_loop().run_in_executor(None, build_image)
await self._run_blocking(build_image)

async def _create_kernel(self) -> None:
"""Create a new kernel and establish websocket connection."""
Expand Down
Loading
Loading