Python:使用epytext返回多个值时如何记录返回值?

时间:2018-09-17 07:14:47

标签: python docstring epytext

一个简单的功能:

def foo():
    a = 1
    b = 2
    return a, b

您将如何使用epytext样式记录(多个)返回值?

作为一个元组?

def foo():
    """
    This function
    @return (a, b): a tuple of a and b representing...
    """
    a = 1
    b = 2
    return a, b

还是对每个变量使用单独的@return标签? (甚至“合法”吗?)

def foo():
    """
    This function
    @return a: a int representing...
    @return b: a int representing...
    """
    a = 1
    b = 2
    return a, b

1 个答案:

答案 0 :(得分:0)

在Python中,元组文字是由逗号而不是括号创建的(空元组文字()除外,这有点特殊),因此return a, b首先创建一个{ {1}}然后返回它。 IOW,您不是“返回多个值”,而是单个tuple对象,因此答案很明显。