Overload ambiguity is ignored in `self`-annotated methods
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Bug Report
Per the title: mypy does not check for overload ambiguity in self-annotated methods.
Mypy will instead, effectively, ignore self and then return the first matching overload,
thus circumventing the usual Any that is returned when overload ambiguity is involved.
This has lead to a number of false positives in https://github.com/numpy/numpy/issues/20099 and (in part) https://github.com/numpy/numpy/issues/20072.
The conditions for triggering this bug are as following:
- The callable is a method (things work fine for functions).
- The method is overloaded.
selfmust be annotated with a parametrized generic.
To Reproduce
from typing import Any, Generic, overload, TypeVar, TYPE_CHECKING
import numpy as np
_CharType = TypeVar("_CharType", np.str_, np.bytes_)
class CharArray(Generic[_CharType]):
@overload
def strip(self: CharArray[np.str_], chars: str = ...) -> CharArray[np.str_]: ...
@overload
def strip(self: CharArray[np.bytes_], chars: bytes = ...) -> CharArray[np.bytes_]: ...
ar_any: CharArray[Any]
ar_str: CharArray[np.str_]
ar_bytes: CharArray[np.bytes_]
if TYPE_CHECKING:
# The good
reveal_type(ar_str.strip()) # E: Revealed type is "__main__.CharArray[numpy.str_]"
reveal_type(ar_bytes.strip()) # E: Revealed type is "__main__.CharArray[numpy.bytes_]"
# The bad
# "__main__.CharArray[Any]" would be expected here due to overload ambiguity
reveal_type(ar_any.strip()) # E: Revealed type is "__main__.CharArray[numpy.str_]"
# Calling the method directly from the class does do the trick
reveal_type(CharArray.strip(ar_any)) # E: Revealed type is "test.CharArray[Any]"
Your Environment
- Mypy version used: 0.910
- Mypy command-line flags: n.a.
- Mypy configuration options from
mypy.ini(and other config files): n.a. - Python version used: 3.9.6
- Operating system and version: macOS 11.4
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die bereitgestellte Python-Reproduktion mit mypy auszuführen, und vergleiche die aufgedeckten Typen für die Aufrufe der überladenen Methode. Verfolge die Überladungsauflösung für Methoden, deren self-Parameter ein parametrischer Generic ist; abgeschlossen ist die Aufgabe, wenn der mehrdeutige Aufruf CharArray[Any].strip() Any zurückgibt, während die konkreten self-Typen ihre spezifischen Ergebnisse beibehalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- numpy, python
- Bereich
- compilers, devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100