source.py: Make SourceInfo.serialize() a public API.#2016
Merged
Conversation
This will output a normalized dictionary suitable for serialization into formats like json or yaml. Also updated caller in _frontend/widget.py.
gtristan
requested review from
BenjaminSchubert,
abderrahim,
cs-shadow and
juergbi
as code owners
shymega
approved these changes
May 26, 2025
shymega
left a comment
shymega
left a comment
There was a problem hiding this comment.
LGTM - I think we're good with this one.
abderrahim
approved these changes
May 27, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This serializes the
SourceInfointo a regular simple dictionary object that can be easily serialized into formats like json or yaml.While it was requested to make this public in some way, it is not particularly useful to make this serialize directly into a yaml string, since normally one will probably want to serialize a list of SourceInfo objects reported for a given element, in whatever data structure one would want to serialize this into.
For this reason, we export the current serialization which just converts the
SourceInfoobject into something that other serialization python libraries can reliably consume (simple dictionaries).