Zusammenfassung

Typ-Aliase sind vom Benutzer spezifizierte Typen, die so komplex sein können wie jede Typ-Annotation und mit einer einfachen Variablenausweisung auf Modulebene spezifiziert werden.

Dieses PEP formalisiert eine Methode zur expliziten Deklaration einer Zuweisung als Typ-Alias.

Motivation

Typ-Aliase werden als Variablenausweisungen auf oberster Ebene deklariert. In PEP 484 wurde die Unterscheidung zwischen einem gültigen Typ-Alias und einer globalen Variable implizit bestimmt: Wenn eine Zuweisung auf oberster Ebene nicht annotiert ist und der zugewiesene Wert ein gültiger Typ ist, dann ist der Name, dem zugewiesen wird, ein gültiger Typ-Alias. Andernfalls ist dieser Name einfach ein globaler Wert, der nicht als Typ-Annotation verwendet werden kann.

Diese impliziten Regeln zur Deklaration von Typ-Aliasen führen zu Verwirrung, wenn Typ-Aliase Vorwärtsreferenzen, ungültige Typen enthalten oder andere Einschränkungen verletzen, die für die Deklaration von Typ-Aliasen gelten. Da die Unterscheidung zwischen einem nicht annotierten Wert und einem Typ-Alias implizit ist, werden mehrdeutige oder fehlerhafte Deklarationen von Typ-Aliasen implizit als gültige Wertzuweisung behandelt. Dies führt zu Ausdrücken, die sich nicht als Typ-Aliase ausdrücken lassen, und verschiebt die Fehlerdiagnose von fehlerhaften Typ-Aliasen nach unten.

Die folgenden Beispiele enthalten jeweils eine Illustration einiger suboptimalen oder verwirrenden Verhaltensweisen, die sich aus bestehenden impliziten Alias-Deklarationen ergeben. Zum Vergleich führen wir hier auch explizite Aliase im Format TypName: TypeAlias = Ausdruck ein, aber die Syntax wird in späteren Abschnitten detaillierter diskutiert.

MyType = "ClassName"
def foo() -> MyType: ...

MyType: TypeAlias = "ClassName"
def foo() -> MyType: ...

MyType1 = InvalidType
MyType2 = MyGeneric(int)  # i.e., intention was MyGeneric[int]

MyType1: TypeAlias = InvalidType
MyType2: TypeAlias = MyGeneric(int)

class Foo:
  x = ClassName
  y: TypeAlias = ClassName
  z: Type[ClassName] = ClassName

x = ClassName
def foo() -> None:
  x = ClassName

x: TypeAlias = ClassName
def foo() -> None:
  x = ClassName
def bar() -> None:
  x: TypeAlias = ClassName

Spezifikation

Die explizite Syntax für die Alias-Deklaration unterscheidet klar zwischen den drei möglichen Arten von Zuweisungen: typisierte globale Ausdrücke, nicht typisierte globale Ausdrücke und Typ-Aliase. Dies vermeidet Zuweisungen, die die Typüberprüfung beim Hinzufügen einer Annotation brechen, und vermeidet die Klassifizierung der Art der Zuweisung basierend auf dem Typ des Werts.

Implizite Syntax (vorhanden)

x = 1  # untyped global expression
x: int = 1  # typed global expression

x = int  # type alias
x: Type[int] = int  # typed global expression

Explizite Syntax

x = 1  # untyped global expression
x: int = 1  # typed global expression

x = int  # untyped global expression (see note below)
x: Type[int] = int  # typed global expression

x: TypeAlias = int  # type alias
x: TypeAlias = "MyClass"  # type alias

Hinweis: Die obigen Beispiele veranschaulichen implizite und explizite Alias-Deklarationen isoliert. Aus Gründen der Abwärtskompatibilität sollten Typ-Checker beide gleichzeitig unterstützen, was bedeutet, dass ein nicht typisierter globaler Ausdruck x = int immer noch als gültiger Typ-Alias betrachtet wird.

Abwärtskompatibilität

Explizite Aliase bieten eine alternative Möglichkeit, Typ-Aliase zu deklarieren, aber der gesamte bestehende Code und alte Alias-Deklarationen funktionieren weiterhin wie bisher.

Referenzimplementierung

Der Pyre Typ-Checker unterstützt explizite Typ-Alias-Deklarationen.

Abgelehnte Ideen

Einige alternative Syntaxen wurden für explizite Aliase in Betracht gezogen

MyType: TypeAlias[int]

Dies sieht sehr nach einer nicht initialisierten Variable aus.

MyType = TypeAlias[int]

Neben der obigen Option birgt dieses Format die Gefahr, Verwirrung darüber zu stiften, was der Laufzeitwert von MyType ist.

Im Vergleich dazu ist die gewählte Syntaxoption MyType: TypeAlias = int ansprechend, da sie weiterhin die Zuweisungssyntax MyType = int beibehält und lediglich um Informationen für den Typ-Checker als Annotation ergänzt.

Versionshistorie

• 2021-11-16
  • Erlaube TypeAlias im Klassengeltungsbereich

Urheberrecht

Dieses Dokument wird in die Public Domain oder unter die CC0-1.0-Universal-Lizenz gestellt, je nachdem, welche Lizenz permissiver ist.