文档字符串的旧类型语法
最后修改时间:2023 年 9 月 7 日PyCharm 支持使用文档字符串在 Python 中指定类型的传统方法。为此,支持的格式有:
要选择所需的文档字符串格式,请使用“设置”对话框的“Python 集成工具”页面。
Python 文档字符串中的类型语法没有由任何标准定义。因此,PyCharm 建议使用以下表示法:
句法 | 描述 |
---|---|
| Foo 类在当前范围内可见 |
| xy 模块中的类 Bar |
| Foo或酒吧 |
| Foo 和 Bar 的元组 |
| Foo 元素列表 |
| 从 Foo 到 Bar 的字典 |
| 泛型类型(TZ 为泛型保留) |
| 具有上限 Foo 的通用类型 |
| Foo 用 T 参数化 |
| 返回 Baz 的 Foo 和 Bar 函数 |
| 从 str 到 datetime 的字典列表(嵌套参数) |
指定局部变量的类型
:type
考虑使用或docstrings添加有关局部变量的预期类型的信息@type
:
也可以用来isinstance
定义预期的局部变量类型:
指定字段类型
您可以使用类型提示来指定预期的字段类型:
或者,您可以在类的文档字符串中指定字段的类型:
指定返回类型
使用文档字符串:rtype
或@rtype
指定预期的返回类型:
:rtype: collections.Iterable[int] # return type
: 'items' 的类型为generator
orcollections.Iterable
, 'a' 的类型为int
,请参见以下代码:def my_iter(): global i for i in range(10): yield i items = my_iter() for a in items: print a
:rtype: list[int] for my_iter # 返回类型: 'a' 的类型为
int
,见以下代码:def my_iter(): for i in range(10): yield i for a in my_iter(): print a
指定参数类型
考虑添加有关预期参数类型的信息。此信息是使用文档字符串指定的。您可以根据所选的文档字符串格式使用不同的文档字符串,例如:type
、@type
或Args
。使用项目设置来更改文档字符串格式(文件|设置|工具|Python集成工具)。
感谢您的反馈意见!