Python: Adjust the builder's contained type to be covariant #797
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
|
|
AurisAudentis
changed the title
K-Phoen
approved these changes
Apr 26, 2025
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.
The problem
As of currently, the
grafana_foundation_sdkdoes not pass typechecking in its example.This is because the
with_targetfunction expects acogbuilder.Builder[cogvariants.Dataquery]type to be passed, but the prometheus query returns a Dataquery, which inherits fromcogbuilder.Builder[prometheus.Dataquery].This doesn't type check, because they are not the same type, and the generic type is not marked as covariant.
Solution
Given the implementation of
build, I believe the type is in practice covariant.Marking it as such fixes the type checking of the dashboard.