Fix misleading pyright error when calling async task with wrong argument types #19327
+30
−1
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.
closes #19326
Summary
Fixes a confusing pyright error message when calling async tasks with incorrect argument types.
Before: Calling an async task with wrong arg types showed:
After: Shows normal argument type error (or no error if types are correct)
Root Cause
When pyright couldn't match task arguments to the specific overload (e.g., passing
Noneinstead ofstr), it fell back to the*args: Unknownoverloads. Thereturn_state=Trueoverload was listed first, so pyright picked it and inferredState[Coroutine[...]]instead ofCoroutine[...].Changes
Task[P, Coroutine[Any, Any, R]]overloads toTask.__call__(similar to whatsubmit()andmap()already have)return_state=Falsecomes beforereturn_state=True- ensures pyright picks the correct default behavior when it can't match argument typesTesting
tests/test_tasks.py::TestTaskCall)Reproduction
🤖 Generated with Claude Code