说我有一个函数可以返回多个值
unordered_set
我关心的是文档字符串中的import numpy as np
def add_and_raisepower(x, y):
"""
1) Add inputs **x** and **y** and return the result.
2) Raise **x** to the power of **y**, multiply this
result by an array of one's and return the result.
:type x: float
:param x: The first input number
:type y: float
:param y: The second input number
:rtype val1: float
:rtype val2: numpy.array(float)
"""
val1 = x + y
val2 = np.ones(100)*(x**y)
return val1, val2
注释;如果函数返回多个值(如本例所示),:rtype:
应该如何写在文档字符串中(根据PEP-8)?
通常对于仅返回一个值的函数,:rtype:
的写法类似于
:rtype:
其中没有指定返回的变量名称,因为没有关系,因为只有一个返回值。
我了解理想情况下,我应该尝试将我的功能分解为更简单的功能,对于上面的"""
...
:rtype: int
"""
当然是可能的,但是我仅以此为例来说明问题。
答案 0 :(得分:2)
在这种情况下,每次结果都是一个元组。像这样写下来:
:rtype: (float, numpy.array(float))