如何以 Numpydoc 格式记录多个 return 值？

Question

我正在尝试使用 numpy 文档字符串格式记录元组 return 值，但无法使其与 pycharm 类型提示一起使用。

我尝试了多种方法，甚至找到了一种适用于该类型的方法，但不允许我为它的每个元素添加描述。

要记录的函数示例：

def function():
    foo = 42
    bar = {
        example : 1337,
        dictionary : 46,
    }
    return foo, bar

现在，我可以着手记录它的一种方法是：

def function():
    """
    This is the function summary.

    Returns
    -------
    foobar : tuple[int,[dict[string, int]]
        This is a description of the return type
    """
    foo = 42
    bar = {
        'example' : 1337,
        'dictionary' : 46,
    }
    return foo, bar

这会给我一个描述和正确的 return 类型提示，但不是我想要的每个元素的单独描述。

这是我正在努力实现的一个非工作示例：

def function():
    """
    This is the function summary.

    Returns
    -------
    foo : int
        This is an int
    bar : [dict[string, int]
        This is a dictionary
    """
    foo = 42
    bar = {
        'example' : 1337,
        'dictionary' : 46,
    }
    return foo, bar

Answer 1

如果 function return 值被注释为 tuple[int, dict[string, int]]，其文档呈现正确，但推断 function()[1]["key"] 的类型存在问题。欢迎在 public PyCharm 跟踪器 https://youtrack.jetbrains.com/issues/PY.

中提出问题

如何以 Numpydoc 格式记录多个 return 值？

How to document multiple return values in Numpydoc format?

python

tuples

type-hinting

pycharm

numpydoc