摘要

类型别名是用户指定的类型，其复杂度可以与任何类型提示一样，并且通过模块顶层的简单变量赋值来指定。

此PEP规范化了一种将赋值显式声明为类型别名的方法。

动机

类型别名被声明为顶层变量赋值。在 PEP 484 中，有效类型别名和全局变量之间的区别是隐式确定的：如果顶层赋值未带注释，并且赋值的值是有效的类型，则被赋值的名称是有效的类型别名。否则，该名称只是一个全局值，不能用作类型提示。

这些隐式类型别名声明规则在类型别名涉及前向引用、无效类型或违反对类型别名声明实施的其他限制时会造成混淆。由于未注释的值和类型别名之间的区别是隐式的，因此不明确或不正确的类型别名声明隐式默认为有效的赋值。这会创建无法表示为类型别名的表达式，并将错误诊断的格式错误的类型别名推迟到下游。

以下示例每个都包含对由现有隐式别名声明导致的一些次优或混淆行为的说明。为了进行比较，我们在此也引入了格式为 TypeName: TypeAlias = Expression 的显式别名，但语法将在后面的部分中详细讨论。

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

规范

显式别名声明语法清楚地区分了三种可能的赋值类型：带类型注释的全局表达式、未带类型注释的全局表达式和类型别名。这避免了在添加注释时破坏类型检查的赋值的存在，并且避免了根据值的类型对赋值的性质进行分类。

隐式语法（预先存在）

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

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

显式语法

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

注意：以上示例独立说明了隐式和显式别名声明。为了向后兼容，类型检查器应该同时支持两者，这意味着未带类型注释的全局表达式 x = int 仍将被视为有效的类型别名。

向后兼容性

显式别名提供了一种声明类型别名的替代方法，但所有预先存在的代码和旧的别名声明将像以前一样工作。

参考实现

Pyre 类型检查器支持显式类型别名声明。

被拒绝的想法

一些替代语法被考虑用于显式别名

MyType: TypeAlias[int]

这看起来很像一个未初始化的变量。

MyType = TypeAlias[int]

除了上述选项外，此格式还可能在 MyType 的运行时值是什么方面造成混淆。

相比之下，选择的语法选项 MyType: TypeAlias = int 很有吸引力，因为它仍然坚持使用 MyType = int 赋值语法，并为类型检查器添加了一些信息作为注释。

版本历史

• 2021-11-16
  • 允许在类范围内使用 TypeAlias

版权

本文档置于公共领域或根据CC0-1.0-Universal许可证，以较宽松者为准。