-
Notifications
You must be signed in to change notification settings - Fork 74
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
Metadata Viewer: API to return dict, not list #3292
base: main
Are you sure you want to change the base?
Conversation
@@ -101,7 +103,8 @@ def find_public_metadata(self, meta, primary_only=False): | |||
d = flatten_nested_dict(meta) | |||
# Some FITS keywords cause "# ipykernel cannot clean for JSON" messages. | |||
# Also, we want to hide internal metadata that starts with underscore. | |||
badkeys = ['COMMENT', 'HISTORY', ''] + [k for k in d if k.startswith('_')] | |||
badkeys = (['COMMENT', 'HISTORY', ''] + [k for k in d if k.startswith('_')] | |||
+ [k for k in d if k.startswith('original_')]) |
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.
Without this, I get things in Cubeviz that is not from original header like:
- original_spectral_axis_unit (a Quantity)
- original_wcs (WCS object)
Perhaps these should have been hidden with leading underscore but they snuck through so here we are.
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.
Weird thing is I don't know where these are being injected. A simple grep in the code base gave me no match.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3292 +/- ##
=======================================
Coverage 88.80% 88.80%
=======================================
Files 125 125
Lines 19009 19012 +3
=======================================
+ Hits 16881 16884 +3
Misses 2128 2128 ☔ View full report in Codecov by Sentry. |
Description
This pull request is to address the request, "File metadata extracted from the API is hard to parse. Maybe a dictionary is better?"
I avoided changing
metadata
itself because that would mean messing with the front-end stuff that already works. Also might be subtly confusing because the same attribute now returns something different. Maybe best to have a clean break using a different attribute name.Change log entry
CHANGES.rst
? If you want to avoid merge conflicts,list the proposed change log here for review and add to
CHANGES.rst
before merge. If no, maintainershould add a
no-changelog-entry-needed
label.Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
trivial
label.