fix: remove empty project_name dir after env prune#2246
Open
terminalchai wants to merge 2 commits into
Open
Conversation
When using the standard storage layout (data_dir/project_name/project_id/venv), hatch env prune would remove the project_id directory but leave the parent project_name directory behind (e.g. %LOCALAPPDATA%\hatch\env\virtual\myproject). After removing storage_path (project_id dir), also remove its parent (project_name dir) if it is now empty and is not the data_directory itself. Fixes pypa#737
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
2 participants
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 #737
hatch env prune removes individual environment directories (data_dir/project_name/project_id/venv_name) and then cleans up the project_id directory if empty, but it never cleans up the parent project_name directory. This leaves a stale directory behind in %LOCALAPPDATA%\hatch\env\virtual\ (or equivalent on other platforms) even after all environments for a project have been removed.
Root Cause
In VirtualEnvironment.remove(), after removing storage_path (the project_id dir), the parent directory (project_name dir = storage_path.parent) was never checked or cleaned up.
Fix
After successfully removing storage_path, check whether its parent (project_name dir) is now empty and, if so, remove it too — guarded by a check that it is not the data_directory itself (to avoid accidentally removing the top-level env store).
Tests