LocalEnvironment

Bases: SingletonFactory

Local-subprocess backend — the default environment for :class:~autogen.beta.tools.SandboxShellTool.

A :class:~autogen.beta.tools.sandbox.SandboxFactory over a single :class:LocalSandbox with a fixed working directory. Hand it to a tool the same way you would a :class:DockerEnvironment / :class:DaytonaEnvironment::

shell = SandboxShellTool(LocalEnvironment("/tmp/proj"), allowed=["git"])

Commands run via subprocess on the host, so there is no real isolation — that is why :class:SandboxShellTool (which filters commands) defaults to it, but :class:SandboxCodeTool (which runs arbitrary model-written code) does not and requires an explicit backend.

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

def __init__(
    self,
    path: str | os.PathLike[str] | None = None,
    *,
    cleanup: bool | None = None,
    timeout: float = 60,
    max_output: int = 100_000,
    env_vars: dict[str, str] | None = None,
    languages: tuple[CodeLanguage, ...] = ("python", "bash"),
) -> None:
    super().__init__(
        LocalSandbox(
            path,
            cleanup=cleanup,
            timeout=timeout,
            max_output=max_output,
            env_vars=env_vars,
            languages=languages,
        )
    )

sandbox

aclose()

60
61
62
63

async def aclose(self) -> None:
    """Close the underlying :class:`LocalSandbox` (deletes its workdir
    when ``cleanup`` was set). Safe to call multiple times."""
    await self.sandbox.aclose()

open(context=None)

61
62
63
64
65
66
67

@asynccontextmanager
async def open(
    self,
    context: "ConversationContext | None" = None,
) -> AsyncIterator[Sandbox]:
    del context
    yield self._sandbox