Remove temporary file in JSON backend store function #330
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
tangkong
approved these changes
Sep 1, 2023
docs/source/upcoming_release_notes/304-remove_temporary_file.rst
Outdated
Show resolved
Hide resolved
klauer
reviewed
Sep 7, 2023
|
|
||
| # Ensure file is created, then throw error | ||
| def shutil_move_patch(*args, **kwargs): | ||
| assert os.path.isfile(os.path.join(os.getcwd(), temp_path)) |
There was a problem hiding this comment.
We should be a bit careful here - this assertion might raise, and it'd be caught by with pytest.raises(BaseException) below. Assertions are AssertionError(Exception) which inherits from BaseException (standard library has a nice ASCII tree of this here)
The short of it is: I think you should switch the below clause on line 220 to be with pytest.raises(RuntimeError) to make sure we're catching line 215 and not line 214
There was a problem hiding this comment.
This makes sense, and I'll update the raise.
I will look more into how assert works in pytest-for some reason I thought the test would just count as a fail and move on. Not sure why I thought of it as isolated
Merge branch 'master' into file-cleanup
ZLLentz
approved these changes
Sep 18, 2023
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.
Description
Motivation and Context
Closes #304
If an error causes the temporary file in the json backend to not get copied properly, it would previously remain in the directory. It has not been needed so it will now be removed if left behind.
In addition, because this file is no longer needed, the datetime and username are no longer needed in the file name. It is now just the unique hash to prevent collisions. Imports previously used to add time and username are now removed from the file.
How Has This Been Tested?
Interactively, and a new test in test-backends.py
Where Has This Been Documented?
Issues #303, #304
Comments within function itself and test.
Pre-merge checklist
docs/pre-release-notes.shand created a pre-release documentation page