python之@装饰器

1、@ 符号是装饰器的语法糖，@符号后面的函数装饰器

• 装饰器放在一个函数开始定义的地方，它就像一顶帽子一样戴在这个函数的头上。和这个函数绑定在一起。在我们调用这个函数的时候，第一件事并不是执行这个函数，而是将这个函数做为参数传入它头顶上这顶帽子，这顶帽子我们称之为 装饰器
• 推荐公众号文章
  

2、例子

（1）Hello装饰器

ddef decorator(func):
    def wrapper(*args, **kw):
        print(args, '----wrapper参数----', kw)
        return func()
    return wrapper
@decorator
def function():
    print("hello, decorator")
if __name__ == '__main__':
    function()

>>>>> () ----wrapper参数---- {}
>>>>> hello, decorator

（2）日志打印器

# 这是装饰器函数，参数 func 是被装饰的函数
def logger(func):
    def wrapper(*args, **kw):
        print('主人，我准备开始执行：{} 函数了'.format(func.__name__))
        # 真正执行的是这行。
        func(*args, **kw)
        print('主人，我执行完啦。')
    return wrapper
@logger
def add(x, y):
    print('{} + {} = {}'.format(x, y, x+y))
if __name__ == '__main__':
    add(200, 50)

>>>>> 主人，我准备开始执行：add 函数了
>>>>> 200 + 50 = 250
>>>>> 主人，我执行完啦。

（3）时间计时器

import time
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
def want_sleep(sleep_time):
    time.sleep(sleep_time)
if __name__ == '__main__':
    want_sleep(3)
>>>>> 花费时间：3.000171422958374秒

（4）带参数的函数装饰器

def say_hello(country):
    def wrapper(func):
        def deco(*args, **kwargs):
            if country == "china":
                print("你好!")
            elif country == "america":
                print('hello.')
            else:
                return
            # 真正执行函数的地方
            func(*args, **kwargs)
        return deco
    return wrapper
# 小明，中国人
@say_hello("china")
def xiaoming():
    pass
# jack，美国人
@say_hello("america")
def jack():
    pass
if __name__ == '__main__':
    xiaoming()
    print("------------")
    jack()
    
>>>>> 你好!
>>>>> ------------
>>>>> hello.

（5）不带参数的类装饰器

• 以上都是基于函数实现的装饰器
• 基于类装饰器的实现，必须实现__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))
if __name__ == '__main__':
    say("hello")

>>>>> [INFO]: the function say() is running...
>>>>> say hello!

（6）带参数的类装饰器

• 带参数和不带参数的类装饰器有很大的不同__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))
if __name__ == '__main__':
    say("hello")

>>>>> [WARNING]: the function say() is running...
>>>>> say hello!

（7）使用偏函数与类实现装饰器

import time
import functools

class DelayFunc:
    def __init__(self,  duration, func):
        self.duration = duration
        self.func = func
    def __call__(self, *args, **kwargs):
        print(f'Wait for {self.duration} seconds...')
        time.sleep(self.duration)
        return self.func(*args, **kwargs)
    def eager_call(self, *args, **kwargs):
        print('Call without delay')
        return self.func(*args, **kwargs)
def delay(duration):
    """
    装饰器：推迟某个函数的执行。
    同时提供 .eager_call 方法立即执行
    """
    # 此处为了避免定义额外函数，
    # 直接使用 functools.partial 帮助构造 DelayFunc 实例
    return functools.partial(DelayFunc, duration)
@delay(duration=2)
def add(a, b):
    return a + b
if __name__ == '__main__':
    print(add)
    add(3, 5)
    print(add.func)

>>>>> <__main__.DelayFunc object at 0x0000000001F71A20>
>>>>> Wait for 2 seconds...
>>>>> <function add at 0x0000000001FC81E0>

（8）如何写能装饰类的装饰器？

instances = {}
def singleton(cls):
    def get_instance(*args, **kw):
        cls_name = cls.__name__
        print('===== 1 ====')
        if cls_name not in instances:
            print('===== 2 ====')
            instance = cls(*args, **kw)
            instances[cls_name] = instance
        return instances[cls_name]
    return get_instance
@singleton
class User:
    _instance = None

    def __init__(self, name):
        print('===== 3 ====')
        self.name = name

if __name__ == '__main__':
    u1 = User("wangbm1")
    print('----分隔符1----')
    u1.age = 20
    u2 = User("wangbm2")
    print('----分隔符2----')
    print(u2.age)
    print('----分隔符3----')
    print(u1 is u2)

>>>>> ===== 1 ====
>>>>> ===== 2 ====
>>>>> ===== 3 ====
>>>>> ----分隔符1----
>>>>> ===== 1 ====
>>>>> ----分隔符2----
>>>>> 20
>>>>> ----分隔符3----
>>>>> True

（9）wraps 装饰器有啥用？

• functools .wraps 装饰器，它的作用就是将 被修饰的函数(wrapped) 的一些属性值赋值给 修饰器函数(wrapper) ，最终让属性的显示更符合我们的直觉。

from functools import wraps
def wrapper(func):
    @wraps(func)
    def inner_function():
        pass
    return inner_function
@wrapper
def wrapped():
    pass

if __name__ == '__main__':
    print(wrapped.__name__)
    
>>>>> wrapped

（10）内置装饰器：property

• 它通常存在于类中，可以将一个函数定义成一个属性，属性的值就是该函数return的内容。用@property装饰过的函数，会将一个函数定义成一个属性，属性的值就是该函数return的内容

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
if __name__ == '__main__':      
	xiaoming = Student("小明")
	# 设置属性
	xiaoming.age = 25
	# 查询属性
	print(xiaoming.age)
	# 删除属性
	del xiaoming.age
 
>>>>> 25