Skip to content

Clean garbage tmpdirs with tempfile.TemporaryDirectory #7941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
graingert wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clean garbage tmpdirs with tempfile.TemporaryDirectory #7941

graingert wants to merge 1 commit into from

Conversation

@graingert
Copy link
Member

@graingert graingert commented Oct 25, 2020 •
edited
Loading

Closes #7940

see also #7933 for my first attempt

@graingert graingert force-pushed the clean-garbage-tmpdirs-with-tempfile-temporary-directory branch from a53c978 to 09b0e20 Compare October 25, 2020 12:01
graingert
graingert commented Oct 25, 2020
View reviewed changes
RonnyPfannschmidt
RonnyPfannschmidt reviewed Oct 25, 2020
View reviewed changes
src/_pytest/pathlib.py Outdated
garbage = parent.joinpath(f"garbage-{uuid.uuid4()}")
path.rename(garbage)
rm_rf(garbage)
with tempfile.TemporaryDirectory(
Copy link
Member

@RonnyPfannschmidt RonnyPfannschmidt Oct 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should spec a root directory and a prefix

Copy link
Member Author

@graingert graingert Oct 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dir is the root directory

@bluetech
Copy link
Member

bluetech commented Oct 25, 2020

IIUC, this is basically a hack to coerce TemporaryDirectory.cleanup() to do the dirty work for us, right? I like it :) Although I think a comment is in order to explain what it's doing, it seems odd if you don't get it.

bluetech
bluetech reviewed Oct 25, 2020
View reviewed changes
@RonnyPfannschmidt
Copy link
Member

RonnyPfannschmidt commented Oct 25, 2020

Since the rmtree helper is simple, how about replicating

@graingert
Copy link
Member Author

graingert commented Oct 26, 2020

so it turns out this PR does fix my original issue, but my test case is hitting #7947

@graingert graingert force-pushed the clean-garbage-tmpdirs-with-tempfile-temporary-directory branch from 09b0e20 to 216c7af Compare October 26, 2020 12:51
@graingert
Copy link
Member Author

graingert commented Oct 26, 2020

IIUC, this is basically a hack to coerce TemporaryDirectory.cleanup() to do the dirty work for us, right? I like it :) Although I think a comment is in order to explain what it's doing, it seems odd if you don't get it.

I'm just composing a comment for this now - and I'd like to comment the use of the rename to "garbage-", but I'm not really clear on why this rename was done originally: https://github.com/pytest-dev/pytest/pull/3988/files#diff-b2559484fd51ba4a312585ab8375eda68c43b0b66bb329ec036106255928a2b9R169

@graingert graingert force-pushed the clean-garbage-tmpdirs-with-tempfile-temporary-directory branch 2 times, most recently from 5ba2ca9 to ceea364 Compare October 26, 2020 13:08
@graingert
Copy link
Member Author

graingert commented Oct 26, 2020

this breaks on windows and I don't know why

Base automatically changed from master to main March 9, 2021 20:40
@RonnyPfannschmidt
Copy link
Member

RonnyPfannschmidt commented Aug 4, 2021

@graingert the name garbage was replicated from pylib which uses it as indicator of folder names that can be removed even if things fail from the processs that initially tries to take them out

@RonnyPfannschmidt
Copy link
Member

RonnyPfannschmidt commented Aug 4, 2021

https://github.com/pytest-dev/py/blob/d2a654131d4af0d2c448c56b599e46a2e0725de4/py/_path/local.py#L840-L994

@bluetech bluetech force-pushed the clean-garbage-tmpdirs-with-tempfile-temporary-directory branch from d3407fe to 3d4a8b1 Compare October 7, 2025 20:25
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Oct 7, 2025
@bluetech
Copy link
Member

bluetech commented Oct 7, 2025

I rebased to fix a conflict.

@graingert @bluetech
use tempfile.TemporaryDirectory to cleanup garbage- dir
f78b56a 
Python has a very nice rm_rf hidden in
tempfile.TemporaryDirectory._rmtree we can use it to cleanup our
"garbage-" dir
https://github.com/python/cpython/blob/3d43f1dce3e9aaded38f9a2c73e3c66acf85505c/Lib/tempfile.py#L784-L812
@bluetech bluetech force-pushed the clean-garbage-tmpdirs-with-tempfile-temporary-directory branch from 3d4a8b1 to f78b56a Compare October 7, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@RonnyPfannschmidt RonnyPfannschmidt RonnyPfannschmidt left review comments

@bluetech bluetech bluetech left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

bot:chronographer:provided (automation) changelog entry is part of PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Pytest cannot delete tmp_path directories without stat.S_IXUSR mode bit set

3 participants

@graingert @bluetech @RonnyPfannschmidt