subiquity.common.serialize: add a way to have a "non-exhaustive" enum#1984
Merged
mwhudson merged 4 commits intocanonical:mainfrom May 5, 2024
Merged
subiquity.common.serialize: add a way to have a "non-exhaustive" enum#1984mwhudson merged 4 commits intocanonical:mainfrom
mwhudson merged 4 commits intocanonical:mainfrom
Conversation
dbungert
approved these changes
May 1, 2024
Member
dbungert
left a comment
dbungert
left a comment
There was a problem hiding this comment.
Thanks!
Looks fine, one open question, and a rebase to cleanup commits please.
Rather than as a list of [key, value] pairs.
We use the subiquity.common.api stuff to talk to snapd, and use enumerations to describe several field names. This is a bit of a landmine in some situations because snapd can add a value to the set of possible return values and thus cause serialization to fail. Rather than just giving up on all of the typo-resistance of declaring enums for API types, this adds a way to mark an enumeration as "non-exhaustive": values that are part of the declared enum will be deserialized as values of the enum but values that are not will be passed straight through (as strings, in all the cases used in snapdapi.py), which conveniently will never compare equal to an enumeration. This should let us just declare the values of the enumerations we actually care about and not break if we don't declare every value snapd actually uses.
mwhudson
force-pushed
the
non-exhaustive-enums
branch
from
fed2f10 to
e3f16aa
Compare
Collaborator
Author
|
I rebased and cleaned up one bit of logic to hopefully more comprehensible. I don't see the open question though? |
dbungert
approved these changes
May 3, 2024
Member
dbungert
left a comment
dbungert
left a comment
There was a problem hiding this comment.
Uh, I think I confused this with the other PR where I was suggesting to document one more possible state in the enum. LGTM, thanks!
Collaborator
Author
|
I should tag @d-loose so he knows about the change in capabilities of the API here -- basically a dict with enum keys is serialized as an object, not a list of key, value pairs. there are no such types in the subiquity API today though. |
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
2 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.
relates to #1980