Local

Local Environment class

• Read on GitHub

Full source code

import os
import platform
import subprocess
from typing import Any

from pydantic import BaseModel


class LocalEnvironmentConfig(BaseModel):
    cwd: str = ""
    env: dict[str, str] = {}
    timeout: int = 30


class LocalEnvironment:
    def __init__(self, *, config_class: type = LocalEnvironmentConfig, **kwargs):
        """This class executes bash commands directly on the local machine."""
        self.config = config_class(**kwargs)

    def execute(self, command: str, cwd: str = "", *, timeout: int | None = None):
        """Execute a command in the local environment and return the result as a dict."""
        cwd = cwd or self.config.cwd or os.getcwd()
        result = subprocess.run(
            command,
            shell=True,
            text=True,
            cwd=cwd,
            env=os.environ | self.config.env,
            timeout=timeout or self.config.timeout,
            encoding="utf-8",
            errors="replace",
            stdout=subprocess.PIPE,
            stderr=subprocess.STDOUT,
        )
        return {"output": result.stdout, "returncode": result.returncode}

    def get_template_vars(self) -> dict[str, Any]:
        return self.config.model_dump() | platform.uname()._asdict() | os.environ

minisweagent.environments.local

LocalEnvironmentConfig

Bases: BaseModel

cwd class-attribute instance-attribute

cwd: str = ''

env class-attribute instance-attribute

env: dict[str, str] = {}

timeout class-attribute instance-attribute

timeout: int = 30

LocalEnvironment

LocalEnvironment(
    *, config_class: type = LocalEnvironmentConfig, **kwargs
)

This class executes bash commands directly on the local machine.

Source code in src/minisweagent/environments/local.py

def __init__(self, *, config_class: type = LocalEnvironmentConfig, **kwargs):
    """This class executes bash commands directly on the local machine."""
    self.config = config_class(**kwargs)

config instance-attribute

config = config_class(**kwargs)

execute

execute(
    command: str,
    cwd: str = "",
    *,
    timeout: int | None = None,
)

Execute a command in the local environment and return the result as a dict.

Source code in src/minisweagent/environments/local.py

def execute(self, command: str, cwd: str = "", *, timeout: int | None = None):
    """Execute a command in the local environment and return the result as a dict."""
    cwd = cwd or self.config.cwd or os.getcwd()
    result = subprocess.run(
        command,
        shell=True,
        text=True,
        cwd=cwd,
        env=os.environ | self.config.env,
        timeout=timeout or self.config.timeout,
        encoding="utf-8",
        errors="replace",
        stdout=subprocess.PIPE,
        stderr=subprocess.STDOUT,
    )
    return {"output": result.stdout, "returncode": result.returncode}

get_template_vars

get_template_vars() -> dict[str, Any]

Source code in src/minisweagent/environments/local.py

def get_template_vars(self) -> dict[str, Any]:
    return self.config.model_dump() | platform.uname()._asdict() | os.environ

bug_report Something broken/unclear?

Open an issue on GitHub!

help Open-ended discussions

Join our Slack!

Our projects

SWE-agent SWE-ReX SWE-smith SWE-bench CodeClash sb-cli