函数返回多个值是否为pythonic?


81

在python中,您可以让函数返回多个值。这是一个人为的例子:

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

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

这似乎很有用,但是看起来它也可以被滥用(“ ..功能X已经计算出我们需要的中间值。让X也返回该值”)。

您何时应该画线并定义其他方法?

Answers:


107

绝对(对于您提供的示例)。

元组是Python的一等公民

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

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

还有其他的例子:zipenumeratedict.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或(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

1
这样使用元组的功能非常方便。我真的很想念在Java中具有这种能力的时候。
MBCook

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

对于有限的返回值,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)比慢6倍{'x': 10.5, 'y':11.5}。绝对时间635 ns +- 26 ns105 ns +- 4 ns。两者都不大可能成为应用程序的瓶颈-除非您的分析器另有说明,否则请不要进行优化。除非您知道为什么需要,否则不要在功能级别上创建类。如果您的API需要而dict不是使用dict-它与性能无关。
jfs

27

首先,请注意,Python允许以下操作(不需要括号):

q, r = divide(22, 7)

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

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


4
逗号创建元组,因此表达式:q, r 元组。
jfs

Vinko,一个例子是标准库中的tempfile.mkstemp(),它返回一个包含文件句柄和绝对路径的元组。JFS,是的,您是对的。
杰森·埃瑟里奇

但这只是一个目的...您可以有一个目的和多个返回值
Vinko Vrsalovic

如果其他语言可以具有多种返回类型,那么我就不会被引用和'out'参数所困扰。
orip

返回多个值是python中最大的功能之一!
马丁·贝克特

13

您提供的示例实际上是一个名为的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

3

是的,返回多个值(即一个元组)绝对是pythonic。正如其他人指出的那样,Python标准库中以及受人尊敬的Python项目中有很多示例。另外两条评论:

  1. 返回多个值有时非常非常有用。以一种方法为例,该方法可以选择处理一个事件(这样做可以返回某个值),并且还可以返回成功或失败。这可能出现在责任链模式中。在其他情况下,您希望返回多个紧密链接的数据,就像给定的示例一样。在此设置中,返回多个值类似于返回带有多个成员变量的匿名类的单个实例。
  2. 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
    

“一种可选地处理事件并返回成功或失败的方法”-这就是异常的含义。
内森

异常仅用于“异常”条件,而不仅仅是成功或失败,这已被广泛接受。谷歌“错误代码与例外”的一些讨论。
zweiterlinde 2010年

1

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

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



1

OT:RSRE的Algol68具有好奇的“ /:=”运算符。例如。

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

取3的商,除以16的余数。

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

cf整数算术-Algol68


0

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

如果返回值开始变得令人困惑,请检查该函数是否做得太多,然后将其拆分。如果将大元组用作对象,则使其成为对象。另外,请考虑使用命名元组,它是Python 2.6中标准库的一部分。


0

我对Python相当陌生,但是元组技术对我来说似乎非常Python化。但是,我有另一个想法可以增强可读性。使用字典可以通过名称而不是位置来访问不同的值。例如:

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

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

2
不要这样 您不能单线分配结果,这非常笨拙。(除非您要存储结果,否则最好将其放入方法中。)如果您打算使用dict来自我记录返回值,则a)给fn指定一个合理的解释性名称(例如“ divmod“)和b)将其余说明放入文档字符串中(这是将它们放入Python的地方);如果该文档字符串需要超过两行,则表明该函数在主题上已重载,可能不是一个好主意。
smci 2011年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.