Refactor: remove unnecessary use of tempfile.mkdtemp
#5639
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sphuber
force-pushed
the
fix/4336/remove-tempfile-mkdtemp
branch
from
e4eb8a4
to
7f7449e
Compare
|
Tests seem to randomly fail. See #5640 |
sphuber
force-pushed
the
fix/4336/remove-tempfile-mkdtemp
branch
from
08004c4
to
5c28412
Compare
sphuber
force-pushed
the
fix/4336/remove-tempfile-mkdtemp
branch
from
5c28412
to
b99d426
Compare
unkcpz
reviewed
Sep 22, 2022
| @@ -325,7 +325,7 @@ def create_profile(self): | |||
| self.create_aiida_db() | |||
|
|
|||
| if not self.root_dir: | |||
| self.root_dir = tempfile.mkdtemp() | |||
| self.root_dir = tempfile.TemporaryDirectory().name # pylint: disable=consider-using-with | |||
There was a problem hiding this comment.
So this is not cleanup after use? Why not use it inwith?
| @@ -325,7 +325,7 @@ def create_profile(self): | |||
| self.create_aiida_db() | |||
|
|
|||
| if not self.root_dir: | |||
| self.root_dir = tempfile.mkdtemp() | |||
| self.root_dir = tempfile.TemporaryDirectory().name # pylint: disable=consider-using-with | |||
There was a problem hiding this comment.
Suggested change
| self.root_dir = tempfile.TemporaryDirectory().name # pylint: disable=consider-using-with | |
| temp_dir = tempfile.TemporaryDirectory() | |
| self.root_dir = temp_dir.name # pylint: disable=consider-using-with | |
| temp_dir.cleanup() |
There was a problem hiding this comment.
We cannot use it here, because it needs to be kept alive for the duration of the tests. The cleanup is called manually in destroy_all which is called at the end of the test suite.
sphuber
force-pushed
the
fix/4336/remove-tempfile-mkdtemp
branch
from
b99d426
to
c7ff0e4
Compare
When it is used for unit tests, it should be replaced by the `tmp_path` fixture provided by `pytest` since it will take care of cleanup automatically. Then there are a few cases in the code where it was used where it was replaced with `tempfile.TemporaryDirectory`. The latter has the advantage that it will be automatically cleanup when the object goes out of scope. A few places in the code still use `mkdtemp` since it needs to control the cleanup manually. The `temp_dir` fixture is also deprecated. It works exactly as the `tmp_path` fixture which ships with `pytest` and should be used instead.
sphuber
force-pushed
the
fix/4336/remove-tempfile-mkdtemp
branch
from
c7ff0e4
to
d3fdd20
Compare
unkcpz
requested changes
Sep 22, 2022
| @@ -325,7 +325,7 @@ def create_profile(self): | |||
| self.create_aiida_db() | |||
|
|
|||
| if not self.root_dir: | |||
| self.root_dir = tempfile.mkdtemp() | |||
| self.root_dir = tempfile.TemporaryDirectory().name # pylint: disable=consider-using-with | |||
|
Thanks @unkcpz I have searched for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4336
When it is used for unit tests, it should be replaced by the
tmp_pathfixture provided bypytestsince it will take care of cleanup automatically.Then there are a few cases in the code where it was used where it was replaced with
tempfile.TemporaryDirectory. The latter has the advantage that it will be automatically cleanup when the object goes out of scope.A few places in the code still use
mkdtempsince it needs to control the cleanup manually.The
temp_dirfixture is also deprecated. It works exactly as thetmp_pathfixture which ships withpytestand should be used instead.