python装饰器

Posted 2020-11-20

装饰器

本质上，装饰器就是一个返回函数的高阶函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。
概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

def foo():
    print(‘i am foo‘)

现在有一个新的需求，希望可以记录下函数的执行日志，于是在代码中添加日志代码：

def foo():
    print(‘i am foo‘)
    logging.info("foo is running")

bar()、bar2()也有类似的需求，怎么做？再写一个logging在bar函数里？这样就造成大量雷同的代码，为了减少重复写代码，我们可以这样做，重新定义一个函数：专门处理日志 ，日志处理完之后再执行真正的业务代码

def use_logging(func):
    logging.warn("%s is running" % func.__name__)
    func()

def bar():
    print(‘i am bar‘)

use_logging(bar)

逻辑上不难理解， 但是这样的话，我们每次都要将一个函数作为参数传递给use_logging函数。而且这种方式已经破坏了原有的代码逻辑结构，之前执行业务逻辑时，执行运行bar()，但是现在不得不改成use_logging(bar)。那么有没有更好的方式的呢？当然有，答案就是装饰器。

def use_logging(func):      # 不带参数的装饰器 第一个def 参数就是func，带参数的装饰器，第一个def参数是装饰元素参数，第二个def参数才是func,注意区分（都是套路）
#  装饰器就是某种闭包，总是return一些函数
    def wrapper(*args, **kwargs):
        logging.warn("%s is running" % func.__name__)
        return func(*args, **kwargs)
    return wrapper

def bar():
    print(‘i am bar‘)

bar = use_logging(bar)
bar()

函数use_logging就是装饰器，它把执行真正业务方法的func包裹在函数里面，看起来像bar被use_logging装饰了。在这个例子中，函数进入和退出时 ，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。

@符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作

def use_logging(func):
# 不带参数的装饰器 第一个def 参数就是func，带参数的装饰器，第一个def参数是装饰元素参数，第二个def参数才是func,注意区分（都是套路）
    def wrapper(*args, **kwargs):
        logging.warn("%s is running" % func.__name__)
        return func(*args)
    return wrapper    # return几回，最终回去的还是func

@use_logging
def foo():
    print("i am foo")

@use_logging
def bar():
    print("i am bar")

foo()
bar()          #  相当于省去`bar = use_logging(bar)`

如上所示，这样我们就可以省去bar = use_logging(bar)这一句了，直接调用bar()即可得到想要的结果。如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

带参数的装饰器

装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如@use_logging，该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其它参数，比如@decorator(a)。这样，就为装饰器的编写和使用提供了更大的灵活性。

# -*- coding:utf-8 -*-
import logging

def use_logging(level):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == ‘warn‘:
                logging.warn(‘%s is running‘% func.__name__)
            return func(*args)
        return wrapper
    return decorator

@use_logging(level="warn")
def foo(name="foo"):
    print("i am %s" % name)

@use_logging(level="error")
def bar(name="bar"):
    print("i am %s" % name)

foo()
bar()          #  相当于省去`bar = use_logging(bar)`

上面的use_logging是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装，并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我们使用@use_logging(level="warn")调用的时候，Python能够发现这一层的封装，并把参数传递到装饰器的环境中。

类装饰器

再来看看类装饰器，相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器还可以依靠类内部的call方法，当使用@形式将装饰器附加到函数上时，就会调用此方法。

In [19]: class Foo(object):
    ...:     def __init__(self,func):
    ...:         self._func = func
    ...:     def __call__(self):      # 内置的特殊函数
    ...:         print(‘class decorator running‘)
    ...:         self._func()
    ...:         print(‘class decorator ending‘)
    ...:

In [20]: @Foo
    ...: def bar():
    ...:     print(‘bar‘)
    ...:

In [21]: bar()
class decorator running
bar
class decorator ending
functools.wraps

使用装饰器极大地复用了代码，但是他有一个缺点就是原函数的元信息不见了，比如函数的docstring、name、参数列表，先看例子：
装饰器

def logged(func):
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

函数

@logged
def f(x):
   """does some math"""
   return x + x * x

该函数完成等价于：

def f(x):
    """does some math"""
    return x + x * x
f = logged(f)

不难发现，函数f被with_logging取代了，当然它的docstring，name就是变成了with_logging函数的信息了。

print f.__name__    # prints ‘with_logging‘
print f.__doc__     # prints None

这个问题就比较严重的，好在我们有functools.wraps，wraps本身也是一个装饰器，它能把原函数的元信息拷贝到装饰器函数中，这使得装饰器函数也有和原函数一样的元信息了。

from functools import wraps
def logged(func):
    @wraps(func)      #  引入wraps,其他代码不动，即解决问题
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
    """does some math"""
    return x + x * x

print f.__name__  # prints ‘f‘
print f.__doc__   # prints ‘does some math‘

魔法函数__call__

所有的函数都是可调用对象。一个类实例也可以变成一个可调用对象，只需要实现一个特殊方法call()。

我们把 Person 类变成一个可调用对象：

class Person(object):
    def __init__(self, name, gender):
        self.name = name
        self.gender = gender

    def __call__(self, friend):
        print ‘My name is %s...‘ % self.name
        print ‘My friend is %s...‘ % friend

现在可以对 Person 实例直接调用：

>>> p = Person(‘Bob‘, ‘male‘)
>>> p(‘Tim‘)
My name is Bob...
My friend is Tim...

单看p(‘Tim‘)你无法确定p是一个函数还是一个类实例，所以，在Python中，函数也是对象，对象和函数的区别并不显著。

装饰器的顺序

@a
@b
@c
def f ():

等效于

f = a(b(c(f)))

内置装饰器

@classmethod

类方法的第一个参数是一个类，是将类本身作为操作的方法。类方法被哪个类调用，就传入哪个类作为第一个参数进行操作。

class Car(object):
    car = "audi"

    @classmethod
    def value(self, category): # 可定义多个参数，但第一个参数为类本身
        print "%s car of %s" % (category, self.car)

class BMW(Car):
    car = "BMW"

class Benz(Car):
    car = "Benz"

print "通过实例调用"
baoma = BMW()
baoma.value("Normal") # 由于第一个参数为类本身，调用时传入的参数对应的时category

print "通过类名直接调用"
Benz.value("SUV")

输出结果：

通过实例调用
Normal car of BMW
通过类名直接调用
SUV car of Benz

@staticmathod

将类中的方法装饰为静态方法，即类不需要创建实例的情况下，可以通过类名直接引用，到达将函数功能与实例解绑的效果。

# coding: utf-8
class TestClass:
    name = "test"

    def __init__(self, name):
        self.name = name

    @staticmethod
    def fun(self, x, y):
        return  x + y

cls = TestClass("felix")
print "通过实例引用方法"
print cls.fun(None, 2, 3) # 参数个数必须与定义中的个数保持一致，否则报错

print "类名直接引用静态方法"
print TestClass.fun(None, 2, 3) # 参数个数必须与定义中的个数保持一致，否则报错

输出结果：

通过实例引用方法
5
类名直接引用静态方法
5

@property

作用:把类中一个方法变成属性调用。

class TestClass:
    name = "test"

    def __init__(self, name):
        self.name = name

    @property
    def sayHello(self):
        print "hello", self.name

cls = TestClass("felix")
print "通过实例引用属性"
print cls.name
print "像引用属性一样调用@property修饰的方法"
cls.sayHello

输出结果：

通过实例引用属性
felix
像引用属性一样调用@property修饰的方法
hello felix