关于python：我如何告诉PyCharm参数的类型是什么？

How can I tell PyCharm what type a parameter is expected to be?

当涉及到构造函数、赋值和方法调用时，pycharm-ide非常擅长分析源代码并找出每个变量应该是什么类型。我喜欢它是正确的，因为它给我很好的代码完成和参数信息，如果我试图访问一个不存在的属性，它会给我警告。

但当涉及到参数时，它什么也不知道。代码完成下拉列表不能显示任何内容，因为它们不知道参数的类型。代码分析无法查找警告。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

class Person:
def __init__(self, name, age):
self.name = name
self.age = age

peasant = Person("Dennis", 37)
# PyCharm knows that the"peasant" variable is of type Person
peasant.dig_filth() # shows warning -- Person doesn't have a dig_filth method

class King:
def repress(self, peasant):
# PyCharm has no idea what type the"peasant" parameter should be
peasant.knock_over() # no warning even though knock_over doesn't exist

King().repress(peasant)
# Even if I call the method once with a Person instance, PyCharm doesn't
# consider that to mean that the"peasant" parameter should always be a Person

这是有一定意义的。其他调用站点可以传递该参数的任何内容。但是，如果我的方法期望一个参数是类型，比如说，pygame.Surface，我希望能够以某种方式向pycharm表明这一点，这样它可以在其代码完成下拉列表中显示Surface的所有属性，并在调用错误的方法时突出显示警告，等等。

有没有一种方法可以给pycharm一个提示，然后说"psst，这个参数应该是x类型"？(或者，根据动态语言的精神，"这个参数应该像x一样颤动"？我会同意的。)

编辑：下面是Crazycoder的答案。对于像我这样想要快速总结的新来者，这里是：

1
2
3
4
5
6
7
8
9
10

class King:
def repress(self, peasant):
"""
Exploit the workers by hanging on to outdated imperialist dogma which
perpetuates the economic and social differences in our society.

@type peasant: Person
@param peasant: Person to repress.
"""
peasant.knock_over() # Shows a warning. And there was much rejoicing.

号

相关部分是docstring的@type peasant: Person行。

如果您还转到"文件>设置>Python集成工具"并将"docstring格式"设置为"epytext"，那么pycharm的"视图>快速文档查找"将漂亮地打印参数信息，而不是按原样打印所有@行。