This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
[swappable] Annotate decorator with original type #3638
Merged
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.
Patch description
Unfortunately Python doesn't support an
Intersection
type hint (though they've been talking about it since 2014: https://www.python.org/dev/peps/pep-0483/).So we have to choose whether we tell static type checkers that the class returned by
@swappable
is the original class or a class that conforms toModularComponent
, we can't communicate both.I think it makes more sense to type check agains the original class, since it's much more likely that people will be accessing properties and methods of the original class rather than
swappables
andModularSubcomponents
, which are meant to be somewhat invisible in most cases.Testing steps
Open up IDE and verify that calls to properties of
@swappable
classes don't throw static type checking errors.CircleCI