functools如何部分地做它的作用?

时间:2013-03-11 05:23:43

标签: python functional-programming partial-application functools

我无法了解functools中的部分工作原理。 我有here的以下代码:

>>> sum = lambda x, y : x + y
>>> sum(1, 2)
3
>>> incr = lambda y : sum(1, y)
>>> incr(2)
3
>>> def sum2(x, y):
    return x + y

>>> incr2 = functools.partial(sum2, 1)
>>> incr2(4)
5

现在在

incr = lambda y : sum(1, y)

我得到的是,无论我传递给incr的论点是什么,它都将作为y传递给lambdasum(1, y)将返回1 + y,即incr2(4)

我理解。但我不理解这个4

x如何在部分函数中作为4传递?对我来说,sum2应该取代x4和{{1}}之间的关系是什么?

7 个答案:

答案 0 :(得分:166)

粗略地说,partial做了类似的事情(除了关键字args支持等):

def partial(func, *part_args):
    def wrapper(*extra_args):
        args = list(part_args)
        args.extend(extra_args)
        return func(*args)

    return wrapper

因此,通过调用partial(sum2, 4),您可以创建一个新函数(一个可调用的,确切地说),其行为类似sum2,但有一个位置参数更少。缺少的参数始终由4替换,以便partial(sum2, 4)(2) == sum2(4, 2)

至于为何需要它,有各种各样的案例。只是为了一个,假设你必须在一个预期有2个参数的地方传递一个函数:

class EventNotifier(object):
    def __init__(self):
        self._listeners = []

    def add_listener(self, callback):
        ''' callback should accept two positional arguments, event and params '''
        self._listeners.append(callback)
        # ...

    def notify(self, event, *params):
        for f in self._listeners:
            f(event, params)

但是你已经拥有的一个函数需要访问一些第三个context对象来完成它的工作:

def log_event(context, event, params):
    context.log_event("Something happened %s, %s", event, params)

所以,有几种解决方案:

自定义对象:

class Listener(object):
   def __init__(self, context):
       self._context = context

   def __call__(self, event, params):
       self._context.log_event("Something happened %s, %s", event, params)


 notifier.add_listener(Listener(context))

LAMBDA:

log_listener = lambda event, params: log_event(context, event, params)
notifier.add_listener(log_listener)

有部分:

context = get_context()  # whatever
notifier.add_listener(partial(log_event, context))

在这三个中,partial是最短和最快的。 (对于更复杂的情况,您可能需要自定义对象。)

答案 1 :(得分:64)

partials 非常有用。

例如,在一个'pipe-lined'函数调用序列中(其中一个函数的返回值是传递给下一个函数的参数)。

有时这种管道中的函数需要单个参数,但紧接其上游的函数返回两个值

在这种情况下,functools.partial可能允许您保持此功能管道的完整。

这是一个特定的,孤立的示例:假设您希望按每个数据点与某个目标的距离对某些数据进行排序:

# create some data
import random as RND
fnx = lambda: RND.randint(0, 10)
data = [ (fnx(), fnx()) for c in range(10) ]
target = (2, 4)

import math
def euclid_dist(v1, v2):
    x1, y1 = v1
    x2, y2 = v2
    return math.sqrt((x2 - x1)**2 + (y2 - y1)**2)

要按目标距离对数据进行排序,您当然希望这样做:

data.sort(key=euclid_dist)

但是你不能 - sort 方法的 key 参数只接受带有单个参数的函数。

所以重新编写euclid_dist作为一个带有单个参数的函数:

from functools import partial

p_euclid_dist = partial(euclid_dist, target)

p_euclid_dist现在接受一个参数,

>>> p_euclid_dist((3, 3))
  1.4142135623730951

现在您可以通过传入sort方法的key参数的partial函数来对数据进行排序:

data.sort(key=p_euclid_dist)

# verify that it works:
for p in data:
    print(round(p_euclid_dist(p), 3))

    1.0
    2.236
    2.236
    3.606
    4.243
    5.0
    5.831
    6.325
    7.071
    8.602

或者例如,函数的一个参数在外部循环中发生变化,但在内部循环的迭代期间是固定的。通过使用partial,您不必在内部循环的迭代期间传递附加参数,因为修改的(部分)函数不需要它。

>>> from functools import partial

>>> def fnx(a, b, c):
      return a + b + c

>>> fnx(3, 4, 5)
      12

创建部分功能(使用关键字arg)

>>> pfnx = partial(fnx, a=12)

>>> pfnx(b=4, c=5)
     21

您还可以使用位置参数

创建部分函数
>>> pfnx = partial(fnx, 12)

>>> pfnx(4, 5)
      21

但这将抛出(例如,创建部分关键字参数,然后使用位置参数调用)

>>> pfnx = partial(fnx, a=12)

>>> pfnx(4, 5)
      Traceback (most recent call last):
      File "<pyshell#80>", line 1, in <module>
      pfnx(4, 5)
      TypeError: fnx() got multiple values for keyword argument 'a'

另一个用例:使用python的multiprocessing库编写分布式代码。使用Pool方法创建进程池:

>>> import multiprocessing as MP

>>> # create a process pool:
>>> ppool = MP.Pool()

Pool有一个map方法,但它只需要一个可迭代的,所以如果你需要传入一个带有较长参数列表的函数,重新定义该函数为partial,以修复除一个之外的所有函数:

>>> ppool.map(pfnx, [4, 6, 7, 8])

答案 2 :(得分:26)

Partial可用于制作预先指定了某些输入参数的新派生函数

要查看部分内容的实际使用情况,请参阅这篇非常好的博文:
http://chriskiehl.com/article/Cleaner-coding-through-partially-applied-functions/

博客中一个简单而又整洁的初学者示例,介绍了如何在partial上使用re.search来使代码更具可读性。 re.search方法的签名是:

search(pattern, string, flags=0) 

通过应用partial,我们可以创建正则表达式search的多个版本以满足我们的要求,例如:

is_spaced_apart = partial(re.search, '[a-zA-Z]\s\=')
is_grouped_together = partial(re.search, '[a-zA-Z]\=')

现在is_spaced_apartis_grouped_together是从re.search派生的两个新函数,它们应用了pattern参数(因为patternre.search中的第一个参数{1}}方法的签名)。

这两个新函数(可调用)的签名是:

is_spaced_apart(string, flags=0)     # pattern '[a-zA-Z]\s\=' applied
is_grouped_together(string, flags=0) # pattern '[a-zA-Z]\=' applied

这就是你可以在某些文本上使用这些部分函数的方法:

for text in lines:
    if is_grouped_together(text):
        some_action(text)
    elif is_spaced_apart(text):
        some_other_action(text)
    else:
        some_default_action()

您可以参考上面的链接,以更深入地了解该主题,因为它涵盖了这个具体的例子以及更多......

答案 3 :(得分:18)

简短回答,partial为函数的参数提供默认值,否则这些函数将没有默认值。

from functools import partial

def foo(a,b):
    return a+b

bar = partial(foo, a=1) # equivalent to: foo(a=1, b)
bar(b=10)
#11 = 1+10
bar(a=101, b=10)
#111=101+10

答案 4 :(得分:7)

我认为,这是在python中实现currying的一种方式。

from functools import partial
def add(a,b):
    return a + b

def add2number(x,y,z):
    return x + y + z

if __name__ == "__main__":
    add2 = partial(add,2)
    print("result of add2 ",add2(1))
    add3 = partial(partial(add2number,1),2)
    print("result of add3",add3(1))

结果是3和4。

答案 5 :(得分:1)

此答案更多是示例代码。以上所有答案都很好地解释了为什么应该部分使用。我将给出我的观察和有关局部的用例。

from functools import partial
 def adder(a,b,c):
    print('a:{},b:{},c:{}'.format(a,b,c))
    ans = a+b+c
    print(ans)
partial_adder = partial(adder,1,2)
partial_adder(3)  ## now partial_adder is a callable that can take only one argument

以上代码的输出应为:

a:1,b:2,c:3
6

请注意,在上面的示例中,返回了一个新的可调用对象,它将参数(c)作为其参数。请注意,它也是该函数的最后一个参数。

args = [1,2]
partial_adder = partial(adder,*args)
partial_adder(3)

上述代码的输出也是:

a:1,b:2,c:3
6

请注意,*用于解压缩非关键字参数,而返回的callable可以采用的参数与上面相同。

另一个观察结果是: 下面的示例演示了partial返回一个callable,它将采用 未声明的参数(a)作为参数。

def adder(a,b=1,c=2,d=3,e=4):
    print('a:{},b:{},c:{},d:{},e:{}'.format(a,b,c,d,e))
    ans = a+b+c+d+e
    print(ans)
partial_adder = partial(adder,b=10,c=2)
partial_adder(20)

以上代码的输出应为:

a:20,b:10,c:2,d:3,e:4
39

类似地,

kwargs = {'b':10,'c':2}
partial_adder = partial(adder,**kwargs)
partial_adder(20)

上面的代码打印

a:20,b:10,c:2,d:3,e:4
39

我在使用Pool.map_async模块中的multiprocessing方法时必须使用它。您只能将一个参数传递给worker函数,因此我不得不使用partial使我的worker函数看起来像只有一个输入参数的可调用对象,但实际上我的worker函数具有多个输入参数。

答案 6 :(得分:0)

还值得一提的是,当部分函数传递了另一个我们要“硬编码”某些参数的函数时,该参数应该是最右边的参数

def func(a,b):
    return a*b
prt = partial(func, b=7)
    print(prt(4))
#return 28

但是,如果我们执行相同的操作,只是更改一个参数

def func(a,b):
    return a*b
 prt = partial(func, a=7)
    print(prt(4))

它将引发错误,     “ TypeError:func()为参数'a'获得了多个值”