python - 如何在 Pycharm 的 Google 风格 Pydoc 中表示返回类型元组？

Question

在 Pycharm 中，我想要一个返回元组的记录函数，以便我可以在其上完成代码。评论的风格是谷歌风格。

---

这工作正确:

def func():
    """

    Returns:
        str: something

    """
    pass

键入 func()。 正确显示 str 的方法。

---

但是，键入此不再有效:

def func():
    """

    Returns:
        (int, str): something

    """
    pass

a, b = func()

键入 b. 不会提供任何信息。

---

我知道 PyCharm 能够解析元组，因为这段代码有效:

def func():
    """

    :rtype: (int, str)
    """
    pass

a, b = func()

但是，这不符合 Google 的风格。

---

我如何根据标准记录函数以便 Pycharm 获取返回类型？

Answer 1

这是我的做法:

from typing import Tuple

def func() -> Tuple[int, str]:
    """ (...)

    Returns:
        A tuple containing, respectively, an int (<meaning of the
        returned int>) and a string (<meaning of the returned string>).
    """

PyCharm(和 Sphinx，如果你用它来解析你的文档字符串)将正确地知道你的函数的返回类型，你将对函数的返回值有一个清晰而漂亮的描述。