python装饰器

发表于 更新于 分类于

基础

python装饰器，类似java反射，用以实现切面。 python是函数式语言，不需要使用反射，可动态的修改函数或者类。当我们需要给一段函数增加打印函数名和参数的功能时我们可以这样做

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
def hello(name):
    return 'hello '+name


def log(func):
    def wrapper(*args, **kwargs):
        print('-----------before-----------')
        print(func(*args, **kwargs))
        print('-----------after-----------')
    return wrapper


hello = log(hello)

hello('li')

执行结果如下

-----------before----------- hello li -----------after-----------

但是当我们print(hello)时我们发现

<function log.<locals>.wrapper at 0x10db2bc80>

我们只需要在log的内部方法wrapper加上注解

1
2
3
4
5
6
7
8
9
10
11
12
import functools




def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print('-----------before-----------')
        print(func(*args, **kwargs))
        print('-----------after-----------')
    return wrapper

这个时候print(hello)

<function hello at 0x10ef94c80>

使用注解实现装饰器

python为我们提供了语法糖，来自动实现自动给方法加上装饰器这个过程，只需要使用注解即可

完整代码如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

import functools


def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print('-----------before-----------')
        print(func(*args, **kwargs))
        print('-----------after-----------')
    return wrapper


@log
def hello(name):
    return 'hello '+name


hello('li')

print(hello)

输出结果如下

-----------before----------- hello li -----------after----------- <function hello at 0x102690c80>

类装饰器

python还提供了类装饰器，会自动实例化类，并在调用方法时调用类的__call__方法。 需要注意的是，在__init__方法，使用参数时，若使用位置参数，则装饰器注解不可带参数，且位置参数有且仅有一个，此参数在运行时即为被装饰的函数。若装饰器注解使用参数，则__init__方法，需使用默认参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import functools


class Log(object):

    def __init__(self, func):
        print('---init---')
        print(inspect.getfullargspec(a_method))

        self.func = func

    def __call__(self, *args, **kwargs):
        print('-----------before-----------')
        print(self.func(*args, **kwargs))
        print('-----------after-----------')


@Log
def hello(name):
    return 'hello '+name


hello('li')
hello('li')

print(hello)

根据输出结果可以看到，类只加载一次，即__init__方法只会执行一次

---init--- -----------before----------- hello li -----------after----------- -----------before----------- hello li -----------after----------- <main.Log object at 0x1048ff668>

装饰器使用参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import functools


def log(* args, **kwargs):
    print(args)
    print(kwargs)

    def decoractor(func):
        def wrapper(*args, **kwargs):
            print(func(*args, **kwargs))
        return wrapper

    return decoractor


@log('hello', 100)
def hello(name):
    return 'hello '+name


@log(filter=200)
def default(name):
    return 'hello '+name


hello('hello')
default('default')

类装饰器使用参数

参数需要指定默认值，

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import functools


class Log(object):

    def __init__(self, name='default'):
        print('---init---')
        self.name = name

    def __call__(self, func):
        def wrapper(*args, **kwargs):
            print(self.name)
            print(func(*args, **kwargs))
        return wrapper


@Log('li')
def hello(name):
    return 'hello '+name


@Log()
def default(name):
    return 'hello '+name


hello('hello')
default('default')

参数与位置息息相关

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import functools

class Log(object):

    def __init__(self, name="default", filter=0):
        self.name = name
        print(filter)

    def __call__(self, func):
        def wrapper(*args, **kwargs):
            print(self.name)
            print(func(*args, **kwargs))
        return wrapper


@Log('hello', 100)
def hello(name):
    return 'hello '+name


@Log(filter=200)
def default(name):
    return 'hello '+name


hello('hello')
default('default')