有时候拿到一个程序接口,需要对其进行扩展,但是又不能修改原来接口的源代码,这时候就需要使用装饰器了。
有下面一个小程序,假如是别人提供给我们的调用接口:
import time
def sayHi():
time.sleep(1)
print 'Hello, I am xpleaf.'
一般情况下,如果想要计算该程序的执行时间(因为有可能要对该接口进行某些性能上的测试),就需要把以上接口修改为下面这样,同时执行一下:
程序代码:
import time
def sayHi():
start = time.time()
time.sleep(1)
print 'Hello, I am xpleaf.'
end = time.time()
print 'This project costs:',end - start
sayHi()
执行情况:
xpleaf@xpleaf-machine:/mnt/hgfs/Python/day4/blog$ python wraper.py
Hello, I am xpleaf.
This project costs: 1.00269603729
虽然这样做是达到了扩展该接口的目的,但当出现下面的限制时,也许就不那么适用了:
1.第一个条件仍然是需要对该接口函数进行扩展,如计算执行时间
2.第二个条件则是不能改变原来接口的源代码
因此这样的话,上面的方法就不适用了,但是尽管如此,我们仍然可以使用下面的替代方法,把上面的程序修改一下:
import time
def sayHi():
time.sleep(1)
print 'Hello, I am xpleaf.'
def time_counter():
start = time.time()
sayHi()
end = time.time()
print 'The project costs:', end - start
time_counter()
执行情况如下:
xpleaf@xpleaf-machine:/mnt/hgfs/Python/day4/blog$ python wraper.py
Hello, I am xpleaf.
The project costs: 1.00348091125
尽管上面的方法还是可以暂时缓解一下情况,但当出现下面的需求时:
1.第一个条件仍然是需要对该接口函数进行扩展,如计算执行时间
2.第二个条件则是不能改变原来接口的源代码
3.第三个条件则是不能改变原来接口的调用方式
显然第二个方法不满足第三个条件,因为我们是通过新定义一个函数来进行该操作的,已经改变了原来接口的调用方式,这时候就得使用Python装饰器了,把上面的代码修改为如下:
import time
def time_counter(func):
def wrapper():
start = time.time()
func()
end = time.time()
print 'The project costs:', end - start
return wrapper
@time_counter
def sayHi():
time.sleep(1)
print 'Hello, I am xpleaf.'
sayHi()
执行情况如下:
xpleaf@xpleaf-machine:/mnt/hgfs/Python/day4/blog$ python wraper.py
Hello, I am xpleaf.
The project costs: 1.00221300125
可以看到,满足了上面需要的三个条件,而且如果需要对多个函数接口进行相同的扩展时,只需要在定义调用接口的前面加上@function_name就可以了,上面的代码情况,其实又类似下面的情况:
xpleaf@xpleaf-machine:/mnt/hgfs/Python/day4/blog$ python wraper.py
Hello, I am xpleaf.
The project costs: 1.00514888763
执行情况如下:
xpleaf@xpleaf-machine:/mnt/hgfs/Python/day4/blog$ python wraper.py
Hello, I am xpleaf.
The project costs: 1.00514888763
当然就装饰器来说,肯定是要使用前面的方法了。