217

使用 Python 3 的函数注释,是否可以指定同质列表(或其他集合)中包含的项目类型,以便在 PyCharm 和其他 IDE 中进行类型提示?

int 列表的伪 python 代码示例:

def my_func(l:list<int>):
    pass

我知道可以使用 Docstring ...

def my_func(l):
    """
    :type l: list[int]
    """
    pass

...但如果可能的话,我更喜欢注释样式。

4

5 回答 5

241

回答我自己的问题;TLDR 的答案是No Yes

更新 2

2015 年 9 月,Python 3.5 发布,支持类型提示,并包含一个新的类型模块。这允许指定集合中包含的类型。截至 2015 年 11 月,JetBrains PyCharm 5.0 完全支持 Python 3.5,包括如下所示的类型提示。

使用类型提示完成 PyCharm 5.0 代码

更新 1

截至 2015 年 5 月,PEP0484(类型提示)已被正式接受。实现草案也可以在github 的 ambv/typehinting 下找到

原始答案

截至 2014 年 8 月,我已经确认无法使用 Python 3 类型注释来指定集合中的类型(例如:字符串列表)。

使用格式化的文档字符串(例如 reStructuredText 或 Sphinx)是可行的替代方案,并受到各种 IDE 的支持。

Guido 似乎也在考虑以 mypy 的精神扩展类型注释的想法:http: //mail.python.org/pipermail/python-ideas/2014-August/028618.html

于 2014-08-15T02:37:15.947 回答
142

现在 Python 3.5 正式发布,有类型提示支持模块 -typing以及通用容器的相关List“类型”。

换句话说,现在你可以这样做:

from typing import List

def my_func(l: List[int]):
    pass
于 2015-10-25T01:55:52.447 回答
68

从 Python 3.9 开始,内置类型在类型注释方面是通用的(参见PEP 585)。这允许直接指定元素的类型:

def my_func(l: list[int]):
    pass

各种工具可能在 Python 3.9 之前支持这种语法。如果在运行时未检查注释,则使用引号或__future__.annotations.

# quoted
def my_func(l: 'list[int]'):
    pass
# postponed evaluation of annotation
from __future__ import annotations

def my_func(l: list[int]):
    pass
于 2020-07-07T12:48:41.290 回答
43

自PEP 484起已添加类型注释

from . import Monitor
from typing import List, Set, Tuple, Dict


active_monitors = [] # type: List[Monitor]
# or
active_monitors: List[Monitor] = []

# bonus
active_monitors: Set[Monitor] = set()
monitor_pair: Tuple[Monitor, Monitor] = (Monitor(), Monitor())
monitor_dict: Dict[str, Monitor] = {'codename': Monitor()}

# nested
monitor_pair_list: List[Dict[str, Monitor]] = [{'codename': Monitor()}]

这目前正在使用 Python 3.6.4 在 PyCharm 上为我工作

Pycharm 中的示例图片

于 2018-04-08T10:28:32.250 回答
4

在 BDFL 的支持下,现在几乎可以肯定 python(可能是 3.5)将通过函数注释为类型提示提供标准化语法。

https://www.python.org/dev/peps/pep-0484/

正如 PEP 中所引用的,有一个名为 mypy 的实验性类型检查器(有点像 pylint,但用于类型),它已经使用了这个标准,并且不需要任何新的语法。

http://mypy-lang.org/

于 2015-01-30T21:52:07.590 回答