Python 简明教程 — 22,Python 闭包与装饰器

微信民众号:码农充电站pro
个人主页:https://codeshellme.github.io

当你选择了一种语言,意味着你还选择了一组手艺、一个社区。

目录

Python 简明教程 --- 22,Python 闭包与装饰器

本节我们来先容闭包装饰器

闭包与装饰器是函数的高级用法,实在在先容完Python 函数我们就可以先容本节的内容,但由于Python中的也可以用来实现装饰器,以是我们等到先容完了Python 类再来统一先容闭包与装饰器。

装饰器使用的是闭包的特征,我们先来先容闭包,再来先容装饰器。

1,什么是闭包

Python 的函数内部还允许嵌套函数,也就是一个函数中还界说了另一个函数。如下:

def fun_1():

    def fun_2():
        return 'hello'

    s = fun_2()

    return s

s = fun_1()
print(s)    # 'hello'

在上面的代码中,我们在函数fun_1 的内部又界说了一个函数fun_2,这就是函数嵌套

我们在学习函数的时刻,还知道,Python 函数可以作为函数参数函数返回值

因此,我们可以将上面代码中的函数fun_2作为函数fun_1的返回值,如下:

def fun_1():
    def fun_2():
        return 'hello'

    return fun_2

此时,函数fun_1 返回了一个函数,我们这样使用fun_1

fun = fun_1()    # fun 是一个函数
s = fun()        # 挪用函数 fun
print(s)         # s 就是 'hello'

我们再来改善函数fun_1,如下:

def fun_1(s):
    s1 = 'hello ' + s

    def fun_2():
        return s1 

    return fun_2

上面的代码中,内部函数fun_2返回了变量s1,而s1是函数fun_2外部变量,这种内部函数能够使用外部变量,而且内部函数作为外部函数返回值,就是闭包

编写闭包时都有一定的套路,也就是,闭包需要有一个外部函数包罗一个内部函数,而且外部函数的返回值是内部函数

2,用闭包实现一个计数器

我们来实现一个计数器的功效,先写一个框架,如下:

def counter():

    # 界说内部函数
    def add_one():
        pass
    
    # 返回内部函数
    return add_one

再来实现计数的功效,如下:

def counter():
    # 用于计数
    l = [0]
    
    # 界说内部函数
    def add_one():
        l[0] += 1
        return l[0] # 返回数字
    
    # 返回内部函数
    return add_one

上面的代码中,我们使用了一个列表l[0]来纪录累加数,在内部函数add_one中对l[0]举行累加。

我们这样使用这个计数器:

c = counter()

print(c())   # 1
print(c())   # 2
print(c())   # 3

我们还可以使这个计数器能够设置累加的初始值,就是为counter 函数设置一个参数,如下:

def counter(start):
    l = [start]

    def add_one():
        l[0] += 1
        return l[0] 
        
    return add_one

这样我们就可以使用counter 来天生差别的累加器(从差别的初始值最先累加)。我们这样使用该计数器:

c1 = counter(1)   # c1 从 1 最先累加
print(c1())       # 2
print(c1())       # 3
print(c1())       # 4

c5 = counter(5)   # c5 从 5 最先累加
print(c5())       # 6
print(c5())       # 7
print(c5())       # 8

c11 最先累加,c55 最先累加,两个互不滋扰。

3,什么是装饰器

装饰器闭包的一种进阶应用。装饰器从字面上明白就是用来装饰包装的。装饰器一样平常用来在不修改函数内部代码的情况下,为一个函数添加分外的新功效。

装饰器虽然功效强大,但也不是万能的,它也有自己适用场景:

  • 缓存
  • 身份认证
  • 纪录函数运行时间
  • 输入的合理性判断

好比,我们有一个函数,如下:

def hello():
    print('hello world.')

若是我们想盘算这个函数的运行时间,最直接的想法就是修改该函数,如下:

import time

def hello():
    s = time.time()

    print('hello world.')

    e = time.time()
    print('fun:%s time used:%s' % (hello.__name__. e - s))

# 挪用函数
hello()

其中,time 模块是Python 中的内置模块,用于时间相关盘算。

每个函数都有一个__name__ 属性,其值为函数的名字。不管我们是直接查看一个函数的__name__ 属性,照样将一个函数赋值给一个变量后,再查看这个变量的__name__ 属性,它们的值都是一样的(都是原来函数的名字):

print(hello.__name__)  # hello
f = hello              # 挪用 f() 和 hello() 的效果是一样的
print(f.__name__)      # hello

然则,若是我们要为许多的函数添加这样的功效,要是都使用这种设施,那会相当的贫苦,这时刻使用装饰器就异常的合适。

最简朴的装饰器

装饰器应用的就是闭包的特征,以是编写装饰器的套路与闭包是一样的,就是有一个外部函数和一个内部函数,外部函数的返回值是内部函数。

我们先编写一个框架:

def timer(func):
    def wrapper():
        pass
      
    return wrapper

再来实现计时功效:

import time

def timer(func):
    def wrapper():
        s = time.time()
        ret = func()
        e = time.time()
        print('fun:%s time used:%s' % (func.__name__, e - s))
        
        return ret

    return wrapper

def hello():
    print('hello world.')

该装饰器的名字是timer,其接受一个函数类型的参数funcfunc 就是要修饰的函数。

func 的函数原型要与内部函数wrapper 的原型一致(这是牢固的写法),即函数参数相同,函数返回值也相同。

英文 wrapper 就是装饰的意思。

实在timer 就是一个高阶函数,其参数是一个函数类型,返回值也是一个函数。我们可以这样使用timer 装饰器:

Flutter 中渐变的高级用法

hello = timer(hello)
hello()

以上代码中,hello 函数作为参数传递给了timer 装饰器,返回效果用hello 变量吸收,最后挪用hello()。这就是装饰器的原本用法。

只不过,Python 提供了一种语法糖,使得装饰器的使用方式加倍简朴优雅。如下:

@timer
def hello():
    print('hello world.')

hello()

直接在原函数hello 的上方写一个语法糖@timer,实在这个作用就相当于hello = timer(hello)

用类实现装饰器

在上面的代码中,是用函数(也就是timer 函数)来实现的装饰器,我们也可以用来实现装饰器。

实现装饰器,主要依赖的是__init__ 方式和__call__ 方式。

我们知道,实现__call__ 方式的类,其工具可以像函数一样被挪用。

用类来实现timer 装饰器,如下:

import time

class timer:
    def __init__(self, func):
        self.func = func

    def __call__(self):
        s = time.time()
        ret = self.func()
        e = time.time()
        print('fun:%s time used:%s' % (self.func.__name__, e - s))

        return ret

@timer
def hello():
    print('hello world.')

print(hello())

其中,组织方式__init__吸收一个函数类型的参数func,然后,__call__方式就相当于wrapper 函数。

用类实现的装饰器的使用方式,与用函数实现的装饰器的使用方式是一样的。

4,被修饰的函数带有参数

若是hello 函数带有参数,如下:

def hello(s):
    print('hello %s.' % s)

那么装饰器应该像下面这样:

import time

def timer(func):
    def wrapper(args):
        s = time.time()

        ret = func(args)

        e = time.time()
        print('fun:%s time used:%s' % (func.__name__, e - s))
        
        return ret

    return wrapper

@timer
def hello(s):
    print('hello %s.' % s)

hello('python')

timer 函数的参数依然是要被修饰的函数,wrapper 函数的原型与hello 函数保持一致。

用类来实现,如下:

import time

class timer:
    def __init__(self, func):
        self.func = func

    def __call__(self, args):
        s = time.time()
        ret = self.func(args)
        e = time.time()
        print('fun:%s time used:%s' % (self.func.__name__, e - s))

        return ret

@timer
def hello(s):
    print('hello %s.' % s)

print(hello('python'))

不定长参数装饰器

若是hello 函数的参数是不定长的,timer 应该是如下这样:

import time

def timer(func):
    def wrapper(*args, **kw):
        s = time.time()

        ret = func(*args, **kw)

        e = time.time()
        print('fun:%s time used:%s' % (func.__name__, e - s))
        
        return ret

    return wrapper

@timer
def hello(s1, s2): # 带有两个参数
    print('hello %s %s.' % (s1, s2))

@timer
def hello_java():  # 没有参数
    print('hello java.')

hello('python2', 'python3')
hello_java()

这样的装饰器timer,可以修饰带有随便参数的函数。

用类来实现,如下:

import time

class timer:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kw):
        s = time.time()
        ret = self.func(*args, **kw)
        e = time.time()
        print('fun:%s time used:%s' % (self.func.__name__, e - s))

        return ret

@timer
def hello(s1, s2): # 带有两个参数
    print('hello %s %s.' % (s1, s2))

@timer
def hello_java():  # 没有参数
    print('hello java.')

hello('python2', 'python3')
hello_java()

5,装饰器带有参数

若是装饰器也需要带有参数,那么则需要在原来的timer 函数的外层再嵌套一层函数TimerTimer 也带有参数,如下:

import time

def Timer(flag):
    def timer(func):
        def wrapper(*args, **kw):
            s = time.time()
            ret = func(*args, **kw)
            e = time.time()
            print('flag:%s fun:%s time used:%s' % (flag, func.__name__, e - s))
            
            return ret

        return wrapper

    return timer

@Timer(1)
def hello(s1, s2): # 带有两个参数
    print('hello %s %s.' % (s1, s2))

@Timer(2)
def hello_java():  # 没有参数
    print('hello java.')

hello('python2', 'python3')
hello_java()

从上面的代码中可以看到,timer 的结构没有改变,只是在wrapper 的内部使用了flag 变量,然后timer 的外层多了一层TimerTimer 的返回值是timer,我们最终使用的装饰器是Timer

我们通过函数.__name__ 来查看函数的__name__ 值:

print(hello.__name__)       # wrapper
print(hello_java.__name__)  # wrapper

可以发现hellohello_java__name__ 值都是wrapper(即内部函数wrapper 的名字),而不是hellohello_java,这并不相符我们的需要,由于我们的初衷只是想增添hellohello_java的功效,但并不想改变它们的函数名字。

6,使用 @functools.wraps

我们可以使用functools模块的wraps装饰器来修饰wrapper 函数,以解决这个问题,如下:

import time
import functools

def Timer(flag):
    def timer(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            s = time.time()
            ret = func(*args, **kw)
            e = time.time()
            print('flag:%s fun:%s time used:%s' % (flag, func.__name__, e - s))
            
            return ret

        return wrapper

    return timer

@Timer(1)
def hello(s1, s2): # 带有两个参数
    print('hello %s %s.' % (s1, s2))

@Timer(2)
def hello_java():  # 没有参数
    print('hello java.')

此时,再查看hellohello_java__name__值,分别是hellohello_java

7,装饰器可以叠加使用

装饰器也可以叠加使用,如下:

@decorator1
@decorator2
@decorator3
def func():
    ...

上面代码的所用相当于:

decorator1(decorator2(decorator3(func)))

8,一个较通用的装饰器模板

编写装饰器有一定的套路,凭据上文的先容,我们可以归纳出一个较通用的装饰器模板:

def func_name(func_args):

    def decorator(func):
    
        @functools.wraps(func)
        def wrapper(*args, **kw):
            # 在这里可以使用func_args,*args,**kw
            # 逻辑处置
            ...
            ret = func(*args, **kw)
            # 逻辑处置
            ...
            
            return ret

        return wrapper

    return decorator


# 使用装饰器 func_name
@func_name(func_args)
def func_a(*args, **kw):
    pass

在上面的模板中:

  • func_name 是装饰器的名字,该装饰器可以吸收参数 func_args
  • 内部函数 decorator 的参数 func,是一个函数类型的参数,就是未来要修饰的函数
  • func 的参数列表可以是随便的,由于我们使用的是*args, **kw
  • 内部函数wrapper 的原型(即参数与返回值)要与 被修饰的函数func 保持统一
  • @functools.wraps 的作用是保留被装饰的原函数的一些元信息(好比__name__ 属性)

与装饰器相关的模块有functoolswrapt,可以使用这两个模块来优化完善你写的装饰器,感兴趣的小伙伴可以自己拓展学习。

(完。)

推荐阅读:

Python 简明教程 — 17,Python 模块与包

Python 简明教程 — 18,Python 面向工具

Python 简明教程 — 19,Python 类与工具

Python 简明教程 — 20,Python 类中的属性与方式

Python 简明教程 — 21,Python 继续与多态

迎接关注作者民众号,获取更多手艺干货。

Python 简明教程 --- 22,Python 闭包与装饰器

原创文章,作者:28x0新闻网,如若转载,请注明出处:https://www.28x0.com/archives/20799.html