improve error when an object fails to serialize #1809
Merged
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
asdf currently produces an unhelpful message for some objects that fail to serialize during
asdf.write_to
:Produces:
This PR adds a new exception
AsdfSerializationError
that includes the object type in the error message when yaml emits ayaml.representer.RepresenterError
(for backwards compatibility the new exception inherits fromyaml.representer.RepresenterError
).Running the above example with this PR produces:
Here is a related issue where the above message would have been helpful: spacetelescope/roman_datamodels#361
Checklist: