python - 如何让 PyC​​harm 从函数定义中获取类型提示并在文档字符串中填充类型值？

Question

我总是在函数定义中使用类型提示，例如:

def foo(a: int, b: str) -> bool:
    pass

当我使用 PyCharm 自动文档字符串生成器在我的代码中生成文档字符串时，我得到了这个:

def foo(a: int, b: str) -> bool:
    """
    :param a: 
    :type a: 
    :param b: 
    :type b: 
    """
    pass

如您所见，我在函数本身中定义的类型值没有被 PyCharm 识别，我应该再次将它们写在 docstring 中。我如何让 PyC​​harm 为我自动生成这样的东西(从第一行读取类型值并将它们插入到文档字符串中):

def foo(a: int, b: str) -> bool:
    """
    :param a:
    :type a: int
    :param b:
    :type b: str
    :rtype: bool
    """
    pass

Answer 1

PyCharm Bugtracker 上有一个功能请求:Generate docstring types based on the existed inline annotations
截至 2020 年底，PyCharm 似乎仍然不支持将方法中的类型信息自动添加到文档字符串中。
功能请求中有一条评论，询问为什么需要这样的功能:

A question to everyone following, why do you need to put type hints both in annotations and docstrings? The latter format is only partially supported by PyCharm (not every possible PEP 484 type hint is understood there, see PY-23400) and not recognized at all by most other type checkers. Type hints in annotations, on the other hand, are already properly displayed in Quick Documentation and in the documentation rendered by Sphinx (perhaps with the help of sphinx-autodoc-typehints).