Skip to content
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.

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

name temporary files with a pattern which can be globbed #789

Open
l0b0 opened this issue Jan 13, 2023 · 10 comments
Open

name temporary files with a pattern which can be globbed #789

l0b0 opened this issue Jan 13, 2023 · 10 comments

Comments

@l0b0
Copy link

l0b0 commented Jan 13, 2023

When nbQA runs it extracts a foo[randomness].py file from foo.ipynb, and puts this file in the same directory as the notebook. This confuses my IDE, which is set to add any new files to VCS. It would probably be better to put this in a temporary directory.

@MarcoGorelli
Copy link
Collaborator

It would probably be better to put this in a temporary directory.

It used to be like this, but then that caused issues for importing modules

The temporary files should be automatically cleaned up after nbqa finishes running though, is that not what you're seeing?

@MarcoGorelli
Copy link
Collaborator

can't reproduce this, even on windows - my only guess is that you repeatedly ran ctrl+C while nbQA was still running and someone intercepted the finally block which cleans up the temporary files?

closing for now then, but thanks for the report

@l0b0
Copy link
Author

l0b0 commented Jan 15, 2023

No, I didn't Ctrl-C. nbQA just ran long enough for the IDE to see the file and stage it.

@MarcoGorelli
Copy link
Collaborator

I see - which IDE was it, just out of interest?

Either way, I'd suggest reporting to them (or seeing if they have a way of increasing the time for temporary files)

@l0b0
Copy link
Author

l0b0 commented Jan 15, 2023

JetBrains IDEA. It would be closed as not an issue, because it's a feature. I've set up my IDE to add all files to VCS when they are created.

@MarcoGorelli
Copy link
Collaborator

doesn't this cause issues for you when using other tools that create temporary files, such as pytest or yesqa?

@l0b0
Copy link
Author

l0b0 commented Jan 15, 2023

Those are in .gitignore, so the IDE ignores them. nbQA is special since it creates a file in the same directory and with almost the same name, without any easy way to glob just for the temporary files.

@MarcoGorelli
Copy link
Collaborator

so if the temporary file names all started with the same pattern, such as .nbqa.foo[randomness].py, then that would work as a solution for you?

if so, then sure, pull requests welcome

@MarcoGorelli MarcoGorelli reopened this Jan 15, 2023
@MarcoGorelli MarcoGorelli changed the title Temporary files should be created in a temporary directory outside the repository name temporary files with a pattern which can be globbed Jan 15, 2023
@l0b0
Copy link
Author

l0b0 commented Jan 15, 2023

so if the temporary file names all started with the same pattern, such as .nbqa.foo[randomness].py, then that would work as a solution for you?

Yeah, something like that would be great!

@MarcoGorelli
Copy link
Collaborator

cool, here's the contributing guide if you're interested in submitting a PR https://nbqa.readthedocs.io/en/latest/contributing.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants