allow extra keywords in structured datatype validation #1901
+12
−0
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.
Description
The ndarray schema doesn't prevent additional keywords in datatype definitions for structured datatypes.
https://github.com/asdf-format/asdf-standard/blob/c17c3ecabcad7b65e41e0fb79054988b37f45a38/resources/schemas/stsci.edu/asdf/core/ndarray-1.1.0.yaml#L214
For example, adding a description to a sub-datatype doesn't violate the schema:
However it fails the custom datatype validation in asdf.
This PR updates the custom datatype validator to only compare a selection of datatype keys
{"name", "datatype", "byteorder", "shape"}
. This allows adding descriptions to sub-datatypes.Fixes #1900
Tasks
pre-commit
on your machinepytest
on your machineno-changelog-entry-needed
)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types)docs/
pagenews fragment change types...
changes/<PR#>.feature.rst
: new featurechanges/<PR#>.bugfix.rst
: bug fixchanges/<PR#>.doc.rst
: documentation changechanges/<PR#>.removal.rst
: deprecation or removal of public APIchanges/<PR#>.general.rst
: infrastructure or miscellaneous change