A programming framework for agentic AI
Add option to auto-delete temporary files in LocalCommandLineCodeExecutor (#6556)
Björn Holtvogtf7a45feca1e9
diff --git a/python/packages/autogen-ext/src/autogen_ext/code_executors/local/__init__.py b/python/packages/autogen-ext/src/autogen_ext/code_executors/local/__init__.pyindex 3b02767cf..5ab7ecc91 100644--- a/python/packages/autogen-ext/src/autogen_ext/code_executors/local/__init__.py+++ b/python/packages/autogen-ext/src/autogen_ext/code_executors/local/__init__.py@@ -39,6 +39,7 @@ class LocalCommandLineCodeExecutorConfig(BaseModel):timeout: int = 60work_dir: Optional[str] = Nonefunctions_module: str = "functions"+ cleanup_temp_files: bool = Trueclass LocalCommandLineCodeExecutor(CodeExecutor, Component[LocalCommandLineCodeExecutorConfig]):@@ -78,6 +79,7 @@ class LocalCommandLineCodeExecutor(CodeExecutor, Component[LocalCommandLineCodeEa default working directory will be used. The default working directory is a temporary directory.functions (List[Union[FunctionWithRequirements[Any, A], Callable[..., Any]]]): A list of functions that are available to the code executor. Default is an empty list.functions_module (str, optional): The name of the module that will be created to store the functions. Defaults to "functions".+ cleanup_temp_files (bool, optional): Whether to automatically clean up temporary files after execution. Defaults to True.virtual_env_context (Optional[SimpleNamespace], optional): The virtual environment context. Defaults to None... note::@@ -154,10 +156,12 @@ $functions"""]] = [],functions_module: str = "functions",+ cleanup_temp_files: bool = True,virtual_env_context: Optional[SimpleNamespace] = None,):if timeout < 1:raise ValueError("Timeout must be greater than or equal to 1.")+ self._timeout = timeoutself._work_dir: Optional[Path] = Noneif work_dir is not None:@@ -174,13 +178,6 @@ $functions"""self._work_dir = work_dirself._work_dir.mkdir(exist_ok=True)- if not functions_module.isidentifier():- raise ValueError("Module name must be a valid Python identifier")-- self._functions_module = functions_module-- self._timeout = timeout-self._functions = functions# Setup could take some time so we intentionally wait for the first code block to do it.if len(functions) > 0:@@ -188,6 +185,11 @@ $functions"""else:self._setup_functions_complete = True+ if not functions_module.isidentifier():+ raise ValueError("Module name must be a valid Python identifier")+ self._functions_module = functions_module++ self._cleanup_temp_files = cleanup_temp_filesself._virtual_env_context: Optional[SimpleNamespace] = virtual_env_contextself._temp_dir: Optional[tempfile.TemporaryDirectory[str]] = None@@ -228,15 +230,6 @@ $functions"""functions="\n\n".join([to_stub(func) for func in self._functions]),)- @property- def functions_module(self) -> str:- """(Experimental) The module name for the functions."""- return self._functions_module-- @property- def functions(self) -> List[str]:- raise NotImplementedError-@propertydef timeout(self) -> int:"""(Experimental) The timeout for code execution."""@@ -254,6 +247,20 @@ $functions"""self._started = Truereturn Path(self._temp_dir.name)+ @property+ def functions(self) -> List[str]:+ raise NotImplementedError++ @property+ def functions_module(self) -> str:+ """(Experimental) The module name for the functions."""+ return self._functions_module++ @property+ def cleanup_temp_files(self) -> bool:+ """(Experimental) Whether to automatically clean up temporary files after execution."""+ return self._cleanup_temp_files+async def _setup_functions(self, cancellation_token: CancellationToken) -> None:func_file_content = build_python_functions_file(self._functions)func_file = self.work_dir / f"{self._functions_module}.py"@@ -446,7 +453,16 @@ $functions"""breakcode_file = str(file_names[0]) if file_names else None- return CommandLineCodeResult(exit_code=exitcode, output=logs_all, code_file=code_file)+ code_result = CommandLineCodeResult(exit_code=exitcode, output=logs_all, code_file=code_file)++ if self._cleanup_temp_files:+ for file in file_names:+ try:+ file.unlink(missing_ok=True)+ except OSError as error:+ logging.error(f"Failed to delete temporary file {file}: {error}")++ return code_resultasync def restart(self) -> None:"""(Experimental) Restart the code executor."""@@ -488,6 +504,7 @@ $functions"""timeout=self._timeout,work_dir=str(self.work_dir),functions_module=self._functions_module,+ cleanup_temp_files=self._cleanup_temp_files,)@classmethod@@ -496,4 +513,5 @@ $functions"""timeout=config.timeout,work_dir=Path(config.work_dir) if config.work_dir is not None else None,functions_module=config.functions_module,+ cleanup_temp_files=config.cleanup_temp_files,)diff --git a/python/packages/autogen-ext/tests/code_executors/test_commandline_code_executor.py b/python/packages/autogen-ext/tests/code_executors/test_commandline_code_executor.pyindex 1f4469591..6ba30da76 100644--- a/python/packages/autogen-ext/tests/code_executors/test_commandline_code_executor.py+++ b/python/packages/autogen-ext/tests/code_executors/test_commandline_code_executor.py@@ -12,6 +12,7 @@ import typesimport venvfrom pathlib import Pathfrom typing import AsyncGenerator, TypeAlias+from unittest.mock import patchimport pytestimport pytest_asyncio@@ -109,7 +110,7 @@ async def executor_and_temp_dir(request: pytest.FixtureRequest,) -> AsyncGenerator[tuple[LocalCommandLineCodeExecutor, str], None]:with tempfile.TemporaryDirectory() as temp_dir:- executor = LocalCommandLineCodeExecutor(work_dir=temp_dir)+ executor = LocalCommandLineCodeExecutor(work_dir=temp_dir, cleanup_temp_files=False)await executor.start()yield executor, temp_dir@@ -399,3 +400,48 @@ async def test_ps1_script(executor_and_temp_dir: ExecutorFixture) -> None:assert result.exit_code == 0assert "hello from powershell!" in result.outputassert result.code_file is not None+++async def test_cleanup_temp_files_behavior() -> None:+ with tempfile.TemporaryDirectory() as temp_dir:+ # Test with cleanup_temp_files=True (default)+ executor = LocalCommandLineCodeExecutor(work_dir=temp_dir, cleanup_temp_files=True)+ await executor.start()+ cancellation_token = CancellationToken()+ code_blocks = [CodeBlock(code="print('cleanup test')", language="python")]+ result = await executor.execute_code_blocks(code_blocks, cancellation_token)+ assert result.exit_code == 0+ assert "cleanup test" in result.output+ # The code file should have been deleted+ assert result.code_file is not None+ assert not Path(result.code_file).exists()++ # Test with cleanup_temp_files=False+ executor = LocalCommandLineCodeExecutor(work_dir=temp_dir, cleanup_temp_files=False)+ await executor.start()+ cancellation_token = CancellationToken()+ code_blocks = [CodeBlock(code="print('no cleanup')", language="python")]+ result = await executor.execute_code_blocks(code_blocks, cancellation_token)+ assert result.exit_code == 0+ assert "no cleanup" in result.output+ # The code file should still exist+ assert result.code_file is not None+ assert Path(result.code_file).exists()+++async def test_cleanup_temp_files_oserror(caplog: pytest.LogCaptureFixture) -> None:+ with tempfile.TemporaryDirectory() as temp_dir:+ executor = LocalCommandLineCodeExecutor(work_dir=temp_dir, cleanup_temp_files=True)+ await executor.start()+ cancellation_token = CancellationToken()+ code_blocks = [CodeBlock(code="print('cleanup test')", language="python")]++ # Patch Path.unlink to raise OSError for this test+ with patch("pathlib.Path.unlink", side_effect=OSError("Mocked OSError")):+ with caplog.at_level("ERROR"):+ await executor.execute_code_blocks(code_blocks, cancellation_token)+ # The code file should have been attempted to be deleted and failed+ assert any("Failed to delete temporary file" in record.message for record in caplog.records)+ assert any("Mocked OSError" in record.message for record in caplog.records)