Deprecating ivoid2service. #439
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 79.93% 79.94%
=======================================
Files 52 52
Lines 6016 6018 +2
=======================================
+ Hits 4809 4811 +2
Misses 1207 1207
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bsipocz
approved these changes
Apr 19, 2023
bsipocz
reviewed
Apr 19, 2023
Comment on lines
+899
to
+901
| @deprecated("1.5", "ivoid2service does not work in the presence of" | ||
| " multiple capabilities. Use" | ||
| " registry.search(ivoid=...)[0].get_service('capname') instead.") |
There was a problem hiding this comment.
Maybe chop up the message arg to message and alternative
Suggested change
| @deprecated("1.5", "ivoid2service does not work in the presence of" | |
| " multiple capabilities. Use" | |
| " registry.search(ivoid=...)[0].get_service('capname') instead.") | |
| @deprecated("1.5", message="ivoid2service does not work in the presence of multiple capabilities", | |
| alternative=" registry.search(ivoid=...)[0].get_service('capname')") |
msdemlei
force-pushed
the
deprecate-ivoid2service
branch
from
253f0d9 to
920b186
Compare
|
On Wed, Apr 19, 2023 at 10:16:42AM -0700, Brigitta Sipőcz wrote:
@bsipocz commented on this pull request.
> ***@***.***("1.5", "ivoid2service does not work in the presence of"
+ " multiple capabilities. Use"
+ " registry.search(ivoid=...)[0].get_service('capname') instead.")
Maybe chop up the `message` arg to `message` and `alternative`
I considered that but then read the argument description "alternative
function or class name", which to me didn't sound free-text-ish
enough to put in something very definitely not just a name.
If you tell me "trust me, it's ok", I'll make the change. Do you?
|
|
On Wed, Apr 19, 2023 at 10:14:19AM -0700, Brigitta Sipőcz wrote:
@bsipocz approved this pull request.
This will need a changelog entry, but otherwise all good.
The only thing I wonder that why this doesn't trigger a CI failure,
didn't we have test coverage for ivoid2service?
No -- which is part of the reason why I'd like to scupper it: it's
not only a bad API, it would also require a lot of scaffolding (bad)
or a remote test (worse) to test.
|
Actually, it's not OK. In the meantime, merging the other PR introduced a changelog conflict, I'll go ahead and rebase and then merge this. |
The problem with it is that when a resource has multiple capabilities (e.g., SCS and TAP, as is now true for the big majority of VO resources), its result is ill-defined. One *could* add a parameter to select the kind of service desired, but that's complicated in detail. Hence, we advise people to use normal registry search with an ivoid constraint. This is supposed to address Bug astropy#425.
bsipocz
force-pushed
the
deprecate-ivoid2service
branch
from
920b186 to
86e3dfe
Compare
|
Thank you Markus! |
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.
The problem with it is that when a resource has multiple capabilities (e.g., SCS and TAP, as is now true for the big majority of VO resources), its result is ill-defined.
One could add a parameter to select the kind of service desired, but that's complicated in detail. Hence, we advise people to use normal registry search with an ivoid constraint.
This is supposed to address Bug #425.