乐趣区

关于python:了解女朋友的心还不如去了解Python之Python装饰器

在 Python 外面,函数能够作为参数传入一个函数,函数也能够复制给变量,通过变量调用函数。装璜器能够扩大一个函数的性能,为函数做一个装璜器注解,能够把装璜器外面定义的性能于所有函数提前执行,晋升代码的复用水平。

那么当初有这样一个场景。

打卡

互联网公司外面有各种各样的职位,比方程序员、前台 …,程序员在关上电脑前,须要打卡,前台要早点来开门(其实我也不分明个别是谁开门,这里先假设为前台开门),前台开门前也须要打卡。也就是说,打卡是所有员工的最先的公共动作,那么能够把打卡这个性能抽出来作为公共逻辑。

一般函数调用办法

天然想到,能够实现如下。

def di(f):
    print('%s 打卡, 滴...' % f.__name__)
    return f()
​
def boot():
    print('开机')
​
def open():
    print('开门')
​
if __name__ == '__main__':
    """程序员开机之前,前台开门之前,都须要先在门外指纹机打卡。"""
    di(boot)
    di(open)
​

定义了一个函数 di(f),能够打印f.__name__f的函数名信息,同时返回 f()的执行后果。

留神:__name__如果作为模块导入,module.__name__就是模块本人的名字,如果模块本人作为脚本执行,返回__main__

执行后果:

boot 打卡, 滴...
开机
open 打卡, 滴...
开门

这样设计,如果有很多函数都要调用,就很麻烦,那么装璜器就排上了用场。

简略装璜器 与 @语法糖

装璜器:在代码运行期间动静减少性能的形式,称之为“装璜器”(Decorator)。

简略装璜器

定义一个 di(f) 办法,还是把要执行的逻辑的函数作为参数传入,外面定义一个 wrapper 函数,返回值是 f 的执行后果。在 if __name__ == '__main__': 外面,调用了这个装璜器,不批改定义好了的函数,在运行期间动静增加性能 ” 打卡 ”。

import functools
​
# 简略装璜器
def di(f):
    """
    程序员开机之前,前台开门之前,都须要先在门外指纹机打卡。:param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到 wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡, 滴...' % f.__name__)
        return f()
    return wrapper
​
def boot():
    print('开机')
​
def open():
    print('开门')
​
if __name__ == '__main__':
​
    # 第一种,简略装璜器
    a = di(boot)
    a1 = di(open)
    print(a.__name__) # 后果 wrapper 加 @functools.wraps(f)后后果为 boot
    a()
    a1()

di(boot)的返回值 a 就是 wrapper 函数,通过 a() 就调用了 wrapper 函数,失去 boot 的返回值。同理,di(open)一样。

后果

boot
boot 打卡, 滴...
开机
open 打卡, 滴...
开门

因为 di(boot) 的返回值 a 就是 wrapper 函数,那么 print(a.__name__) 的后果就天经地义是是 wrapper,咱们心愿是boot,怎么办,functools.wraps(f) 这个注解能够把原始函数 boot__name__等属性复制到 wrapper(),把这行代码正文也能运行,那么print(a.__name__) 的后果就是wrapper

第二种,@ 语法糖

通过 @ 语法糖,也能将装璜器利用于函数下面,举荐。

import functools
​
def di(f):
    """
    程序员开机之前,前台开门之前,都须要先在门外指纹机打卡。:param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到 wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡, 滴...' % f.__name__)
        return f()
    return wrapper
​
# @ 语法糖
@di
def boot2():
    print('开机')
​
@di
def open2():
    print('开门')
​
if __name__ == '__main__':
​
    # 第二种,@ 语法糖
    boot2()
    open2()

@di标记相当于,a2 = di(boot2) a2()。不必这么麻烦,因为加了 @ 符号标记,间接用 boot2() 调用装璜器即可。

后果

boot2 打卡, 滴...
开机
open2 打卡, 滴...
开门

业务逻辑函数须要参数

业务逻辑函数可能须要参数,比方:

def boot(name):
    print('%s 开机' % name)

那么,只须要将后面的装璜器批改为:

import functools
​
# 业务逻辑函数须要参数
def di(f):
    """
    程序员开机之前,前台开门之前,都须要先在门外指纹机打卡。:param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到 wrapper()
    @functools.wraps(f)
    def wrapper(*args, **kwargs):
        print('%s 打卡, 滴...' % f.__name__)
        return f(*args, **kwargs)
    return wrapper
​
@di
def boot(name):
    print('%s 开机' % name)
​
if __name__ == '__main__':
    boot('keguang')

后果:

boot 打卡, 滴...
keguang 开机

wrapper 也加上 *args, **kwargs 参数,在 boot 外面间接调用 f(*args, **kwargs) 即可。顺便提一下:

  • *args:能够传入一个数组参数
  • **kwargs:能够传入一个 k-v 对参数

先后顺序对应,数组参数在前。举例:

def f(*args, **kwargs):
    print('args=', args)
    print('kwargs=', kwargs)
​
print(f(1, 2, 3, a = 'a', b = 'b'))
​
# 后果
# args= (1, 2, 3)
# kwargs= {'a': 'a', 'b': 'b'}

带参数的装璜器

如果装璜器也带参数,比方当初如果某个员工晚上下班来得早 < 9:00,咱能够做个褒扬,那么相当于只须要在后面的di() 里面套一层函数,di_args即可,在 wrapper 外面。应用这个参数

import functools
​
# 带参数的装璜器
def di_args(time):
    def di(f):
        """
        程序员开机之前,前台开门之前,都须要先在门外指纹机打卡。:param f: 传入一个函数
        :return:
        """
        # 把原始函数的__name__等属性复制到 wrapper()
        @functools.wraps(f)
        def wrapper(*args, **kwargs):
            if time < '9:00':
                print('来的真早,很棒。。。')
​
            print('%s 打卡, 滴...' % f.__name__)
            return f(*args, **kwargs)
        return wrapper
    return di
​
@di_args('8:00')
def boot(name):
    print('%s 开机' % name)
​
if __name__ == '__main__':
    boot('keguang')

参数在 @di_args('8:00') 传入即可,有点像 java 外面的注解。最初还是通过 boot('keguang') 调用即可,后果:

来的真早,很棒。。。boot 打卡, 滴...
keguang 开机

类装璜器

类装璜器次要依附类的 __call__ 办法,当应用 @ 模式将装璜器附加到函数上时,就会调用此办法。

# 类装璜器
class di(object):
    def __init__(self, f):
        self._f = f
​
    def __call__(self, *args, **kwargs):
        print('decorator start...')
        self._f()
        print('decorator end...')
​
@di
def boot():
    print('开机')
​
if __name__ == '__main__':
    boot()

加上 @di 装璜器标识,会用 boot 去实例化 di 类,而后执行 __call__ 函数,object示意这个类能够传入任何类型参数。运行后果

decorator start...
开机
decorator end...

装璜器有一个典型的利用场景就是打 log 日志,如果所有逻辑都须要日志记录程序的运行状况,那么能够对这些逻辑 (函数) 加日志模块装璜器,就能达到相应目标。

最初

如果文章对你有用的话,给作者点点赞吧
回绝白嫖,从我做起

退出移动版