Add a --clean-cache command to clean up locations specified at CIBW_CACHE_PATH
#2489
Conversation
| @@ -421,6 +424,71 @@ def test_debug_traceback(monkeypatch, method, capfd): | |||
| assert "Traceback (most recent call last)" in err | |||
|
|
|||
|
|
|||
| def test_clean_cache_when_cache_exists(tmp_path, monkeypatch, capfd): | |||
| monkeypatch.undo() | |||
There was a problem hiding this comment.
I had to add monkeypatch.undo() here and in the tests below because fake_package_dir_autouse is autoused and applied to all tests, and it breaks these tests because I'm monkeypatching CIBW_CACHE_PATH.
There was a problem hiding this comment.
Hmm. could we move these tests to a new module main_commands_test.py (--print_build_identifiers tests can come too, if they exist), and then scope the autouse fixture to only apply to tests in main_options_test.py, main_platform_test.py, and main_requires_python_test.py?
There was a problem hiding this comment.
@agriyakhetarpal Did you want to do this? Or should I add it to my list of things I'll do if there's a lull in the SciPy sprints? :)
| @@ -421,6 +424,71 @@ def test_debug_traceback(monkeypatch, method, capfd): | |||
| assert "Traceback (most recent call last)" in err | |||
|
|
|||
|
|
|||
| def test_clean_cache_when_cache_exists(tmp_path, monkeypatch, capfd): | |||
| monkeypatch.undo() | |||
There was a problem hiding this comment.
Hmm. could we move these tests to a new module main_commands_test.py (--print_build_identifiers tests can come too, if they exist), and then scope the autouse fixture to only apply to tests in main_options_test.py, main_platform_test.py, and main_requires_python_test.py?
Signed-off-by: Henry Schreiner <[email protected]>
|
The one thought I had was could we check for something specific to make sure this is in fact a cibuildwheel cache dir? Just to protect for a mistake like setting the cache dir to something like $HOME. :) |
Do you mean we should check if Realistically, I think we'd have no defense against this unless we make the cache path non-configurable and drop the ability to set it via the |
|
I was thinking looking for a specific file or folder that would exist if it was cibuildwheel's cache. |
|
Right, we could include a sentinel |
That's a nice idea. Might save somebody's day. |
As described in #2397, this PR adds a
--clean-cachecommand to cleanCIBW_CACHE_PATH. It does not implement granular cache cleans at the moment (it does not clean per supported platform), andshutil.rmtree()s the entire folder. I added three tests that account for possible code paths: if cache files exist, if they don't, or if the cache files are somehow in a non-readable/writable location (though I think that aspect should also be validated at the creation time of the cache paths).This is especially useful for Pyodide builds, as the Emscripten SDK can occupy up to 1.5 GiB of space; however, it is also beneficial for builds on all other platforms.
Closes #2397