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

Ash*_*ons 5 docstring type-hinting pycharm python-3.x python-typing

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

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

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

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

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

我只是看到自己回来研究这个东西,希望能得到一些东西,但找不到我需要的东西。什么工具可以用于此目的?

小智 4

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

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

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

    Returns:
        bool: [description]
    """
Run Code Online (Sandbox Code Playgroud)