如何在 PyCharm 解析器的文档字符串中指定类或函数类型

Question

我经常使用 Pycharm 文档字符串类型解析器来指定方法参数和返回的类型、属性或实例变量。如果它几乎一直都有效，我有一点关于告诉 PyCharm 我将函数或类作为参数/属性/...

这是一个简短的例子：

class Bar:

    def __init__(self, bar):
        """
        :type bar: str
        """
        print bar

class Foo:
    """
    :type my_class: Bar.__class__
    """

    def __init__(self, cinstance=Bar):
        """
        :type cinstance: Bar.__class__
        """
        self.my_class = cinstance

    def run(self):
        # it should print an unexpected type warning, but it doesn't.
        self.my_class(2)

如果我只输入Bar 而不是Bar.__class__，PyCharm 会告诉我不能调用Bar。那么如何告诉他我正在给他上课呢？

请注意，使用 @classmethod 装饰器，PyCharm 可以毫无问题地理解我们谈论的是类而不是实例。

这是我的尝试：

Answer 1

PyCharm 支持告诉我以下内容：

正如 PyCharm 开发人员所说：您无法在类型提示中区分类和实例。类型提示中的类名意味着需要该类的实例。如果您的函数接受类本身，则您的选择是根本不使用类型提示或使用“类型”作为类名。无论如何，在这些情况下不会有任何有用的代码完成。另见https://youtrack.jetbrains.com/issue/PY-11615。

指定参数的唯一方法是使用类是使用:type arg: type，但完成不会很好。目前没有其他办法。

Answer 2

如果你想指定一个参数的类型是SomeClass，它应该这样声明：

@type (param): SomeClass

如果指定正确，你应该会得到这样的结果：

如果您没有正确指定参数的类型：

在这一点上，我想我会更深入地挖掘一下，看看我是否能找到任何有趣的东西。如果你去声明一个对象的.__class__，你会被引导到这里（builtins.py）：

也许__class__ 被设置为None？即使它是默认的，但在类被实例化时会更新（这将是我对会发生什么的猜测），这也可能是 PyCharm 推断的 __class__ 解析到的。所有这些都只是我的猜测，也可能是不正确的，但是......只是为了它，如果我们将参数的类型设置为None，我们会看到什么行为呢？

看起来与我们将类型设置为 SomeClass.__fake__ 时发生的事情相同（我用SomeClass.__class__ 对其进行了测试，那里也发生了同样的事情。）

所以我想现在的问题是，你为什么不能使用@type cinstance: Bar？

Answer 3

对于函数，使用 callable 指定适用于 PyCharm。

Answer 4

试试这个：

from typing import Type

def __init__(self, klass: Type[Bar]):
    pass