返回函数
函数作为返回值
高阶函数除了可以接受函数作为参数外,还可以把函数作为结果值返回。
我们来实现一个可变参数的求和。通常情况下,求和的函数是这样定义的:
def calc_sum(*args):
ax = 0
for n in args:
ax += n
return ax
但是,如果不需要立刻求和,可以不返回求和的结果,而是返回求和的函数:
def lazy_sum(*args):
def sum():
ax = 0
for n in args:
ax += n
return ax
return sum # 返回求和的函数
当我们调用lazy_sum()
时,返回的并不是求和结果,而是求和函数。
而调用函数f()
时,才真正计算求和的结果:
f = lazy_sum(1, 3, 5, 7, 9)
print(f) # <function lazy_sum.<locals>.sum at 0x000001F82E9CA950>
print(f()) # 25
我们在函数lazy_sum
中又定义了函数sum
,并且,内部函数sum
可以引用外部函数lazy_sum
的参数和局部变量,当lazy_sum
返回函数sum
时,相关参数和变量都保存在返回的函数中,这种称为**“闭包(Closure)”**的程序结构拥有极大的威力。
请再注意一点,当我们调用lazy_sum()时,每次调用都会返回一个新的函数,即使传入相同的参数:
f1 = lazy_sum(1, 3, 5, 7, 9)
f2 = lazy_sum(1, 3, 5, 7, 9)
print(f1 == f2) # False
f1()
和f2()
的调用结果互不影响。
闭包
注意到返回的函数在其定义内部引用了局部变量args
,所以,当一个函数返回了一个函数后,其内部的局部变量还被新函数引用,所以,闭包用起来简单,实现起来可不容易。
另一个需要注意的问题是,返回的函数并没有立刻执行,而是直到调用了f()
才执行。我们来看一个例子:
def count():
fs = []
for i in range(1, 4):
def f():
return i * i
fs.append(f)
return fs
f1, f2, f3 = count()
print(f1) # <function count.<locals>.f at 0x000001E525AADC80>
print(f1()) # 9
print(f2()) # 9
print(f3()) # 9
可以看出,调用f1()
,f2()
和f3()
的结果全部都是9
!原因在于返回的函数引用了变量i
,但它并非立刻执行。等到3个函数都返回时,它们所引用的变量i
已经变成了3
,因此最终结果为9
。
!! 返回闭包时牢记一点:返回函数不要引用任何循环变量,或者后续会发生变化的变量。
如果一定要引用循环变量怎么办?方法是再创建一个函数,用该函数的参数绑定循环变量当前的值,无论该循环变量后续如何更改,已绑定到函数参数的值不变:
def count():
def f(j):
def g(): # f(j)里面再创建一个函数,用该函数的参数绑定循环变量当前的值
return j * j
return g
fs = []
for i in range(1, 4):
fs.append(f(i)) # f(i)立刻被执行,因此i的当前值被传入f()
return fs
f1, f2, f3 = count()
print(f1()) # 1
print(f2()) # 4
print(f3()) # 9
缺点是代码较长,可利用lambda函数缩短代码。
nonlocal
使用闭包,就是内层函数引用了外层函数的局部变量。如果只是读外层变量的值,我们会发现返回的闭包函数调用一切正常:
def inc():
x = 0
def fn():
# 仅读取x的值:
return x + 1
return fn
f = inc()
print(f()) # 1
print(f()) # 1
但是,如果对外层变量赋值,由于Python解释器会把x
当作函数fn()
的局部变量,它会报错。原因是x
作为局部变量并没有初始化,直接计算x+1
是不行的。
但我们其实是想引用inc()
函数内部的x
,所以需要在fn()
函数内部加一个nonlocal x
的声明。加上这个声明后,解释器把fn()
的x
看作外层函数的局部变量,它已经被初始化了,可以正确计算x+1
。
def inc():
x = 0
def fn():
nonlocal x # 如果注释掉这一句,就会报错
x = x + 1
return x
return fn
f = inc()
print(f()) # 1
print(f()) # 2
!! 使用闭包时,对外层变量赋值前,需要先使用nonlocal声明该变量不是当前函数的局部变量。
练习
利用闭包返回一个计数器函数,每次调用它返回递增整数:
def createCounter():
s = [0]
def counter():
s[0] = s[0] + 1
return s[0]
return counter
counterA = createCounter()
print(counterA(), counterA(), counterA(), counterA(), counterA()) # 1 2 3 4 5
counterB = createCounter()
print(counterB(), counterB(), counterB(), counterB()) # 1 2 3 4
把一个需序列赋值给s,这样做的目的是方便子函数能够直接使用父函数内的变量值,而不会产生“local variable ‘xxx’ referenced before assignment”这样的错误。
在练习的过程中,看到另一种错误的写法,但很有意思:
s = 0 # 设置全局变量初始值
def createCounter():
def counter():
global s # 引入全局变量
s = s + 1
return s
return counter
counterA = createCounter()
print(counterA(), counterA(), counterA(), counterA(), counterA()) # 1 2 3 4 5
counterB = createCounter()
print(counterB(), counterB(), counterB(), counterB()) # 6 7 8 9
这里使用counterB对createCounter()
再次调用后,结果是6,7,8,9。
匿名函数
>>> list(map(lambda x: x * x, [1, 2, 3, 4, 5, 6, 7, 8, 9]))
[1, 4, 9, 16, 25, 36, 49, 64, 81]
匿名函数lambda x: x * x
实际上就是:
def f(x):
return x * x
关键字lambda
表示匿名函数,冒号前面的x
表示函数参数。
匿名函数有个限制,就是只能有一个表达式,不用写return
,返回值就是该表达式的结果。
用匿名函数有个好处,因为函数没有名字,不必担心函数名冲突。此外,匿名函数也是一个函数对象,也可以把匿名函数赋值给一个变量,再利用变量来调用该函数:
>>> f = lambda x: x * x
>>> f
<function <lambda> at 0x0000015C26ABC5E0>
>>> f(5)
25
同样,也可以把匿名函数作为返回值返回,比如:
def build(x, y):
return lambda: x * x + y * y
练习
请用匿名函数改造下面的代码:
def is_odd(n):
return n % 2 == 1
L = list(filter(is_odd, range(1, 20)))
改造后的代码如下:
L = list(filter(lambda x: x % 2 == 1, range(1, 20)))
print(L) # [1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
装饰器
由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。
函数对象有一个__name__
属性,可以拿到函数的名字:
>>> def now():
print('2015-3-25')
>>> f = now
>>> f()
2015-3-25
>>> now.__name__
'now'
>>> f.__name__
'now'
假设我们要增强now()
函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()
函数的定义,这种在代码运行期间动态增加功能的方式,称之为装饰器(Decorator)。
本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:
def log(func):
def wrapper(*args, **kwargs):
print('call %s(): ' % func.__name__)
return func(*args, **kwargs)
return wrapper()
观察上面的log
,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:
@log
def now():
print('2015-3-25')
调用now()
函数,不仅会运行now()
函数本身,还会在运行now()
函数前打印一行日志:
注:使用pycharm调用now()
函数,会报错。不调用now()
函数,直接运行程序,已经可以在运行now()
函数前打印一行日志了。结果如下:
call now():
2015-3-25
把@log
放到now()
函数的定义处,相当于执行了语句:
now = log(now)
由于log()
是一个decorator,返回一个函数,所以,原来的now()
函数仍然存在,只是现在同名的now
变量指向了新的函数,于是调用now()
将执行新函数,即在log()
函数中返回的wrapper()
函数。
wrapper()
函数的参数定义是(*args, **kw)
,因此,wrapper()
函数可以接受任意参数的调用。在wrapper()
函数内,首先打印日志,再紧接着调用原始函数。
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:
def log(text):
def decorator(func):
def wrapper(*args, **kwargs):
print('%s %s():' % (text, func.__name__))
return func(*args, **kwargs)
return wrapper
return decorator
@log('execute')
def now():
print('2022-10-06')
now() # 很奇怪,这里就需要调用now(),否则打印不出来
# 结果如下:
# execute now():
# 2022-10-06
和两层嵌套的decorator相比,3层嵌套的效果是这样的:
now = log('execute')(now)
我们来剖析上面的语句,首先执行log('execute')
,返回的是decorator
函数,再调用返回的函数,参数是now
函数,返回值最终是wrapper
函数。
以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__
等属性,但你去看经过decorator装饰之后的函数,它们的__name__
已经从原来的'now'
变成了'wrapper'
:
print(now.__name__) # wrapper
因为返回的那个wrapper()
函数名字就是'wrapper'
,所以,需要把原始函数的__name__
等属性复制到wrapper()
函数中,否则,有些依赖函数签名的代码执行就会出错。
不需要编写wrapper.__name__ = func.__name__
这样的代码,Python内置的functools.wraps
就是干这个事的,所以,一个完整的decorator的写法如下:
import functools
def log(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('call %s():' % func.__name__)
return func(*args, **kwargs)
return wrapper()
或者针对带参数的decorator:
import functools
def log(text):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('%s %s():' % (text, func.__name__))
return func(*args, **kwargs)
return wrapper
return decorator
@log('hello')
def now():
print('2015-3-8')
now()
# 结果如下:
# hello now():
# 2015-3-8
import functools
是导入functools
模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()
的前面加上@functools.wraps(func)
即可。
小结
在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。
decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。
练习
1.请设计一个decorator,它可作用于任何函数上,并打印该函数的执行时间:
import time, functools
def metric(fn):
start_time = time.time()
@functools.wraps(fn)
def wrapper(*args, **kwargs):
end_time = time.time()
print('%s executed in %s ms' % (fn.__name__, end_time - start_time))
return fn(*args, **kwargs)
return wrapper
@metric
def fast(x, y):
time.sleep(0.0012)
return x + y
@metric
def slow(x, y, z):
time.sleep(0.1234)
return x * y * z
f = fast(11, 22) # fast executed in 0.0 ms
print(f) # 33
s = slow(11, 22, 33) # slow executed in 0.007169008255004883 ms
print(s) # 7986
2.请编写一个decorator,能在函数调用的前后打印出'begin call'
和'end call'
的日志。
import functools
def log(text=''):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('begin call %s %s' % (text, func.__name__))
func(*args, **kwargs)
print('end call %s %s' % (text, func.__name__))
return wrapper
return decorator
@log()
def f1():
print('2022-03-19')
@log('execute')
def f2(name, age):
print('%s 今年已经 %d 岁了' % (name, age))
f1()
f2("Lucy", 8)
结果如下:
begin call f1
2022-03-19
end call f1
begin call execute f2
Lucy 今年已经 8 岁了!
end call execute f2
偏函数
Python的functools
模块提供了很多有用的功能,其中一个就是偏函数(Partial function)。要注意,这里的偏函数和数学意义上的偏函数不一样。
在介绍函数参数的时候,我们讲到,通过设定参数的默认值,可以降低函数调用的难度。而偏函数也可以做到这一点。举例如下:
int()
函数可以把字符串转换为整数,当仅传入字符串时,int()
函数默认按十进制转换。
但int()
函数还提供额外的base
参数,默认值为10
。如果传入base
参数,就可以做N进制的转换:
>>> int('12345')
12345
>>> int('12345', base=8)
5349
>>> int('12345', base=16)
74565
假设要转换大量的二进制字符串,每次都传入int(x, base=2)
非常麻烦。我们可以定义一个int2()
的函数,默认把base=2
传进去:
def int2(str, base=2):
return int(str, base)
print(int2('100000')) # 32
print(int2('1010101')) # 85
functools.partial
就是帮助我们创建一个偏函数的,不需要我们自己定义int2()
,可以直接使用下面的代码创建一个新的函数int2
:
import functools
int2 = functools.partial(int, base=2)
print(int2('100000')) # 32
print(int2('1010101')) # 85
所以,简单总结functools.partial
的作用就是,把一个函数的某些参数给固定住(也就是设置默认值),返回一个新的函数,调用这个新函数会更简单。
注意到上面的新的int2
函数,仅仅是把base
参数重新设定默认值为2
,但也可以在函数调用时传入其他值:
print(int2('100000', base=8)) # 32768
最后,创建偏函数时,实际上可以接收函数对象、*args
和**kw
这3个参数,当传入:
int2 = functools.partial(int, base=2)
实际上固定了int()函数的关键字参数base
,也就是:
int2('10010')
相当于:
kw = {
'base': 2 }
int('10010', **kw)
当传入:
max2 = functools.partial(max, 10)
实际上会把10
作为*args
的一部分自动加到左边,也就是:
max2(5, 6, 7)
相当于:
args = (10, 5, 6, 7)
max(*args)
结果为10
。
小结
当函数的参数个数太多,需要简化时,使用functools.partial
可以创建一个新的函数,这个新函数可以固定住原函数的部分参数,从而在调用时更简单。
参考链接:返回函数 - 廖雪峰的官方网站 (liaoxuefeng.com)