EUCLID: include the new parameter linking_parameter in the method get_spectrum#3543
Conversation
33ae3e7 to
dc87904
Compare
d189304 to
8ea8818
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3543 +/- ##
==========================================
+ Coverage 72.66% 72.67% +0.01%
==========================================
Files 219 219
Lines 20478 20493 +15
==========================================
+ Hits 14880 14893 +13
- Misses 5598 5600 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bsipocz
left a comment
There was a problem hiding this comment.
Overall this looks good, but the argument rename will need to go through a deprecation. (it should be straightforward with the decorator though).
This also needs a changelog entry.
astroquery/esa/euclid/core.py
Outdated
| return files | ||
|
|
||
| def get_spectrum(self, *, source_id, schema='sedm', retrieval_type="ALL", output_file=None, verbose=False): | ||
| def get_spectrum(self, *, id, schema='sedm', retrieval_type="ALL", linking_parameter='SOURCE_ID', |
There was a problem hiding this comment.
Unfortunately this needs to be done through an argument rename deprecation
(see usage of @deprecated_renamed_argument in e.g. the simbad module)
There was a problem hiding this comment.
Yes, you are right. We have included it
@deprecated_renamed_argument('source_id', 'id',since='0.4.12')
astroquery/esa/euclid/core.py
Outdated
| ---------- | ||
| source_id : str, mandatory, default None | ||
| source id for the spectrum | ||
| id : str or int, mandatory |
There was a problem hiding this comment.
Any change that this method will be able to handle multiple IDs at the same time? I'm just asking as get_datalinks below can and as we already rename the argument we can make it a bit more self consistent and call this one ids, too.
There was a problem hiding this comment.
Yes, we have a task to update this method to handle multiple IDs at the same time, but this will part of our next sprint. So, would it be convenient to to change source_id by ids now. instead of of id? Or better to do it in the PR where the changes would be implemented?
There was a problem hiding this comment.
I would say it's better to change it now, so we don't need to change it again when the functionality is extended.
There was a problem hiding this comment.
We have changed the parameter source_id to ids.
c3e9660 to
50c7ae2
Compare
27e4336 to
21bf2c1
Compare
Dear astroquery team,
we would like to update the method get_spectrum so that the spectra can be searched by a source_id (present implementation) or by a sourcepatch_id. To carry out this, we introduce the parameter linking_parameter that provides the meaning to the input id of the source.
Note that we have changed the input parameter source_id to id.
cc @esdc-esac-esa-int
jira: EUCLIDSWR-226