python-3.x - python在文档字符串中自动添加类型提示

Question

我正在寻找一种工具，可以将函数中已经添加的类型注释添加到 PyCharm 生成的文档字符串中。

我在 JetBrains 上关注这个问题很长时间了，这张票似乎还没有取得任何进展。

我也看到了这篇文章，但它似乎太具体了，只适用于谷歌文档字符串。

我已经在 PyPI 上检查了这个包，但这与我需要的相反。我需要将参数中提供的类型提示添加到文档字符串中，而不是相反。

这可能与如何使 PyCharm 从函数定义中获取类型提示并在文档字符串中填充类型值有关？，但我只需要一个通用解决方案，或者至少需要一个与 Numpy docstring 或 reStructuredText 一起使用并且可能与 PyCharm 配合得很好的解决方案。

我只是看到自己回来研究这个东西，希望能得到一些东西，但找不到我需要的东西。什么工具可以解决这个问题？

标签： python-3.xpycharmtype-hintingpython-typingdocstring

Answer 1

几个月前我在搜索时，找不到任何可用的解决方案。现在，我正在使用带有这个扩展的 VS Code，它提供了很好的 Docstring：

def foo(a: int, b: str) -> bool:
    """[summary]

    Args:
        a (int): [description]
        b (str): [description]

    Returns:
        bool: [description]
    """