(🎁) Error messages for decorator applications have a very bad UX
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
from typing import Callable
def decorator(f: object) -> Callable[[Callable[[int], object]], None]: ...
def f(a: int) -> None: ...
@decorator(f) # error: Argument 1 has incompatible type "Callable[[], Any]"; expected "Callable[[int], object]" [arg-type]
def something(): ...
So the error is that the function something doesn't have the right type for the decorator, but the message is quite misleading, it reads like the error is with the call to decorator and f.
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 decorator example in the issue and trace how mypy reports the decorator application. No source file or test is named, so locating the relevant diagnostic and deciding the intended wording will require exploring the type-checker implementation. Done means the error clearly identifies the incompatible function being decorated rather than implying a problem with the decorator call.
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
- Needs clarification
- Newbie friendliness
- 35/100