Better message for overloaded functions with required kwargs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
The following:
from typing import overload, Union
def fun(a: Union[int, str], *, b: bool) -> None:
pass
fun(1, True)
says helpfully:
main.py:6: error: Too many positional arguments for "fun" [misc]
Found 1 error in 1 file (checked 1 source file)
In the following case however:
from typing import overload, Union
@overload
def fun(a: int, *, b: bool) -> None: ...
@overload
def fun(a: str, *, b: bool) -> None: ...
def fun(a: Union[int, str], *, b: bool) -> None:
pass
fun(1, True)
we get:
main.py:12: error: No overload variant of "fun" matches argument types "int", "bool" [call-overload]
main.py:12: note: Possible overload variants:
main.py:12: note: def fun(a: int, *, b: bool) -> None
main.py:12: note: def fun(a: str, *, b: bool) -> None
Found 1 error in 1 file (checked 1 source file)
I think the error should also point out that the number of positional arguments is incorrect.
Pitch
I found myself confused by this a couple of times and have wasted good few hours trying to understand what's wrong with the call which is clearly correct, and just glancing straight past the * - something that's easy to do with a longer / more complicated function signature. I think it would save a meaningful amount of time for users and it feels like a simple change.
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 both Python examples in the linked mypy-playground cases and compare their diagnostics. Done means the overloaded-function error also explains that the positional argument count is invalid, while retaining the overload details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100