一个函数返回多个值是Pythonic吗?
-
09-06-2019 - |
题
在Python中,你可以让一个函数返回多个值。这是一个人为的例子:
def divide(x, y):
quotient = x/y
remainder = x % y
return quotient, remainder
(q, r) = divide(22, 7)
这看起来非常有用,但看起来它也可能被滥用(“嗯..函数 X 已经计算出了我们需要的中间值。让 X 也返回该值”)。
什么时候应该划清界限并定义不同的方法?
解决方案
绝对(对于您提供的示例)。
元组是 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 库参考:
元组可以通过多种方式构建:
- 使用一对括号来表示空元组:()
- 对单元组使用尾随逗号:一个,或(一个,)
- 用逗号分隔项目:a、b、c 或 (a、b、c)
- 使用内置的 tuple() :tuple() 或 tuple(可迭代)
函数应该服务于单一目的
因此他们应该返回一个对象。在你的情况下,这个对象是一个元组。将元组视为一种特殊的复合数据结构。在有些语言中,几乎每个函数都返回多个值(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
其他提示
首先,请注意 Python 允许以下内容(不需要括号):
q, r = divide(22, 7)
关于你的问题,无论哪种方式都没有硬性规定。对于简单(通常是人为的)示例,给定函数似乎总是有可能具有单一目的,从而产生单一值。然而,当将 Python 用于实际应用程序时,您很快就会遇到许多需要返回多个值的情况,从而产生更清晰的代码。
所以,我想说,做任何有意义的事情,不要试图遵守人为的惯例。Python 支持多个返回值,因此请在适当的时候使用它。
你给出的例子实际上是一个Python内置函数,叫做 divmod
. 。因此,有人在某个时间点认为它足够Pythonic,可以包含在核心功能中。
对我来说,如果它能让代码更简洁,那么它就是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
是的,返回多个值(即元组)绝对是Pythonic。正如其他人指出的那样,Python 标准库以及备受推崇的 Python 项目中有大量示例。两条补充意见:
- 返回多个值有时非常非常有用。例如,有一个方法可以选择处理事件(在执行此操作时返回一些值),并且还返回成功或失败。这可能会出现在责任链模式中。在其他情况下,您希望返回多个紧密链接的数据片段,如给出的示例所示。在此设置中,返回多个值类似于返回具有多个成员变量的匿名类的单个实例。
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
这绝对是Pythonic的。事实上,您可以从一个函数返回多个值,这是您在 C 等语言中拥有的样板,您需要为在某处返回的每种类型组合定义一个结构体。
但是,如果您达到了从单个函数返回一些疯狂的值(例如 10 个值)的地步,您应该认真考虑将它们捆绑在一个类中,因为此时它会变得很笨拙。
返回元组很酷。另请注意,在Python 2.6中添加的新名称Tuple可能会使您更适合您:http://docs.python.org/dev/library/collections.html#collections.namedtuple
加时:RSRE 的 Algol68 有一个奇怪的“/:=”运算符。例如。
INT quotient:=355, remainder;
remainder := (quotient /:= 113);
商为 3,余数为 16。
笔记:通常,“(x/:=y)”的值会被丢弃,因为商“x”是通过引用分配的,但在 RSRE 的情况下,返回的值是余数。
对于简单的函数,使用元组返回多个值是可以的,例如 divmod
. 。如果它使代码可读,那么它就是Pythonic。
如果返回值开始变得混乱,请检查该函数是否执行过多操作,如果是则将其拆分。如果像对象一样使用大元组,请将其设为对象。另外,考虑使用 命名元组, ,它将成为 Python 2.6 标准库的一部分。
我对 Python 相当陌生,但元组技术对我来说似乎非常 Pythonic。然而,我有另一个可以增强可读性的想法。使用字典允许通过名称而不是位置访问不同的值。例如:
def divide(x, y):
return {'quotient': x/y, 'remainder':x%y }
answer = divide(22, 7)
print answer['quotient']
print answer['remainder']