overloads in `if TYPE_CHECKING` shouldn't require implementations
Open
Nobody has claimed this yet.
feature
topic-overloads
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
As I explained in the title.
Pitch
Currently this raises an error:
from typing import TYPE_CHECKING, overload
if TYPE_CHECKING:
@overload # E: An overloaded function outside a stub file must have an implementation
def f(x: int) -> str:
...
@overload
def f(x: str) -> bytes:
...
I think that if code is in if TYPE_CHECKING then it shouldn't need an implementation though.
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
Start by reproducing the diagnostic with the provided TYPE_CHECKING and overload snippet, then trace the type-checking path that reports the missing implementation. Done means overloads inside TYPE_CHECKING are accepted without an implementation while the existing requirement remains for ordinary Python code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- compilers, devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100