-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Handle type guards properly in Receiver.filter()
#332
Open
llucax
wants to merge
1
commit into
frequenz-floss:v1.x.x
Choose a base branch
from
llucax:filter-guard
base: v1.x.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Now the `Receiver` type returned by `Receiver.filter()` will have the narrowed type when a `TypeGuard` is used. Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
Affects the documentation
part:tests
Affects the unit, integration and performance (benchmarks) tests
part:core
Affects the core types (`Sender`, `Receiver`, exceptions, etc.)
labels
Nov 14, 2024
shsms
reviewed
Nov 14, 2024
Comment on lines
+319
to
+327
# We need to use Any here because otherwise _Filter would have to deal with two | ||
# different signatures. We can create two filter classes, one for regular functions | ||
# and one for type guards, but then there is no way to tell at runtime which | ||
# function is a type guard and which isn't to instantiate the correct class. | ||
# Using Any here has no impact though, as thanks to the overloads, only the | ||
# overloaded types will be accepted. | ||
def filter( | ||
self, filter_function: Callable[[ReceiverMessageT_co], Any], / | ||
) -> Receiver[Any]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't need to change _Filter
because TypeGuard
is just another name for bool, with some additional semantic meaning. The type system knows assigning a TypeGuard
value to a bool
is fine.
Suggested change
# We need to use Any here because otherwise _Filter would have to deal with two | |
# different signatures. We can create two filter classes, one for regular functions | |
# and one for type guards, but then there is no way to tell at runtime which | |
# function is a type guard and which isn't to instantiate the correct class. | |
# Using Any here has no impact though, as thanks to the overloads, only the | |
# overloaded types will be accepted. | |
def filter( | |
self, filter_function: Callable[[ReceiverMessageT_co], Any], / | |
) -> Receiver[Any]: | |
def filter( | |
self, | |
filter_function: ( | |
Callable[[ReceiverMessageT_co], bool] | |
| Callable[[ReceiverMessageT_co], TypeGuard[FilteredMessageT_co]] | |
), | |
/, | |
) -> Receiver[ReceiverMessageT_co] | Receiver[FilteredMessageT_co]: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
part:core
Affects the core types (`Sender`, `Receiver`, exceptions, etc.)
part:docs
Affects the documentation
part:tests
Affects the unit, integration and performance (benchmarks) tests
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.
Now the
Receiver
type returned byReceiver.filter()
will have the narrowed type when aTypeGuard
is used.