热线电话:13121318867

登录
首页大数据时代不懂Python装饰器,你敢说会Python?
不懂Python装饰器,你敢说会Python?
2021-04-23
收藏

来源:麦叔编程

作者:麦叔

对于Python学习者,一旦过了入门阶段,你几乎一定会用到Python的装饰器。

它经常使用在很多地方,比如Web开发,日志处理,性能搜集,权限控制等。

还有一个极其重要的地方,那就是面试的时候。对,装饰器是面试中最常见的问题之一!

实战入门

抛出问题

看这段代码:

def step1():  print('step1.......') def step2():  print('step2......') def step3():  print('step3......')

step1()
step2()
step3()

代码中定义了3个函数,然后分别调用这3个函数。假设,我们发现代码运行很慢,我们想知道每个函数运行分别花了多少时间。

笨办法解决

我们可以在每个函数中添加计时的代码:

  • 第一行记录开始时间
  • 执行完业务逻辑记录结束时间
  • 结束时间减去开始时间,算出函数执行用时

下面的例子只在step1中添加了相关代码作为示例,你可以自行给step2和step3添加相关代码。

import time def step1():  start = time.time()
 print('step1.......')
 end = time.time()
 used = end - start 
 print(used) def step2():  print('step2......') def step3():  print('step3......')

step1()
step2()
step3()

这个方法可行!但用你的脚指头想想也会觉得,这个方法很繁琐,很笨拙,很危险!

这里只有3个函数,如果有30个函数,那不是要死人啦。万一修改的时候不小心,把原来的函数给改坏了,面子都丢光了,就要被人BS了!

一定有一个更好的解决方法!

用装饰器解决

更好的解决方法是使用装饰器。

装饰器并没有什么高深的语法,它就是一个实现了给现有函数添加装饰功能的函数,仅此而已!

import time def timer(func):  '''统计函数运行时间的装饰器'''  def wrapper():   start = time.time()
  func()
  end = time.time()
  used = end - start
  print(f'{func.__name__} used {used}')
 return wrapper def step1():  print('step1.......') def step2():  print('step2......') def step3():  print('step3......')

timed_step1 = timer(step1)
timed_step2 = timer(step2)
timed_step3 = timer(step3)
timed_step1()
timed_step2()
timed_step3()

上面的timer函数就是个装饰器。

  1. 它的参数是需要被装饰的函数
  2. 返回值是新定义的一个包装了原有函数的函数。
  3. 新定义的函数先记录开始时间,调用被装饰的函数,然后再计算用了多少时间。

简单说就是把原来的函数给包了起来,在不改变原函数代码的情况下,在外面起到了装饰作用,这就是传说中的装饰器。它其实就是个普通的函数。

如果你觉得有点懵逼,需要加强一些对Python函数的理解。函数:

可以作为参数传递

可以作为返回值

也可以定义在函数内部

然后,我们不再直接调用step1, 而是:

  1. 先调用timer函数,生成一个包装了step1的新的函数timed_step1.
  2. 剩下的就是调用这个新的函数time_step1(),它会帮我们记录时间。
timed_step1 = timer(step1)
timed_step1()

简洁点,也可以这样写:

timer(step1)() timer(step2)() timer(step3)()

这样可以在不修改原有函数代码的情况下,给函数添加了装饰性的新功能。

但是仍然需要修改调用函数的地方,看起来还不够简洁。有没有更好的办法呢?当然是有的!

装饰器语法糖衣

我们可以在被装饰的函数前使用@符号指定装饰器。这样就不用修改调用的地方了,这个世界清净了。下面的代码和上一段代码功能一样。在运行程序的时候,Python解释器会根据@标注自动生成装饰器函数,并调用装饰器函数。

import time def timer(func):  '''统计函数运行时间的装饰器'''  def wrapper():   start = time.time()
  func()
  end = time.time()
  used = end - start
  print(f'{func.__name__} used {used}')
 return wrapper @timer def step1():  print('step1.......') @timer def step2():  print('step2......') @timer def step3():  print('step3......')

step1()
step2()
step3()

到了这里,装饰器的核心概念就讲完了。

剩下的基本都是在不同场合下的应用。如果你是大忙人,不想学的太深,可以搜藏本文章,以后再回来看。

进阶用法

上面是一个最简单的例子,被装饰的函数既没有参数,也没有返回值。下面来看有参数和返回值的情况。

带参数的函数

我们把step1修改一下,传入一个参数,表示要走几步。

import time def timer(func):  '''统计函数运行时间的装饰器'''  def wrapper():   start = time.time()
  func()
  end = time.time()
  used = end - start
  print(f'{func.__name__} used {used}')
 return wrapper @timer def step1(num):  print(f'我走了#{num}步')

step1(5)

再去运行,就报错了:

TypeError: wrapper() takes 0 positional arguments but 1 was given

这是因为,表面上我们写的是step1(5),实际上Python是先调用wrapper()函数。这个函数不接受参数,所以报错了。

为了解决这个问题,我们只要给wrapper加上参数就可以。

import time def timer(func):  '''统计函数运行时间的装饰器'''  def wrapper(*args, **kwargs):   start = time.time()
  func(*args, **kwargs)
  end = time.time()
  used = end - start
  print(f'{func.__name__} used {used}')
 return wrapper
  1. wrapper使用了通配符,*args代表所有的位置参数,**kwargs代表所有的关键词参数。这样就可以应对任何参数情况。
  2. wrapper调用被装饰的函数的时候,只要原封不动的把参数再传递进去就可以了。

函数返回值

如果被装饰的函数func有返回值,wrapper也只需把func的返回值返回就可以了。

import time def timer(func):  '''统计函数运行时间的装饰器'''  def wrapper(*args, **kwargs):   start = time.time()
  ret_value = func(*args, **kwargs)
  end = time.time()
  used = end - start
  print(f'{func.__name__} used {used}')
  return ret_value
 return wrapper @timer def add(num1, num2):  return num1 + num2

sum = add(58)
print(sum)

这里我新加了一个add函数,计算两个数之和。

在wrapper函数中,我们先保存了func的返回值到ret_value,然后在wrapper的最后返回这个值就可以了。

到这里,你又进了一步,你可以击败88.64%的Python学习者了。

数据分析咨询请扫描二维码

最新资讯
更多
客服在线
立即咨询