如何在Pycharm 2018.2中的类方法声明中添加带有类型提示的文档？

Question

假设我有一个如下所示的类方法-

class BasePreStep:
    def __init__(self, threadpool, release_manifest, service_manifest, upgrade_bundle, system_config):

如果我像下面这样添加类型提示，那么自动完成在python文件中可以正常工作。

class BasePreStep:
    __metaclass__ = ABCMeta

    def __init__(self, threadpool, release_manifest, service_manifest, upgrade_bundle, system_config):
        # type: (self, ThreadPool, service_version_pb2.ReleaseManifest, service_version_pb2.ServiceManifest, str, SystemConfig) -> ()

但是如果我像下面这样添加注释(如解释的这里)，那么自动完成在python文件中就不能工作了。

类BasePreStep：元类= ABCMeta

def __init__(self, threadpool, release_manifest, service_manifest, upgrade_bundle, system_config):
    """

    :param threadpool: Threadpool
    :param release_manifest: service_version_pb2.ReleaseManifest
    :param service_manifest: service_version_pb2.ServiceManifest
    :param upgrade_bundle: str
    :param system_config: SystemConfig
    """

有人能让我知道在Pycharm中添加注释和类型提示的推荐方法吗？

• Python 2.7
• Pycharm 2018.2

Answer 1

文档字符串中的param被视为描述，而不是类型注释，这就是第二个示例不能工作的原因。

你在这里有两个选择：

1. 向docstring中添加描述和类型： 类类: def方法(self，p1，p2)：“:param p1:参数1:类型p1: str :param p2: p2 2 :type p2: str”
2. 在类型注释中向docstring和文档类型添加描述(这必须放在docstring之前，否则Pycharm就不会识别它)。 类类: def方法(self，p1，p2)：# type：(str，str) -> None“:param p1:参数1 :param p2：->2”