fix(typing): typed overloads for expect_event and wait_for_event#3061
Open
dgozman wants to merge 2 commits intomicrosoft:mainfrom
Open
fix(typing): typed overloads for expect_event and wait_for_event#3061dgozman wants to merge 2 commits intomicrosoft:mainfrom
dgozman wants to merge 2 commits intomicrosoft:mainfrom
Conversation
Generates @typing.overload stubs keyed on Literal event names with their payload types from api.json, so pyright/mypy can narrow the return type at call sites instead of falling back to Any/Unknown. Fixes: microsoft#3047
yury-s
approved these changes
Apr 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
@typing.overloadstubs forexpect_event/wait_for_eventkeyed onLiteral["event_name"]with the payload type fromapi.json, plus a catch-allevent: stroverload returningEventContextManager[Any]/Any.info.valuenow narrows to the correct payload type (e.g.Requestforexpect_event("requestfinished")) instead ofAny/Unknownunder strict pyright.ResourceTimingvsDict, optionalError.stack).Fixes #3047