从函数返回多个值的最佳方法？ [关闭]

Question

以支持它的语言返回多个值的规范方法通常是tupling。

选项：使用元组

考虑这个简单的例子：

def f(x):
  y0 = x + 1
  y1 = x * 3
  y2 = y0 ** y3
  return (y0, y1, y2)

但是，随着返回值数量的增加，这很快就会出现问题。如果要返回四个或五个值怎么办？当然，您可以继续对它们进行元组处理，但很容易忘记哪个值在哪里。在任何你想收到它们的地方打开它们也相当难看。

选项：使用字典

下一个合乎逻辑的步骤似乎是引入某种“记录符号”。在 Python 中，执行此操作的明显方法是通过 dict。

考虑以下几点：

def g(x):
  y0 = x + 1
  y1 = x * 3
  y2 = y0 ** y3
  return {'y0': y0, 'y1': y1 ,'y2': y2}

（为了清楚起见，y0、y1 和 y2 只是作为抽象标识符。正如所指出的，在实践中您会使用有意义的标识符。）

现在，我们有了一种机制，可以将返回对象的特定成员投影出来。例如，

result['y0']

选项：使用类

但是，还有另一种选择。我们可以改为返回一个专门的结构。我已经在 Python 的上下文中构建了这个框架，但我确信它也适用于其他语言。事实上，如果您使用 C 语言工作，这很可能是您唯一的选择。如下：

class ReturnValue:
  def __init__(self, y0, y1, y2):
     self.y0 = y0
     self.y1 = y1
     self.y2 = y2

def g(x):
  y0 = x + 1
  y1 = x * 3
  y2 = y0 ** y3
  return ReturnValue(y0, y1, y2)

在 Python 中，前两个在管道方面可能非常相似 - 毕竟{ y0, y1, y2 } 最终只是在ReturnValue 的内部__dict__ 中的条目。

Python 还为微小对象提供了一项附加功能，即__slots__ 属性。类可以表示为：

class ReturnValue(object):
  __slots__ = ["y0", "y1", "y2"]
  def __init__(self, y0, y1, y2):
     self.y0 = y0
     self.y1 = y1
     self.y2 = y2

来自Python Reference Manual：

__slots__ 声明采用一系列实例变量，并在每个实例中保留足够的空间来保存每个变量的值。因为没有为每个实例创建__dict__，所以节省了空间。

选项：使用dataclass (Python 3.7+)

使用 Python 3.7 的新数据类，返回一个带有自动添加的特殊方法、打字和其他有用工具的类：

@dataclass
class Returnvalue:
    y0: int
    y1: float
    y3: int

def total_cost(x):
    y0 = x + 1
    y1 = x * 3
    y2 = y0 ** y3
    return ReturnValue(y0, y1, y2)

选项：使用列表

另一个我忽略的建议来自蜥蜴比尔：

def h(x):
  result = [x + 1]
  result.append(x * 3)
  result.append(y0 ** y3)
  return result

这是我最不喜欢的方法。我想我因接触 Haskell 而受到污染，但混合类型列表的想法一直让我感到不舒服。在这个特定示例中，列表是 -not-mixed 类型，但可以想象它可能是。

据我所知，以这种方式使用的列表实际上对元组没有任何好处。 Python 中列表和元组之间唯一真正的区别是列表是mutable，而元组不是。

我个人倾向于继承函数式编程的约定：对任意数量的相同类型的元素使用列表，对固定数量的预定类型的元素使用元组。

问题

在冗长的序言之后，不可避免的问题来了。哪种方法（您认为）最好？

Answer 1

Named tuples 为此在 2.6 中添加。另请参阅 os.stat 以获取类似的内置示例。

>>> import collections
>>> Point = collections.namedtuple('Point', ['x', 'y'])
>>> p = Point(1, y=2)
>>> p.x, p.y
1 2
>>> p[0], p[1]
1 2

在最新版本的 Python 3（我认为是 3.6+）中，新的 typing 库获得了 NamedTuple 类，使命名元组更易于创建且功能更强大。从typing.NamedTuple 继承允许您使用文档字符串、默认值和类型注释。

示例（来自文档）：

class Employee(NamedTuple):  # inherit from typing.NamedTuple
    name: str
    id: int = 3  # default value

employee = Employee('Guido')
assert employee.id == 3

Answer 2

对于小型项目，我发现使用元组最容易。当这变得难以管理时（而不是之前），我开始将事物分组到逻辑结构中，但是我认为您建议使用字典和 ReturnValue 对象是错误的（或过于简单化）。

返回带有键 "y0"、"y1"、"y2" 等的字典与元组相比没有任何优势。返回具有.y0、.y1、.y2 等属性的ReturnValue 实例也不比元组提供任何优势。如果你想去任何地方，你需要开始命名，无论如何你都可以使用元组来做到这一点：

def get_image_data(filename):
    [snip]
    return size, (format, version, compression), (width,height)

size, type, dimensions = get_image_data(x)

恕我直言，除了元组之外，唯一好的技术是返回具有适当方法和属性的真实对象，就像您从 re.match() 或 open(file) 获得的一样。

Answer 3

许多答案表明您需要返回某种集合，例如字典或列表。您可以省略额外的语法，只写出返回值，以逗号分隔。注意：这在技术上返回一个元组。

def f():
    return True, False
x, y = f()
print(x)
print(y)

给予：

True
False

Answer 4

我为字典投票。

我发现如果我创建一个返回超过 2-3 个变量的函数，我会将它们折叠到字典中。否则我往往会忘记返回的顺序和内容。

此外，引入“特殊”结构会使您的代码更难遵循。 （其他人将不得不搜索代码以找出它是什么）

如果您担心类型查找，请使用描述性字典键，例如“x 值列表”。

def g(x):
  y0 = x + 1
  y1 = x * 3
  y2 = y0 ** y3
  return {'y0':y0, 'y1':y1 ,'y2':y2 }

Answer 5

另一种选择是使用生成器：

>>> def f(x):
        y0 = x + 1
        yield y0
        yield x * 3
        yield y0 ** 4


>>> a, b, c = f(5)
>>> a
6
>>> b
15
>>> c
1296

尽管恕我直言，元组通常是最好的，除非返回的值是封装在类中的候选值。

Answer 6

我更喜欢：

def g(x):
  y0 = x + 1
  y1 = x * 3
  y2 = y0 ** y3
  return {'y0':y0, 'y1':y1 ,'y2':y2 }

似乎其他一切都只是做同样事情的额外代码。

Answer 7

当元组感觉“自然”时，我更喜欢使用元组；坐标是一个典型的例子，其中单独的对象可以独立存在，例如在单轴缩放计算中，顺序很重要。注意：如果我可以对项目进行排序或打乱而不会对组的含义产生不利影响，那么我可能不应该使用元组。

仅当分组对象并不总是相同时，我才使用字典作为返回值。考虑可选的电子邮件标题。

对于其余的情况，如果分组对象在组内具有内在含义，或者需要一个具有自己方法的成熟对象，我会使用一个类。

Answer 8

>>> def func():
...    return [1,2,3]
...
>>> a,b,c = func()
>>> a
1
>>> b
2
>>> c
3

Answer 9

通常，“特殊结构”实际上是对象的合理当前状态，具有自己的方法。

class Some3SpaceThing(object):
  def __init__(self,x):
    self.g(x)
  def g(self,x):
    self.y0 = x + 1
    self.y1 = x * 3
    self.y2 = y0 ** y3

r = Some3SpaceThing( x )
r.y0
r.y1
r.y2

我喜欢尽可能找到匿名结构的名称。有意义的名字让事情更清楚。

Answer 10

Python 的元组、字典和对象为程序员提供了在小型数据结构（“事物”）的形式性和便利性之间的平滑折衷。对我来说，如何表示事物的选择主要取决于我将如何使用该结构。在 C++ 中，将struct 用于纯数据项，将class 用于具有方法的对象是一种常见的约定，即使您可以合法地将方法放在struct 上；我的习惯在 Python 中类似，用dict 和tuple 代替struct。

对于坐标集，我将使用 tuple 而不是点 class 或 dict（请注意，您可以使用 tuple 作为字典键，所以 dicts 非常有用稀疏多维数组）。

如果我要迭代一个列表，我更喜欢在迭代中解压tuples：

for score,id,name in scoreAllTheThings():
    if score > goodScoreThreshold:
        print "%6.3f #%6d %s"%(score,id,name)

...因为对象版本阅读起来更加混乱：

for entry in scoreAllTheThings():
    if entry.score > goodScoreThreshold:
        print "%6.3f #%6d %s"%(entry.score,entry.id,entry.name)

...更不用说dict了。

for entry in scoreAllTheThings():
    if entry['score'] > goodScoreThreshold:
        print "%6.3f #%6d %s"%(entry['score'],entry['id'],entry['name'])

如果该事物被广泛使用，并且您发现自己在代码中的多个位置对其进行了类似的重要操作，那么通常值得将其设为具有适当方法的类对象。

最后，如果我要与非 Python 系统组件交换数据，我通常会将它们保存在 dict 中，因为这最适合 JSON 序列化。

Answer 11

+1 关于 S.Lott 对命名容器类的建议。

对于 Python 2.6 及更高版本，named tuple 提供了一种轻松创建这些容器类的有用方法，其结果是“轻量级且不需要比常规元组更多的内存”。

Answer 12

“最佳”是一个部分主观的决定。在可以接受不可变的一般情况下，将元组用于小返回集。当不需要可变性时，元组总是比列表更可取。

对于更复杂的返回值，或者对于形式很有价值的情况（即高价值代码），命名元组更好。对于最复杂的情​​况，对象通常是最好的。然而，真正重要的是情况。如果返回一个对象是有意义的，因为这是您在函数末尾自然拥有的（例如工厂模式），那么返回该对象。

正如智者所说：

过早的优化是万恶之源（或至少大部分 它）在编程中。

Answer 13

在像 Python 这样的语言中，我通常会使用字典，因为它比创建新类所需的开销更少。

但是，如果我发现自己经常返回相同的变量集，那么这可能涉及到一个新的类，我将把它排除在外。

Answer 14

我会使用 dict 从函数中传递和返回值：

使用form中定义的变量形式。

form = {
    'level': 0,
    'points': 0,
    'game': {
        'name': ''
    }
}


def test(form):
    form['game']['name'] = 'My game!'
    form['level'] = 2

    return form

>>> print(test(form))
{u'game': {u'name': u'My game!'}, u'points': 0, u'level': 2}

这对我和处理单元来说是最有效的方式。

你只需要传入一个指针并返回一个指针。

每当您对代码进行更改时，您都不必更改函数的（数千个）参数。