Ensure h5file is closed even if validation fails #52
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
Callers of the save_photon_hdf5() can specify that they wanted the hdf5 file they passed in closed before returning. However, we performed validation before closing the file, and the validation can error out. If this happened, the file /would not be closed/. Not a bit deal if the user still had a hold on the file object and could close it themselves, but if they instead passed in just the file name then they were unable to close it themselves without somehow getting a hold of the object from python's global list of open files. This meant that they would need to restart the python process before they could try saving to the hdf5 file again. Now, we place the file closing logic in the clause of a finally: statement to ensure we always close it if the user wants us to.
|
I looked at the CI failures, and it doesn't appear to be related to this pull request. Something about missing DLLs I think. |
|
Ping |
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.
This fixes a bug where if validation of the Photon-HDF5 file failed, then save_photon_hdf5() would not close it even if the user had requested us to do so. This behavior created an awkward situation if the user did not save the file object in a variable somewhere, since they would be unable to close it and thus unable to try saving to it again without restarting the python process. With this fix, save_photon_hdf5() becomes more amenable to experimenting at the console without interrupting the flow of things to restart the process after mistakenly trying to save malformed data.