Skip to content

Explicitly finalise source to cleanup hdf5 file backing dataset store#706

Merged
yousefmoazzam merged 1 commit intomainfrom
remove-hdf5-file-backing-dataset-store
Apr 7, 2026
Merged

Explicitly finalise source to cleanup hdf5 file backing dataset store#706
yousefmoazzam merged 1 commit intomainfrom
remove-hdf5-file-backing-dataset-store

Conversation

@yousefmoazzam
Copy link
Copy Markdown
Collaborator

Fixes IMGDA-192

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have made corresponding changes to the documentation
  • I have added the user-release-note label in order to include this PR in the "Notable
    Changes for Users" section in release notes

An explicit call to the `finalize()` method of the dataset source has
been added in two places:
- in the method setting up the source and sink for any section that is
  not the last section (to delete the temporary hdf5 file used as input
  to the previous section, which has been superceded by the temporary
  hdf5 file created as output of the previous section)
- after the last section has been completed (for the same reason as
  above, to delete the temporary hdf5 file used as input to the last
  section, but must be done independently of `_setup_source_sink()` as
  that method is not called after the last section has completed, so the
  code added to it won't help with cleanup of the last section's source)

Note that, ideally, the use of `weakref.finalize()` in
`DataSetStoreReader` would automatically cleanup the temporary hdf5
files when reader objects are garbage collected, and that explicit calls
to `finalize()` would not be necessary.

However, because the file-cleanup logic in the reader's `finalize()`
method appears to not be getting triggered as expected, it would appear
that garbage collection of reader objects is maybe not happening for
some reason. This will require further investigation.
@yousefmoazzam yousefmoazzam merged commit 06700f6 into main Apr 7, 2026
3 of 5 checks passed
@yousefmoazzam yousefmoazzam deleted the remove-hdf5-file-backing-dataset-store branch April 7, 2026 11:39
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

Successfully merging this pull request may close these issues.

1 participant