iscoroutinefunction should use TypeIs
Open
Beginner friendly
Nobody has claimed this yet.
stubs: improvement
- Dominant language
- Python
- Stars
- 5.1k
- Forks
- 2.1k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 82
Description
One of the things I find myself writing a lot is
if iscoroutinefunction(myfunction):
do_something_with_async(myfunction)
else:
do_something_with_just_sync(myfunction)
however the else block doesn't narrow the type to non-awaitable. Shouldn't it? Some of the other is... functions in inspect seem to use TypeIs as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the typeshed stub entry for inspect.iscoroutinefunction and compare its annotation with the other inspect is... functions that use TypeIs. Update the annotation so both branches narrow as described, then run the relevant type-checking tests to confirm coroutine functions and the else branch are narrowed correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100