函数返回多个值是pythonic吗？

Posted 2023-02-16

【中文标题】函数返回多个值是pythonic吗？

【英文标题】：Is it pythonic for a function to return multiple values?

【发布时间】：2010-09-08 20:43:13

【问题描述】：

在python中，你可以让一个函数返回多个值。这是一个人为的例子：

def divide(x, y):
    quotient = x/y
    remainder = x % y
    return quotient, remainder  

(q, r) = divide(22, 7)

这似乎非常有用，但它似乎也可以被滥用（“嗯..函数 X 已经计算出我们需要的中间值。让我们也让 X 返回那个值”）。

什么时候应该画线并定义不同的方法？

【参考方案1】：

绝对（对于您提供的示例）。

元组是 Python 中的一等公民

有一个内置函数 divmod() 可以做到这一点。

q, r = divmod(x, y) # ((x - x%y)/y, x%y) Invariant: div*y + mod == x

还有其他示例：zip、enumerate、dict.items。

for i, e in enumerate([1, 3, 3]):
    print "index=%d, element=%s" % (i, e)

# reverse keys and values in a dictionary
d = dict((v, k) for k, v in adict.items()) # or 
d = dict(zip(adict.values(), adict.keys()))

顺便说一句，大多数时候括号不是必需的。 来自Python Library Reference的引用：

元组可以通过多种方式构造：

使用一对括号来表示空元组：() 对单个元组使用尾随逗号：a 或 (a,) 用逗号分隔项目：a、b、c 或（a、b、c） 使用内置的 tuple()：tuple() 或 tuple(iterable)

函数应该服务于单一目的

因此，它们应该返回单个对象。在您的情况下，此对象是一个元组。将元组视为一种特殊的复合数据结构。有些语言几乎每个函数都返回多个值（Lisp 中的列表）。

有时返回(x, y) 而不是Point(x, y) 就足够了。

命名元组

随着 Python 2.6 中命名元组的引入，在许多情况下，最好返回命名元组而不是普通元组。

>>> import collections
>>> Point = collections.namedtuple('Point', 'x y')
>>> x, y = Point(0, 1)
>>> p = Point(x, y)
>>> x, y, p
(0, 1, Point(x=0, y=1))
>>> p.x, p.y, p[0], p[1]
(0, 1, 0, 1)
>>> for i in p:
...   print(i)
...
0
1

【讨论】：

像这样使用元组的能力非常方便。有时候我真的很怀念在 Java 中拥有这种能力。

非常感谢您提到命名元组。我一直在寻找这样的东西。

对于有限的返回值，dict() 可能更简单/更快（特别是如果函数随后用于 REST API 和 JSON）。在我的系统上， def test_nt(): Point=namedtuple('Point', ['x', 'y']) p = Point(10.5, 11.5) json.dumps(p._asdict()) 需要 819 μs/循环, def test_dict(): d = 'x': 10.5, 'y': 11.5 json.dumps(d) 需要 15.9μs/循环.... 所以 > 50 倍快

@comte：是的，Point(10.5, 11.5) 比 'x': 10.5, 'y':11.5 慢 6 倍。绝对时间为635 ns +- 26 ns vs. 105 ns +- 4 ns。两者都不太可能成为应用程序的瓶颈——除非您的分析器另有说明，否则不要优化。除非您知道为什么需要它，否则不要在函数级别创建类。如果您的 API 需要 dict 而不是使用 dict - 它与性能无关。

【参考方案2】：

首先，请注意 Python 允许以下内容（不需要括号）：

q, r = divide(22, 7)

关于您的问题，无论哪种方式都没有硬性规定。对于简单（通常是人为的）示例，给定函数似乎总是有可能具有单一目的，从而产生单一值。但是，在将 Python 用于实际应用程序时，您很快就会遇到许多需要返回多个值的情况，这会导致代码更简洁。

所以，我想说做任何有意义的事，不要试图遵守人为的约定。 Python 支持多个返回值，因此请在适当的时候使用它。

【讨论】：

逗号创建元组，因此表达式：q, r是一个元组。

Vinko，一个例子是标准库中的 tempfile.mkstemp()，它返回一个包含文件句柄和绝对路径的元组。 JFS，是的，你是对的。

但这是一个单一的目的......你可以有一个单一的目的和多个返回值

如果其他语言可以有多种返回类型，我就不会被引用和“输出”参数所困扰。

返回多个值是python最大的特性之一！

【参考方案3】：

你给出的例子实际上是一个python内置函数，叫做divmod。因此，在某个时间点，有人认为它足以包含在核心功能中。

对我来说，如果它使代码更清晰，那就是 Pythonic。比较这两个代码块：

seconds = 1234
minutes, seconds = divmod(seconds, 60)
hours, minutes = divmod(minutes, 60)

seconds = 1234
minutes = seconds / 60
seconds = seconds % 60
hours = minutes / 60
minutes = minutes % 60

【参考方案4】：

是的，返回多个值（即一个元组）绝对是 Pythonic。正如其他人所指出的，Python 标准库以及备受推崇的 Python 项目中有很多示例。两个额外的 cmets：

返回多个值有时非常非常有用。举个例子，一个方法可以选择处理一个事件（在这样做时返回一些值）并且还返回成功或失败。这可能出现在责任链模式中。在其他情况下，您希望返回多个紧密链接的数据——如给出的示例所示。在此设置中，返回多个值类似于返回具有多个成员变量的匿名类的单个实例。

Python 对方法参数的处理需要能够直接返回多个值。例如，在 C++ 中，方法参数可以通过引用传递，因此除了正式的返回值之外，您还可以为它们分配输出值。在 Python 中，参数是“通过引用”传递的（但在 Java 的意义上，不是 C++）。您不能为方法参数分配新值并将其反映在方法范围之外。例如：

// C++
void test(int& arg)

    arg = 1;


int foo = 0;
test(foo); // foo is now 1!

比较：

# Python
def test(arg):
    arg = 1

foo = 0
test(foo) # foo is still 0

【讨论】：

“一种可以选择处理事件并返回成功或失败的方法” - 这就是异常的用途。

人们普遍认为，例外仅适用于“例外”条件，而不仅仅是成功或失败。谷歌“错误代码与异常”的一些讨论。

【参考方案5】：

这绝对是pythonic。事实上，您可以从一个函数返回多个值，就像 C 语言中的样板文件一样，您需要为在某处返回的每种类型组合定义一个结构。

但是，如果您达到了从单个函数返回诸如 10 个值之类的疯狂值的地步，您应该认真考虑将它们捆绑在一个类中，因为那样会变得笨拙。

【参考方案6】：

返回一个元组很酷。还要注意新的 namedtuple 这是在 python 2.6 中添加的，这可能会让你更喜欢： http://docs.python.org/dev/library/collections.html#collections.namedtuple

【参考方案7】：

OT：RSRE 的 Algol68 有一个奇怪的“/:=”运算符。例如。

INT quotient:=355, remainder;
remainder := (quotient /:= 113);

商为 3，余数为 16。

注意：“(x/:=y)”的值通常会被丢弃，因为商“x”是通过引用分配的，但在 RSRE 的情况下，返回的值是余数。

参考Integer Arithmetic - Algol68

【参考方案8】：

对于divmod 等简单函数，可以使用元组返回多个值。如果它使代码可读，那就是 Pythonic。

如果返回值开始变得混乱，检查函数是否做的太多，如果是就拆分它。如果像对象一样使用大元组，则将其设为对象。另外，请考虑使用named tuples，它将成为 Python 2.6 中标准库的一部分。

【参考方案9】：

我对 Python 还很陌生，但元组技术对我来说似乎很 Python。但是，我有另一个可以提高可读性的想法。使用字典允许通过名称而不是位置访问不同的值。例如：

def divide(x, y):
    return 'quotient': x/y, 'remainder':x%y 

answer = divide(22, 7)
print answer['quotient']
print answer['remainder']

【讨论】：

不要这样做。您不能将结果分配在单行中，这非常笨拙。 （除非您想存储结果，在这种情况下最好将其放入方法中。）如果您对 dict 的意图是自行记录返回值，那么 a）给 fn 一个合理的解释性名称（例如“ divmod") 和 b) 将其余的解释放入一个文档字符串（这是放置它们的 Pythonic 地方）；如果该文档字符串需要超过两行，则表明该函数在主题上被重载并且可能是个坏主意。