从零开始学Python-Day31-装饰器

Python零基础 木人张 7个月前 (04-04) 59次浏览 0个评论 扫描二维码

由于函数本身就是一个对象,而函数对象可以赋值给一个变量,从而可以通过该变量调用函数。

>>> def today():
	print('2020-4-4')

>>> f = today
>>> f()
2020-4-4

函数对象有一个__name__属性,可以直接拿到函数的名字:

>>> today.__name__
'today'
>>> f.__name__
'today'

现在我们要增强today函数的功能,在调用函数前后自动打印日志,但又希望不要修改today函数自身的定义,这种在函数运行期间动态增加功能的方式,我们称之为装饰器(Decorator)。
decorator本质上就是一个高阶函数,针对上面的需求,我们定义一个可以打印日志的装饰器,如下:

>>> def log(func):
	def wrapper(*args, **kw):
		print('call %s():' % func.__name__)
		return func(*args, **kw)
	return wrapper

>>> log
<function log at 0x10aa64f70>
>>> @log
def today():
	print('2020-4-4')

>>> today()
call today():
2020-4-4

log是一个装饰器decorator本身也是一个高阶函数,接收一个函数作为参数,同时返回一个函数。使用@语法,将log这个decorator作用于函数today的定义处。再调用today这个函数时,不单会运行函数返回相应的结果,还会在函数运行前打印一行日志“call today():”
把@log放到today()函数的定义处,相当于执行了语句:

>>> today = log(today)
>>> today()
call wrapper():
call today():
2020-4-4

在这里,log是一个装饰器,返回一个新的函数,原来的today函数依然存在,只是现在同名的today变量指向了新的函数,于是today()将调用新函数,即在log函数作用下返回的wrapper函数。
wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数。
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:

>>> def log(text):
	def decorator(func):
		def wrapper(*args, **kw):
			print('%s %s():' % (text, func.__name__))
			return func(*args, **kw)
		return wrapper
	return decorator

>>> @log('execute')
def today():
	print('2020-4-4')

	
>>> today()
execute today():
2020-4-4

和两层嵌套的decorator相比,3层嵌套的效果是这样的:

>>> today = log('execute')(today)

上面的语句,首先执行log(‘execute’),返回的是decorator函数,再调用返回的函数,参数是today函数,返回值最终是wrapper函数。
以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__等属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的’today’变成了’wrapper’:

>>> today.__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, **kw):
		print('call %s():' % func.__name__)
		return func(*args, **kw)
	return wrapper

>>> @log
def today():
	print('2020-4-4')

	
>>> today()
call today():
2020-4-4
>>> today.__name__
'today'

import functools是导入functools模块。只需记住在定义wrapper()的前面加上@functools.wraps(func)即可
在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。
decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。


木人张,版权所有丨如未注明 , 均为原创,禁止转载。
喜欢 (0)
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址