[commands/cache] make pip cache purge remove everything from http + wheels caches; make pip cache remove prune empty directories.

Author: duckinator

src/pip/_internal/commands/cache.py

@@ -183,7 +183,28 @@ def remove_cache_items(self, options: Values, args: List[Any]) -> None:
         for filename in files:
             os.unlink(filename)
             logger.verbose("Removed %s", filename)
+
+        http_dirs = filesystem.subdirs_with_no_files(self._cache_dir(options, "http"))
+        wheel_dirs = filesystem.subdirs_with_no_files(
+            self._cache_dir(options, "wheels")
+        )
+        dirs = [*http_dirs, *wheel_dirs]
+        for dirname in dirs:
+            try:
+                os.rmdir(dirname)
+            except FileNotFoundError:
+                # If the file is already gone, that's fine.
+                pass
+            logger.verbose("Removed %s", dirname)
+
+        # selfcheck.json is no longer used by pip.
+        selfcheck_json = self._cache_dir(options, "selfcheck.json")
+        if os.path.isfile(selfcheck_json):
+            os.remove(selfcheck_json)
+            logger.verbose("Removed legacy selfcheck.json file")
+
         logger.info("Files removed: %s", len(files))
+        logger.info("Empty directories removed: %s", len(dirs))
 
     def purge_cache(self, options: Values, args: List[Any]) -> None:
         if args:

src/pip/_internal/utils/filesystem.py

@@ -4,11 +4,13 @@
 import random
 import sys
 from contextlib import contextmanager
+from pathlib import Path
 from tempfile import NamedTemporaryFile
 from typing import Any, BinaryIO, Generator, List, Union, cast
 
 from pip._vendor.tenacity import retry, stop_after_delay, wait_fixed
 
+from pip._internal.exceptions import PipError
 from pip._internal.utils.compat import get_path_uid
 from pip._internal.utils.misc import format_size
 
@@ -151,3 +153,50 @@ def directory_size(path: str) -> Union[int, float]:
 
 def format_directory_size(path: str) -> str:
     return format_size(directory_size(path))
+
+
+def _leaf_subdirs(path):
+    """Traverses the file tree, finding every empty directory."""
+
+    path_obj = Path(path)
+
+    if not path_obj.exists():
+        return
+
+    for item in path_obj.iterdir():
+        if not item.is_dir():
+            continue
+
+        subitems = item.iterdir()
+
+        # ASSUMPTION: Nothing in subitems will be None or False.
+        if not any(subitems):
+            yield item
+
+        if not any(subitem.is_file() for subitem in subitems):
+            yield from _leaf_subdirs(item)
+
+
+def _leaf_parents_without_files(path, leaf):
+    """Yields +leaf+ and each parent directory below +path+, until one of
+    them includes a file (as opposed to directories or nothing)."""
+
+    if not str(leaf).startswith(str(path)):
+        # If +leaf+ is not a subdirectory of +path+, bail early to avoid
+        # an endless loop.
+        raise PipError("leaf is not a subdirectory of path")
+
+    path = Path(path)
+    leaf = Path(leaf)
+    while leaf != path:
+        if all(item.is_dir() for item in leaf.iterdir()):
+            yield str(leaf)
+        else:
+            break
+        leaf = leaf.parent
+
+
+def subdirs_with_no_files(path):
+    """Yields every subdirectory of +path+ that has no files under it."""
+    for leaf in _leaf_subdirs(path):
+        yield from _leaf_parents_without_files(path, leaf)

tests/functional/test_cache.py

@@ -256,7 +256,7 @@ def test_cache_purge_with_empty_cache(script: PipTestEnvironment) -> None:
     and exit without an error code."""
     result = script.pip("cache", "purge", allow_stderr_warning=True)
     assert result.stderr == "WARNING: No matching packages\n"
-    assert result.stdout == "Files removed: 0\n"
+    assert result.stdout == "Files removed: 0\nEmpty directories removed: 0\n"
 
 
 @pytest.mark.usefixtures("populate_wheel_cache")
@@ -265,7 +265,7 @@ def test_cache_remove_with_bad_pattern(script: PipTestEnvironment) -> None:
     and exit without an error code."""
     result = script.pip("cache", "remove", "aaa", allow_stderr_warning=True)
     assert result.stderr == 'WARNING: No matching packages for pattern "aaa"\n'
-    assert result.stdout == "Files removed: 0\n"
+    assert result.stdout == "Files removed: 0\nEmpty directories removed: 0\n"
 
 
 def test_cache_list_too_many_args(script: PipTestEnvironment) -> None: