-
Notifications
You must be signed in to change notification settings - Fork 1
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
feature: Returns just dictionary when loading .topostats #112
Conversation
Closes #109 Rather than return the HDF5 object loaded from `.topostats` as a dictionary as the third item in a tuple along with the `image` and `pixel_to_nm_scaling` (both of which are extracted from the loaded data anyway) just the dictionary is returned. This matches the structure of objects created by TopoStats and how they are saved to HDF5 files.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #112 +/- ##
==========================================
- Coverage 74.62% 74.58% -0.05%
==========================================
Files 8 8
Lines 607 606 -1
==========================================
- Hits 453 452 -1
Misses 154 154 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not tested locally but fail to see what could break here.
Must remember that when a PyPI release is made, in TopoStats, to require AFMReader's version to be at least that one, since TopoStats will expect a single dictionary instead of a tuple. A little bit of a headache with changing TopoStats and AFMReader's interoperability ^^;
Thanks @SylviaWhittle for the review and approval 👍
Yeah, I was trying to think how to handle that, its ok on development and once a release is made of both but if people explicitly install an older version of TopoStats that pulls in the newer version of AFMReader that won't work (might arise if I'll look into whether its possible to add warnings about this, perhaps to a new release of AFMReader to the tune of |
I've written up what might need updating/changing in TopoStats # 1086. |
Closes #109
Rather than return the HDF5 object loaded from
.topostats
as a dictionary as the third item in a tuple along with theimage
andpixel_to_nm_scaling
(both of which are extracted from the loaded data anyway) just the dictionary isreturned. This matches the structure of objects created by TopoStats and how they are saved to HDF5 files.