Skip to content

docker

docker

AgentLike

backend instance-attribute 

backend: Any

name instance-attribute 

name: str

CommandResult

command class-attribute instance-attribute 

command: list[str] = Field(default_factory=list)

duration_ms class-attribute instance-attribute 

duration_ms: int | None = None

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

returncode instance-attribute 

returncode: int

stderr class-attribute instance-attribute 

stderr: str = ''

stdout class-attribute instance-attribute 

stdout: str = ''

DockerSandbox

docker_args class-attribute instance-attribute 

docker_args: list[str] = Field(default_factory=list)

env class-attribute instance-attribute 

env: dict[str, str] = Field(default_factory=dict)

id class-attribute instance-attribute 

id: str = 'docker'

image class-attribute instance-attribute 

image: str = 'python:3.12-slim'

model_config class-attribute instance-attribute 

model_config = ConfigDict(arbitrary_types_allowed=True)

name class-attribute instance-attribute 

name: str | None = None

remove_on_exit class-attribute instance-attribute 

remove_on_exit: bool = True

workdir class-attribute instance-attribute 

workdir: str = '/workspace'

workspace instance-attribute 

workspace: Path

cleanup 

cleanup(session: SandboxSession) -> None

collect 

collect(session: SandboxSession) -> RunArtifacts

prepare 

prepare(
    agent: AgentLike, run_config: RunConfigLike | None
) -> SandboxSession

run 

run(
    session: SandboxSession, command: list[str]
) -> CommandResult

RunArtifacts

artifacts class-attribute instance-attribute 

artifacts: list[Artifact] = Field(default_factory=list)

diff class-attribute instance-attribute 

diff: str | None = None

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

RunConfigLike

SandboxSession

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

sandbox_name class-attribute instance-attribute 

sandbox_name: str | None = None

workspace instance-attribute 

workspace: Path

WorkspaceFileMixin

workspace instance-attribute 

workspace: Path

delete_file 

delete_file(path: str | Path) -> None

get_bytes 

get_bytes(path: str | Path) -> bytes

get_file 

get_file(
    path: str | Path, *, encoding: str = "utf-8"
) -> str

list_files 

list_files(pattern: str = '**/*') -> list[Path]

put_bytes 

put_bytes(path: str | Path, content: bytes) -> Path

put_file 

put_file(
    path: str | Path,
    content: str,
    *,
    encoding: str = "utf-8",
) -> Path

_stream_filter 

_stream_filter(
    run_config: RunConfigLike | None,
) -> object | None

collect_git_diff 

collect_git_diff(workspace: Path) -> str | None

run_command 

run_command(
    command: list[str],
    *,
    cwd: Path | None = None,
    env: Mapping[str, str] | None = None,
    input_text: str | None = None,
    timeout: int | None = None,
    stream: bool = False,
    stream_filter: StreamFilter | None = None,
) -> CommandResult