什么是变量注释?

Python 3.6即将发布。PEP 494—— Python 3.6发布时间表提到了12月底,所以我查了一下 Python 3.6中的新特性,看到他们提到了 变量注释变量注释:

PEP 484 引入了函数参数的类型注释标准,也就是类型提示。这个 PEP 将语法添加到 Python 中,用于注释包括类变量和实例变量在内的变量类型:

primes: List[int] = []


captain: str  # Note: no initial value!


class Starship:
stats: Dict[str, int] = {}

与函数注释一样,Python 解释器不会为变量注释附加任何特定含义,而只是将它们存储在类或模块的特殊属性 __annotations__中。与静态类型语言中的变量声明不同,注释语法的目标是提供一种简单的方法,通过抽象语法树和 __annotations__属性为第三方工具和库指定结构化类型元数据。

So from what I read they are part of the type hints coming from Python 3.5, described in What are Type hints in Python 3.5.

我遵循 captain: strclass Starship的例子,但是不确定最后一个: primes: List[int] = []是如何解释的?它是否定义了一个只允许整数的空列表?

70823 次浏览

:=之间的所有内容都是类型提示,因此 primes确实定义为 List[int],并且最初设置为空列表(而 stats最初是一个空字典,定义为 Dict[str, int])。

List[int] and Dict[str, int] are not part of the next syntax however, these were already defined in the Python 3.5 typing hints PEP. The 3.6 PEP 526-< em > 可变注释的语法 proposal only defines the syntax to attach the same hints to variables; before you could only attach type hints to variables with comments (e.g. primes = [] # List[int]).

Both List and Dict are 通用的 types, indicating that you have a list or dictionary mapping with specific (concrete) contents.

对于 List,只有一个“参数”([...]语法中的元素) ,即列表中每个元素的类型。对于 Dict,第一个参数是键类型,第二个参数是值类型。因此 primes列表中的 所有值是整数,stats字典中的 所有键值对是 (str, int)对,将字符串映射为整数。

请参阅 typing.Listtyping.Dict定义、 关于 < em > 通用类别 的部分以及 PEP 483-< em > 类型暗示理论

与函数的类型提示一样,它们的使用也是可选的,也被认为是 注释(只要有一个对象可以附加它们,所以模块中的全局变量和类中的属性,而不是函数中的局部变量) ,您可以通过 __annotations__属性进行自省。您可以将任意信息附加到这些注释中,并不严格限制类型提示信息。

您可能需要阅读 全部建议; 它包含一些新语法之上和之外的附加功能; 例如,它指定何时计算这些注释,如何内省它们,以及如何将某些内容声明为类属性或实例属性。

What are variable annotations?

变量注释只是 # type注释的下一步,因为它们是在 PEP 484中定义的; 这种变化背后的基本原理在 respective section of PEP 526中突出显示。

因此,与其用以下方式暗示类型:

primes = []  # type: List[int]

引入了新的语法 ,允许直接使用赋值形式对类型进行注释:

primes: List[int] = []

正如@Martijn 指出的,它通过使用 typing中可用的类型并将其初始化为一个空列表来表示整数列表。

它带来了什么变化?

引入的第一个更改是 new syntax,它允许您使用类型对名称进行注释,既可以在 :字符之后单独注释,也可以选择注释,同时为其分配一个值:

annotated_assignment_stmt ::=  augtarget ":" expression ["=" expression]

So the example in question:

   primes: List[int] = [ ]
#    ^        ^         ^
#  augtarget  |         |
#         expression    |
#                  expression (optionally initialize to empty list)

新语法还引入了其他更改; 模块和类现在有一个 __annotations__属性(就像自 图片来源: http://www.python.org/dev/peps/PEP-3107/rel = “ noReferrer”> PEP 3107——功能注释以来的函数一样) ,其中附加了类型元数据:

from typing import get_type_hints  # grabs __annotations__

现在,__main__.__annotations__保存声明的类型:

>>> from typing import List, get_type_hints
>>> primes: List[int] = []
>>> captain: str
>>> import __main__
>>> get_type_hints(__main__)
{'primes': typing.List<~T>[int]}

captain目前不会通过 get_type_hints显示,因为 get_type_hints只返回可以在模块上访问的类型; 也就是说,它首先需要一个值:

>>> captain = "Picard"
>>> get_type_hints(__main__)
{'primes': typing.List<~T>[int], 'captain': <class 'str'>}

使用 print(__annotations__)将显示 'captain': <class 'str'>,但是您实际上不应该直接访问 __annotations__

Similarly, for classes:

>>> get_type_hints(Starship)
ChainMap({'stats': typing.Dict<~KT, ~VT>[str, int]}, {})

其中,ChainMap用于获取给定类的注释(位于第一个映射中)以及在其 mro中找到的基类中定义的所有注释(结果映射,对象为 {})。

除了新的语法之外,还增加了一个新的 ClassVar类型来表示类变量。是的,在你的例子中,stats实际上是 实例变量,而不是 ClassVar

Will I be forced to use it?

与来自 PEP 484的类型提示一样,它们是 完全可选,主要用于类型检查工具(以及您可以根据这些信息构建的任何其他工具)。当 Python 3.6的稳定版本发布时,这将是临时性的,因此将来可能会添加一些小的调整。