No error for overlapping overloads that vary in parameters with default values
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Bug Report
Mypy doesn't complain that the following overloads overlap with incompatible return types, but probably should:
from typing import overload
@overload
def foo(*, a: str = ...) -> str: ...
@overload
def foo(*, a: int | str = ...) -> int: ...
For comparison, pyright emits a diagnostic here (playground). Mypy does emit an error if a default value for a is omitted in either overload.
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
Reproduce the reported overload example in mypy and compare it with the existing behavior when a default value is omitted. Trace the overload-overlap checking entry point and add coverage for keyword-only parameters with default values; done means mypy reports the incompatible return types in the shown case without regressing the existing diagnostic.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100