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

Question

我试图使用numpy docstring格式记录一个元组返回值，但无法使它与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

这将授予我一个描述和正确的返回类型暗示，但不是每个元素的单独描述，我想这样做。

以下是我正在努力实现的目标的一个不可行的例子：

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返回值被注释为tuple[int, dict[string, int]]，则其文档将正确呈现，但function()[1]["key"]的推断类型存在问题。请随意在公共PyCharm跟踪器https://youtrack.jetbrains.com/issues/PY中提交一个问题。