使用 Python 3 的函数注释,是否可以指定同质列表(或其他集合)中包含的项目类型,以便在 PyCharm 和其他 IDE 中进行类型提示?
int 列表的伪 python 代码示例:
def my_func(l:list<int>):
pass
我知道可以使用 Docstring ...
def my_func(l):
"""
:type l: list[int]
"""
pass
...但如果可能的话,我更喜欢注释样式。
type object is not subscriptable
在定义函数时。显然你可以使用一个字符串: def my_func(L: 'list[int]')
但我不知道 PyCharm 是否会在解析文档字符串时解析它......
'list[int]'
,如果不清楚,请道歉。
回答我自己的问题; TLDR 的答案是否定的。
更新 2
2015 年 9 月,Python 3.5 发布,支持类型提示并包含一个 new typing module。这允许指定集合中包含的类型。截至 2015 年 11 月,JetBrains PyCharm 5.0 完全支持 Python 3.5,包括如下所示的类型提示。
https://i.stack.imgur.com/KHn4f.jpg
更新 1
截至 2015 年 5 月,PEP0484 (Type Hints) 已被正式接受。实施草案也可在 github under ambv/typehinting 获得。
原始答案
截至 2014 年 8 月,我已经确认无法使用 Python 3 类型注释来指定集合中的类型(例如:字符串列表)。
使用格式化的文档字符串(例如 reStructuredText 或 Sphinx)是可行的替代方案,并受到各种 IDE 的支持。
Guido 似乎也在考虑本着 mypy 的精神扩展类型注释的想法:http://mail.python.org/pipermail/python-ideas/2014-August/028618.html
更新:请看其他答案,这个已经过时了。
原始答案(2015):
现在 Python 3.5 正式发布,有类型提示支持模块 - typing
和用于通用容器的相关 List
“类型”。
换句话说,现在你可以这样做:
from typing import List
def my_func(l: List[int]):
pass
从 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
自 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 上为我工作
https://i.stack.imgur.com/J38BN.png
在 BDFL 的支持下,现在几乎可以肯定 python(可能是 3.5)将通过函数注释为类型提示提供标准化语法。
https://www.python.org/dev/peps/pep-0484/
正如 PEP 中所引用的,有一个名为 mypy 的实验性类型检查器(有点像 pylint,但用于类型),它已经使用了这个标准,并且不需要任何新的语法。
l: List[str]
。赞成alecxe的答案,因为它以纯文本形式显示。