装饰器放在一个函数开始定义的地方,它就像一顶帽子一样戴在这个函数的头上。和这个函数绑定在一起。在调用这个函数的时候,第一件事并不是执行这个函数,而是将这个函数做为参数传入它头顶上这顶帽子,这顶帽子称之为 装饰器 。
实际上,装饰器并不是编码必须性,意思就是说,你不使用装饰器完全可以,它的出现,应该是使我们的代码:
- 更加优雅,代码结构更加清晰
- 将实现特定的功能代码封装成装饰器,提高代码复用率,增强代码可读性
装饰器的使用方法:
- 先定义一个装饰器(帽子)
- 再定义你的业务函数或者类(人)
- 最后把这装饰器(帽子)扣在这个函数(人)头上
事实上,Python 对某个对象是否能通过装饰器( @decorator)形式使用只有一个要求:decorator 必须是一个“可被调用(callable)的对象。
装饰器入门
1.日志打印器。
实现的功能:
- 在函数执行前,先打印一行日志告知一下主人,我要执行函数了。
- 在函数执行完,也不能拍拍屁股、毫无礼貌就走人了,所以,再打印一行日志告知下主人,我执行完啦。
# 这是装饰器函数,参数 func 是被装饰的函数
def logger(func):
def wrapper(*args, **kw):
#func.__name__是返回func的真实名称
print('主人,我准备开始执行:{} 函数了:'.format(func.__name__))
# 真正执行的是下面这行。
func(*args, **kw)
print('主人,哈哈,我执行完啦。')
return wrapper
@logger #假如,我的业务函数是,计算两个数之和。写好后,直接给它带上帽子。
def add(x, y):
print('{} + {} = {}'.format(x, y, x+y))
add(250, 520)
结果是:
2.代码计时器(时间)
实现功能:顾名思义,就是计算一个函数的执行时长,执行完这个函数花了多少时间。
# 这是装饰函数
def timer(func):
def wrapper(*args, **kw):
t1=time.time()
# 下面是函数真正执行的地方
func(*args, **kw) #主要执行的函数过程存在于这个函数中
t2=time.time()
# 计算下时长
cost_time = t2-t1
print("运行花费时间:{}秒".format(cost_time))
return wrapper
@timer #也就是说在调用want_sleep()的时候会隐约的调用timer()
def want_sleep(sleep_time):
time.sleep(sleep_time)
want_sleep(8) #与预期的一致,沉睡了8s之后,函数结束,打印出来的就是8s。
进阶一下:带参数的函数装饰器
def say_hello(contry): #这是装饰函数
def wrapper(func):
def deco(*args, **kwargs):
if contry == "china":
print("你好!")
elif contry == "am":
print('hello.')
else:
return
# 真正执行函数的地方
func(*args, **kwargs)
return deco
return wrapper
# 小明,中国人
@say_hello("china") #给装饰器传参数
def xiaoming():
pass
# jack,美国
@say_hello("eglis") #因为这里的参数在装饰函数中没有涉及到操作,所以将返回空,如果传入的是am,将返回hello.
def jack():
pass
调用一下函数:
xiaoming()
print("------------")
jack()
返回为:
高阶:类装饰器
1.不带参数的类装饰器
基于类装饰器的实现,必须实现 call 和 __init__两个内置函数。
- init :接收被装饰函数
- call :实现装饰逻辑。
class logger(object):
def __init__(self, func):
self.func = func
def __call__(self, *args, **kwargs):
print("[INFO]: the function {func}() is running...".format(func=self.func.__name__))#打印提示信息
return self.func(*args, **kwargs)
@logger
def say(something):
print("say {}!".format(something))
say("hello")
输出:
可以看到,这里似乎把他写死了,因为他会返回的只有[INFO]级别的,所以说写死了。
所以,应该尝试给装饰器传递参数。
2.带参数的类装饰器
带参数和不带参数的类装饰器有很大的不同。
- init :不再接收被装饰函数,而是接收传入参数。
- call :接收被装饰函数,实现装饰逻辑
class logger(object):
def __init__(self, level='INFO'): #对其进行赋值操作
self.level = level
def __call__(self, func): # 接受函数
def wrapper(*args, **kwargs):
print("[{level}]: the function {func}() is running...".format(level=self.level, func=func.__name__))
func(*args, **kwargs)
return wrapper #返回函数
@logger(level='WARNING') #给参数赋值为警告级别的。
def say(something):
print("say {}!".format(something))
say("hello")
Python本身也自带了内置的装饰器。
内置装饰器:property
其实Python语言本身也有一些装饰器。比如property这个内建装饰器。它通常存在于类中,可以将一个函数定义成一个属性,属性的值就是该函数return的内容。
用@property装饰过的函数,会将一个函数定义成一个属性,属性的值就是该函数return的内容。同时,会将这个函数变成另外一个装饰器。就像后面我们使用的@age.setter和@age.deleter。
- @age.setter 使得我们可以使用XiaoMing.age = 25这样的方式直接赋值。
- @age.deleter 使得我们可以使用del XiaoMing.age这样的方式来删除属性。
class Student(object):
def __init__(self, name):
self.name = name
self.name = None
@property
def age(self):
return self._age
@age.setter
def age(self, value):
if not isinstance(value, int):
raise ValueError('输入不合法:年龄必须为数值!')
if not 0 < value < 100:
raise ValueError('输入不合法:年龄范围必须0-100')
self._age=value
@age.deleter
def age(self):
del self._age
xiaoming = Student("小明")
# 设置属性
xiaoming.age = 25
# 查询属性
xiaoming.age
# 删除属性
# del xiaoming.age
返回: