python自动在docstring中添加类型提示

Question

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

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

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

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

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

我只是看到自己回来研究这个东西，希望得到一些东西，但找不到我需要的东西。什么工具可以做到这一点?

Answer 1

当我几个月前搜索时，我找不到任何可用的解决方案。现在，我正在使用VS Code与这个扩展，它提供了很好的文档字符串:

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