feat(api): support an "experimental" api version #17668
Draft
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
Add the ability to specify a protocol's API level as "experimental", and to specify API calls as experimental. The experimental API level is greater than any named API level. That means that - An api method that is experimental can only be used if the protocol requests the experimental api level - This will remain true as the max supported api version changes
ddcc4
reviewed
Mar 6, 2025
| @@ -445,11 +447,28 @@ class JsonConfig(BaseModel): | |||
| schemaVersion: int | |||
|
|
|||
|
|
|||
| def _api_version_deser(obj: Any) -> APIVersion: | |||
There was a problem hiding this comment.
Do you want to make this more strictly typed than Any?
| if inp == "experimental": | ||
| return cls.as_experimental() | ||
| elif inp == "1": | ||
| return cls(major=1, minor=0, experimental=False) |
There was a problem hiding this comment.
Why is version 1 special like that? Do we want to generalize version numbers to \d+\(\.\d+\)??
| b_maj = other[0] | ||
| b_min = other[1] | ||
| b_exp = other[2] if len(other) > 2 else False | ||
| # when you do a <= b, interpreter calls a.__le__(b) |
There was a problem hiding this comment.
I'm a little nervous that you're defining le without the other operators. Like, are users supposed to know that you're not allowed to use <, only <=?
| class APIVersion(NamedTuple): | ||
| major: int | ||
| minor: int | ||
| experimental: bool = False |
There was a problem hiding this comment.
Out of curiosity, would this implementation be much simpler if you made experimental the first field in the tuple, and then just relied on the regular tuple ordering?
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.
Add the ability to specify a protocol's API level as "experimental", and to specify API calls as experimental.
The experimental API level is greater than any named API level. That means that
review requests
to come out of draft