Python進階之裝飾器

函數也是對象

要理解Python裝飾器，首先要明白在Python中，函數也是一種對象，因此可以把定義函數時的函數名看作是函數對象的一個引用。既然是引用，因此可以將函數賦值給一個變數，也可以把函數作為一個參數傳遞或返回。同時，函數體中也可以再定義函數。

裝飾器本質

可以通過編寫一個純函數的例子來還原裝飾器所要做的事。

def decorator(func):
    
    def wrap():
        print("Doing someting before executing func()")
        func()
        print("Doing someting after executing func()")

    return wrap


def fun_test():
    print("func")


fun_test = decorator(fun_test)
fun_test()

# Output:
# Doing someting before executing func()
# func
# Doing someting after executing func()

1. fun_test所指向的函數的引用傳遞給decorator()函數
2. decorator()函數中定義了wrap()子函數，這個子函數會調用通過func引用傳遞進來的fun_test()函數，併在調用函數的前後做了一些其他的事情
3. decorator()函數返回內部定義的wrap()函數引用
4. fun_test接收decorator()返回的函數引用，從而指向了一個新的函數對象
5. 通過fun_test()調用新的函數執行wrap()函數的功能，從而完成了對fun_test()函數的前後裝飾

Python中使用裝飾器

在Python中可以通過@符號來方便的使用裝飾器功能。

def decorator(func):
    
    def wrap():
        print("Doing someting before executing func()")
        func()
        print("Doing someting after executing func()")

    return wrap

@decorator
def fun_test():
    print("func")


fun_test()

# Output:
# Doing someting before executing func()
# func
# Doing someting after executing func()

裝飾的功能已經實現了，但是此時執行:

print(fun_test.__name__)

# Output:
# wrap

fun_test.__name__已經變成了wrap，這是應為wrap()函數已經重寫了我們函數的名字和註釋文檔。此時可以通過functools.wraps來解決這個問題。wraps接受一個函數來進行裝飾，並加入了複製函數名稱、註釋文檔、參數列表等等功能。這可以讓我們在裝飾器裡面訪問在裝飾之前的函數的屬性。

更規範的寫法：

from functools import wraps

def decorator(func):
    @wraps(func)
    def wrap():
        print("Doing someting before executing func()")
        func()
        print("Doing someting after executing func()")

    return wrap


@decorator
def fun_test():
    print("func")


fun_test()
print(fun_test.__name__)

# Output:
# Doing someting before executing func()
# func
# Doing someting after executing func()
# fun_test

帶參數的裝飾器

通過返回一個包裹函數的函數，可以模仿wraps裝飾器，構造出一個帶參數的裝飾器。

from functools import wraps

def loginfo(info='info1'):
    def loginfo_decorator(func):
        @wraps(func)
        def wrap_func(*args, **kwargs):
            print(func.__name__ + ' was called')
            print('info: %s' % info)
            
            return func(*args, **kwargs)
        return wrap_func
    return loginfo_decorator
    
@loginfo()
def func1():
    pass
    
func1()

# Output:
# func1 was called
# info: info1

@loginfo(info='info2')
def func2():
    pass

func2()
# Output:
# func2 was called
# info: info2

裝飾器類

通過編寫類的方法也可以實現裝飾器，並讓裝飾器具備繼承等面向對象中更實用的特性

首先編寫一個裝飾器基類：

from functools import wraps

class loginfo:
    def __init__(self, info='info1'):
        self.info = info
        
    def __call__(self, func):
        @wrap
        def wrap_func(*args, **kwargs):
            print(func.__name__ + ' was called')
            print('info: %s' % self.info)
            
            self.after()    # 調用after方法，可以在子類中實現
            return func(*args, **kwargs)
        return wrap_func

    def after(self):
        pass


@loginfo(info='info2')
def func1():
    pass
    
# Output:
# func1 was called
# info: info1

再通過繼承loginfo類，擴展裝飾器的功能：

class loginfo_after(loginfo):
    def __init__(self, info2='info2', *args, **kwargs):
        self.info2 = info2
        super(loginfo_after, self).__init__(*args, **kwargs)

    def after(self):
        print('after: %s' % self.info2)


@loginfo_after()
def func2():
    pass

func2()
    
# Output:
# func2 was called
# info: info1
# after: info2