fix: clean up temporary output directory in JupyterCodeExecutor.stop()#7218
Open
veeceey wants to merge 1 commit intomicrosoft:mainfrom
Open
fix: clean up temporary output directory in JupyterCodeExecutor.stop()#7218veeceey wants to merge 1 commit intomicrosoft:mainfrom
veeceey wants to merge 1 commit intomicrosoft:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #7217
JupyterCodeExecutorcreates a temporary directory viatempfile.mkdtemp()when nooutput_diris provided, but never cleans it up instop(). This causes leaked directories and their contents (generated images, HTML files) to accumulate on disk over time.This is inconsistent with every other executor in the codebase (
LocalCommandLineCodeExecutor,DockerCommandLineCodeExecutor,AzureContainerCodeExecutor) which all properly clean up their temporary directories.Changes
tempfile.mkdtemp()withtempfile.TemporaryDirectory()in__init__, matching the pattern used by all other executorscleanup()call instop()to properly clean up the temporary directoryoutput_dirdirectories are not affected (only auto-created temp dirs are cleaned up)_temp_dir_pathfieldTests
Added two new tests:
test_temp_dir_cleanup_on_stop-- verifies the temporary directory is removed afterstop()test_user_provided_output_dir_not_cleaned_up-- verifies user-provided directories are preserved afterstop()