Skip to content

os.remove on Windows could fail if files are still in use #554

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

Closed
wants to merge 1 commit into from
Closed

os.remove on Windows could fail if files are still in use #554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion cuda_core/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,19 @@ def deinit_cuda():

@pytest.fixture(scope="session", autouse=True)
def clean_up_cffi_files():
yield
# Clean up files from previous runs before the session starts
files = glob.glob(os.path.join(os.getcwd(), "_cpu_obj*"))
Comment on lines 58 to 61
Copy link
Collaborator

Choose a reason for hiding this comment

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

Because of issues like the Windows cleanup issue, would highly recommend using pytest's builtin temporary directory management fixtures

This will handle all the directory creation and cleanup for us with less fuss

Copy link
Collaborator

Choose a reason for hiding this comment

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

+1 — if we have the free bandwidth

Copy link
Collaborator

Choose a reason for hiding this comment

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

Simpler, more reliable cleanup of the test directory will lead to bandwidth savings in the long term ;)

Copy link
Member

Choose a reason for hiding this comment

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

I've explained this in a past group meeting, repeating here for wider visibility. pytest fixtures like tmp_path etc unfortunately do not work. The temp files are generated by CFFI inside a code sample (here), and we have no way to influence where it places the modules (without making the code sample overly complicated) I am afraid. I'd be happy to be proven wrong!

for f in files:
try: # noqa: SIM105
os.remove(f)
except FileNotFoundError:
pass # noqa: SIM105
except PermissionError:
# On Windows, removing a file in use raises PermissionError
# We can ignore this during setup, as the goal is just to
# clean up leftovers from *previous* runs. If a file is
# still in use now, it's likely from an ongoing process
# unrelated to the test session about to start.
pass
yield
# No cleanup needed after yield anymore
Copy link
Collaborator

Choose a reason for hiding this comment

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

That's a great move.

What do you think about adding something like this?

import logging

logger = logging.getLogger(__name__)

...

        except PermissionError as e:
            logger.warning(f"Could not remove file {f!r}: {e}")

That way, if a file is in use unexpectedly, we’ll at least have breadcrumbs.

We should probably also log the FileNotFoundError.