可能重复:
我如何告诉 PyCharm 参数应该是什么类型?
我发现在 IntelliJ IDEA(和 PyCharm)中编码 Python,您可以使用 Epytext 或 reStructuredText 来记录预期的参数类型和返回类型。这些可以根据需要提供,以帮助 IDE 提供自动完成功能并改进其检查错误检查。
我不太清楚的是如何为实例变量和类变量指定类型注释。有没有办法以 IntelliJ 识别的方式做到这一点?
例如,假设 IntelliJ 无法推断 的返回类型some_function()
,并且该函数位于我们无法添加@rtype
注释的库中。如何提供self.bar
实例变量的类型?
class Foo:
def __init__(self):
# How can I document that self.bar is of type Bar?
self.bar = some_function()
编辑:
终于找到了记录实例变量类型的正确语法。在变量赋值之后直接放置一个文档字符串。
class Foo:
def __init__(self):
self.bar = some_function()
"""@type: Bar"""
需要注意的两件事是 IntelliJ/PyCharm似乎只理解变量 docstring format。注释文档字符串格式或在类文档字符串中指定类型不起作用。
此外,似乎存在一个错误,变量文档字符串不适用于双下划线前缀变量。