Support multivalued UWS parameters #24
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
|
This approach doesn't work in cases where the model attribute is declared as a list but received one element. I'm trying to figure out if there's a better approach that uses more type introspection. |
Some UWS services (SODA, for example) have multivalued job parameters. The parameter may be specified repeatedly with different values. pydantic-xml supports this and produces a model element that holds a list of Parameters, but it previously was not supported by vo-models because the overridden `__init__` method didn't know how to handle lists. Add support to `Parameters.__init__` to first flatten all of the input values into a simple list, regardless of which attribute pydantic-xml thought they corresponded to, and then construct a dict based on id values as before, but create a list of `Parameter` objects if we see the same id more than once. Document that multi-valued parameters should be declared as `MultiValuedParameter` instead of `list[Parameter]`, which adds a validator that ensures that the parameters are always converted to a list. Add a test case for multivalued attributes and for correctly parsing parameters given out of order in XML. Fixes spacetelescope#21
|
I tried a few ways to fix this, but the easiest is to add a validator to the multi-valued fields. This adds a new data type that makes it easy to do that, and updates the documentation accordingly. |
|
Thank you for looking into this, and I apologize for not taking a look at this sooner. The I'll take a look at this today-- everything here seems like great work in handling this case. |
jwfraustro
approved these changes
Sep 16, 2024
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.
Support multivalued UWS parameters
Some UWS services (SODA, for example) have multivalued job parameters. The parameter may be specified repeatedly with different values. pydantic-xml supports this and produces a model element that holds a list of Parameters, but it previously was not supported by vo-models because the overridden
__init__method didn't know how to handle lists.Add support to
Parameters.__init__to first flatten all of the input values into a simple list, regardless of which attribute pydantic-xml thought they corresponded to, and then construct a dict based on id values as before, but create a list ofParameterobjects if we see the same id more than once. Document that multi-valued parameters should be declared asMultiValuedParameterinstead oflist[Parameter], which adds a validator that ensures that the parameters are always converted to a list.Add a test case for multivalued attributes and for correctly parsing parameters given out of order in XML.
Fixes #21