Type safe option value getter #14561
Draft
+658
−826
Conversation
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
bruchar1
suggested changes
May 6, 2025
Yeah, I didn't plan to merge them that way, just have smaller chunks to review |
dcbaker
force-pushed
the
submit/type-safe-option-value-getter
branch
2 times, most recently
from
85f0d3b to
6431122
Compare
bruchar1
suggested changes
May 7, 2025
dcbaker
force-pushed
the
submit/type-safe-option-value-getter
branch
from
6431122 to
245c47f
Compare
dcbaker
force-pushed
the
submit/type-safe-option-value-getter
branch
from
245c47f to
c62617e
Compare
dnicolodi
reviewed
May 17, 2025
| @@ -889,7 +890,19 @@ def get_value_object_and_value_for(self, key: OptionKey) -> T.Tuple[AnyOptionTyp | |||
| computed_value = vobject.validate_value(self.augments[key]) | |||
| return (vobject, computed_value) | |||
|
|
|||
| def get_value_for(self, name: 'T.Union[OptionKey, str]', subproject: T.Optional[str] = None) -> ElementaryOptionValues: | |||
| def get_value_for(self, key: OptionKey, type_: T.Type[ElementaryOptionTypes], | |||
| *, fallback: T.Optional[ElementaryOptionTypes] = None) -> ElementaryOptionTypes: | |||
There was a problem hiding this comment.
Maybe default would be more in line to how the same concept is named in the Pyrthon APIs than fallback
dnicolodi
reviewed
May 17, 2025
This provides a variant of `get_value_for` that does run-time type checking, but in a way that allows static type checkers like mypy to understand. This gives us the two fold advantage of runtime checking of types that can't be statically known and not having to write a lot `assert isinstance(...), 'for mypy'` checks.
It belongs here, rather than in the CoreData.
Be more consistent
We have a fallback parameter now, so we can avoid the exception handling by providing a sane or sentinel default value instead
The `target` parameter is actually `None | BuildTarget`, and we rely on this.
It's really a core part of Meson, not something specific to the Interpreter, and this can be seen by where it is imported.
Because that is what they actually should have
By using overloads we create two valid signatures: (BuildTarget, Environment) (None, Envionment, str) This means that mypy will *force* a user to either pass a valid target or a subproject, but not both. This in turn means we can rely on only having one subproject definition. The drawback to having clean public interfaces, is that we have to convince mypy we're doing the right thing inside the Compiler class (or add a bunch of extra code that isn't actually necessary).
This pattern repeats a lot in the Compiler, and the compiler even has it's own implementation of this (which will be removed shortly).
This was an unsafe version of the other function, but without proper subproject handling. In most cases (except unittests) the safe variant was actually better anyway, especially with the fallback parameter
dcbaker
force-pushed
the
submit/type-safe-option-value-getter
branch
from
c62617e to
91db35c
Compare
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.
This (ultimately) makes the
OptionStore.get_option_value()type safe, but using a generic with a bound type. This allows us to both have runtime type checking, and allows mypy (and other type checkers) to see that at static inspection time and treat the return as safe. This, in turn, allows us to remove a lot ofassert isinstance(...), 'for mypy'checks, with a properMesonBugExceptionwith a more helpful error message.The addition of a fallback parameter also allows us to remove a bunch of
if key in options and options.get_value_for(key)style checks, through the use of the fallback.This series has been split into a bunch of patches to attempt to make review easier, but I'm perfectly happy to squash any number of them into less patches before merging.