python / python/mypy

Type inference of generic types: no way to be warned about Generic[Any]

Offen
#7,248 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature priority-1-normal
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Usage specs: mypy 0.720 on Python 3.7.3
Bug or feature request: Not really a bug, just a usability inconvenience and potential source of errors

Problem Description

Hello!
I've just realised that a certain way of type checking generic classes (even built-in ones like Sequence, List, Mapping...) can be very error-prone:
There's no way to be warned by mypy when inferring the type of a generic variable which has no explicit type parameter, e.g when inferring the Generic[Any] type through an isinstance(value, Generic) call.
This is error-prone due to the dynamic nature of Any, which allows a Generic[Any] to masquerade as a more specific generic type of the same kind: for instance, a Sequence[Any] variable can be assigned to a variable of Sequence[str] type.

I know that the disallow_any_generics option warns us when we define type hints for generic types with no type parameters: sequence:Sequence = ["hello"] would trigger an error from mypy.
What bothers me is that there is no way to be warned about it when the type is inferred by mypy through an isinstance call.

Minimal Example

Consider the function below, which is supposed to return a Sequence[str], but does not actually ensure that each item inside the sequence is a string.

# coding: utf-8
# mypy: warn_return_any
# mypy: disallow_any_expr
# mypy: disallow_any_generics
from typing import Sequence

def getStringSequence(value:object) -> Sequence[str]:
    if isinstance(value, Sequence):
        reveal_type(value) # Revealed type is Sequence[Any]
        return value
    raise TypeError

This example is successfully type checked by mypy, while I would expect it to trigger an error:
In the return statement, mypy allows me to return a Sequence[Any] from the function, when a Sequence[str] was expected instead.

I understand that this is due to the dynamic nature of Any, but given my use of the warn_return_any, disallow_any_expr and disallow_any_generics options, I would expect mypy to warn me about it.

Discussion

Not sure about which combination of these 3 options should trigger an error?

This is all highly debatable, but at a glance, I'd say that:

  • When warn_return_any is True, mypy should warn us whenever we return a Generic[Any], even if it is merely inferred and not explicitly typed through an hint. In the above code example, an error would be raised in the return statement.
  • When warn_any_expr is True, mypy should warn us whenever we use a Generic[Any], even if it is merely inferred. I assume the error would be raised on the first statement to use the variable whose type was inferred. In the above example, an error would be raised in the return statement again.
  • Both of these behaviours should be enabled only when disallow_any_generics is True as well.

To provide more context, my use case is type checking arbitrary data structures loaded from declarative formats like JSON and YAML, hence my reliance on type inference over type hints.

I realise it's possible to correct this function's return statement easily: return tuple(item for item in value if isinstance(item, str))
But I still find the risk of accidentally having Any masquerade as a more specific type parameter fairly worrying, so it'd be great to have a way to be warned about it.


Thanks for reading, hope I was clear enough.
Many, many thanks for your collective hard work on mypy!

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem minimalen Python-Beispiel im Issue und reproduziere dessen aufgedeckten Sequence[Any]-Typ mit warn_return_any, disallow_any_expr und disallow_any_generics. Untersuche, wie mypy inferierte generische Typen und Diagnosen für diese Optionen behandelt, und definiere und teste anschließend das beabsichtigte Warnverhalten für die return-Anweisung.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.