python 裝飾器 一篇就能講清楚

　　裝飾器一直是我們學習python難以理解並且糾結的問題，想要弄明白裝飾器，必須理解一下函數式編程概念，並且對python中函數調用語法中的特性有所了解，使用裝飾器非常簡單，但是寫裝飾器卻很復雜。為了講清楚裝飾器，我們講一個生動的例子如下（由於后文裝飾器的代碼例子，全程和這個形象生動的說明很一致，所以務必看懂這個例子）：

 　　舉個簡單的例子：假設很久之前你寫過一個函數，現在你突然有了個想法就是你想看看，以前那個函數在你數據集上的運行時間是多少，這時候你可以修改之前代碼為它加上計時的功能，但是這樣的話是不是還要大體讀讀你之前的這個的代碼，稍微搞清楚一點它的邏輯，才敢給它添加新的東西。這樣是不是很繁瑣，要是你之前寫的代碼足夠亂足夠長，再去讀它是不是很抓狂...。實際工作中，我們常常會遇到這樣的場景，可能你的需求還不只是這么簡單。那么有沒有一種可以不對源碼做任何修改，並且可以很好的實現你所有需求的手段呢？答案當然是有，這就是要介紹的python裝飾器。有了裝飾器，你除了不用擔心前面提到的問題，並且還可以很好的處理接下來要做的事：那就是現在你又有了一個新的需求，比如為另一個函數添加計時功能，這時就非常簡單了，把要裝飾的函數丟給裝飾器就好了，它會自動給你添加完功能並返回給你。

　　所以說：裝飾器本質上就是一個函數，它可以讓其他函數在不需要做任何代碼變動的前提下增加額外的功能，裝飾器的返回值也是一個函數對象（函數的指針）

 　　那么要想理清楚裝飾器，我們必須先了解下面幾樣東西哦，如果對這些全部了解的話，那么裝飾器就很簡單了。

1，函數

　　函數是什么呢？

　　在python中，使用關鍵字def和一個函數名以及一個可選的參數列表來定義函數，函數使用return關鍵字來返回值，我們一般說的函數是指函數名，比如foo，而foo()已經執行函數了，foo()是什么類型取決於return的內容是什么類型！！！

　　函數的作用是什么？

減少重復代碼

使程序變得可擴展

使程序變得易維護

　　

2，函數作用域

　　在python函數中會創建一個新的作用域，python高手也會稱函數有自己的命名空間，也就是說，當函數體中遇到變量時候，python首先會在該函數的命名空間中尋找變量名，python中有幾個函數用來查看命名空間。

3，函數即對象

　　在python的世界里，函數和[1,2,3],'abc',8等一樣都是對象，而且函數是最高級的對象（對象是類的實例化，可以調用相應的方法，函數是包含變量對象的對象）。

　　函數對象的調用僅僅比其他對象多了一個（）而已，foo，bar和a,b一樣都是個變量名，為什么函數只有加載到內存里面才可以被調用？

　　注意：這里說的函數都是指函數名，比如foo；而foo()已經執行函數了，foo()是什么類型取決於return的內容是什么類型！！！

既然函數是對象，那么自然滿足下面兩個條件：

　　1，可以被賦值於其他變量

def foo():
    print('foo')
bar=foo
bar()
foo()
print(id(foo),id(bar))  #4321123592 4321123592

　　2，可以被定義在另外一個函數內（作為參數&作為返回值），類似於整形，字符串等對象

#*******函數名作為參數**********
def foo(func):
    print('foo')
    func()
 
def bar():
    print('bar')
 
foo(bar)
 
#*******函數名作為返回值*********
 
def foo():
    print('foo')
    return bar
 
def bar():
    print('bar')
 
b=foo()
b()

　　

4，函數的嵌套以及閉包

　　拋一個小問題：bar()是什么？

def foo():
    print('foo')
    def bar():
        print('bar')
    # bar()
bar()

　　

　　是的，bar就是一個變量名，有自己的作用域的。

　　Python允許創建嵌套函數。通過在函數內部def的關鍵字再聲明一個函數即為嵌套：

閉包：如果在一個內部函數里，對在外部作用域（但不是全局作用域）的變量進行引用，那么內部函數就認為是閉包。      

閉包的意義：返回的函數對象，不僅僅是一個函數對象，在該函數外還包裹了一層作用域，這使得，該函數無論在何處調用，優先使用自己外層包裹的作用域

def ounter():
    name = 'duart'

    def inner():     #閉包條件一 inner就是內部函數
        print("在inner里打印外層函數的變量",name)       #閉包條件二，外部環境的一個變量

    return inner                                #結論，內部函數inner就是一個閉包

f = ounter()
print(f())

# 結果：
# 在inner里打印外層函數的變量 duart
# None    

　　看一個例子：

def make_adder(addend):
    def adder(augend):
        return augend+addend
    return adder

res1 = make_adder(12)
res2 = make_adder(13)
print(res1(100))
print(res2(100))

# 運行結果：
# 112
# 113

 

分析一下:
    我們發現,make_adder是一個函數,包括一個參數addend,
比較特殊的地方是這個函數里面又定義了一個新函數,
這個新函數里面的一個變量正好是外部make_adder的參數.
也就是說,外部傳遞過來的addend參數已經和adder函數綁定到一起了,
形成了一個新函數,我們可以把addend看做新函數的一個配置信息,
配置信息不同,函數的功能就不一樣了,也就是能得到定制之后的函數.
    再看看運行結果,我們發現,雖然p和q都是make_adder生成的,
但是因為配置參數不同,后面再執行相同參數的函數后得到了不同的結果.這就是閉包.

　　

再說一個例子：

def hellocounter(name):
    count = [0]
    def counter():
        count[0] += 1
        print("hello ",name , ',',str(count[0])+'access!')
    return counter

hello = hellocounter('make_program')
hello()
hello()
hello()
print(hello())

# 結果：
# hello  make_program , 1access!
# hello  make_program , 2access!
# hello  make_program , 3access!
# hello  make_program , 4access!
# None

　　

程序分析：
    這個程序比較有趣,我們可以把這個程序看做統計一個函數調用次數的函數.
count[0]可以看做一個計數器,沒執行一次hello函數,count[0]的值就加1。
也許你會有疑問:為什么不直接寫count而用一個列表?這是python2的一個bug,
如果不用列表的話,會報這樣一個錯誤:
UnboundLocalError: local variable 'count' referenced before assignment.
    什么意思?就是說conut這個變量你沒有定義就直接引用了,我不知道這是個什么東西,
程序就崩潰了.於是,再python3里面,引入了一個關鍵字:nonlocal,這個關鍵字是干什么的?
就是告訴python程序,我的這個count變量是再外部定義的,你去外面找吧.
然后python就去外層函數找,然后就找到了count=0這個定義和賦值,程序就能正常執行了

　最后再來一個例子

def makebold(n):
    def wrapped():
        return n()
    return wrapped

def makeitalic(n):
    def wrapped():
        return n()
    return wrapped

@makebold
@makeitalic

def hello():
    return 'hello word'

print(hello())
# hello word

　　

怎么樣?這個程序熟悉嗎?這不是傳說的的裝飾器嗎?對,這就是裝飾器,
其實,裝飾器就是一種閉包,我們再回想一下裝飾器的概念:對函數(參數,返回值等)
進行加工處理,生成一個功能增強版的一個函數。再看看閉包的概念,這個增強版的
函數不就是我們配置之后的函數嗎?區別在於,裝飾器的參數是一個函數或類,
專門對類或函數進行加工處理。
python里面的好多高級功能，比如裝飾器，生成器，列表推到，閉包，匿名函數等，
開發中用一下，可能會達到事半功倍的效果！

　　

inner()  局部變量，全局無法調用，所以關於閉包，就是一個內部函數 + 外部環境

 閉包的用途：

一：

# 用途1：當閉包執行完后，仍然能夠保持住當前的運行環境。
# 比如說，如果你希望函數的每次執行結果，都是基於這個函數上次的運行結果。我以一個類似棋盤游戲的例子
# 來說明。假設棋盤大小為50*50，左上角為坐標系原點(0,0)，我需要一個函數，接收2個參數，分別為方向
# (direction)，步長(step)，該函數控制棋子的運動。棋子運動的新的坐標除了依賴於方向和步長以外，
# 當然還要根據原來所處的坐標點，用閉包就可以保持住這個棋子原來所處的坐標。

origin = [0, 0] # 坐標系統原點
legal_x = [0, 50] # x軸方向的合法坐標
legal_y = [0, 50] # y軸方向的合法坐標
def create(pos=origin):
 def player(direction,step):
  # 這里應該首先判斷參數direction,step的合法性，比如direction不能斜着走，step不能為負等
  # 然后還要對新生成的x，y坐標的合法性進行判斷處理，這里主要是想介紹閉包，就不詳細寫了。
  new_x = pos[0] + direction[0]*step
  new_y = pos[1] + direction[1]*step
  pos[0] = new_x
  pos[1] = new_y
  #注意！此處不能寫成 pos = [new_x, new_y]，原因在上文有說過
  return pos
 return player

player = create() # 創建棋子player，起點為原點
print (player([1,0],10)) # 向x軸正方向移動10步
print (player([0,1],20)) # 向y軸正方向移動20步
print (player([-1,0],10)) # 向x軸負方向移動10步

　　

二：

# 用途2：閉包可以根據外部作用域的局部變量來得到不同的結果，這有點像一種類似配置功能的作用，我們可以
# 修改外部的變量，閉包根據這個變量展現出不同的功能。比如有時我們需要對某些文件的特殊行進行分析，先
# 要提取出這些特殊行。

def make_filter(keep):
 def the_filter(file_name):
  file = open(file_name)
  lines = file.readlines()
  file.close()
  filter_doc = [i for i in lines if keep in i]
  return filter_doc
 return the_filter

# 如果我們需要取得文件"result.txt"中含有"pass"關鍵字的行，則可以這樣使用例子程序
filter = make_filter("pass")
filter_result = filter("result.txt")

　　

下面就進入正題了：裝飾器　

一：簡單裝飾器

　　裝飾器其實就是一個以函數作為參數並返回一個替換函數的可執行函數。本質上就是一個函數，該函數用來處理其他函數，它可以讓其他函數在不需要修改代碼的前提下增加額外的功能，裝飾器的返回值也是一個函數對象，它經常用於有切面需求的場景，比如：插入日志、性能測試、事務處理、緩存、權限校驗等應用場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數功能本身無關的雷同代碼並繼續重用。

　　概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。

 

從一個例子說起：

業務生產中大量調用的函數：：

def foo():
    print('hello foo')
foo()

　　現在有一個新的需求，希望可以記錄下函數的執行時間，於是在代碼中添加日志代碼：

import time
def foo():
    start_time=time.time()
    print('hello foo')
    time.sleep(3)
    end_time=time.time()
    print('spend %s'%(end_time-start_time))
 
foo()

　　bar()、bar2()也有類似的需求，怎么做？再在bar函數里調用時間函數？這樣就造成大量雷同的代碼，為了減少重復寫代碼，我們可以這樣做，重新定義一個函數：專門設定時間:

import time
def show_time(func):
    start_time=time.time()
    func()
    end_time=time.time()
    print('spend %s'%(end_time-start_time))
 
 
def foo():
    print('hello foo')
    time.sleep(3)
 
show_time(foo)

　　邏輯上不難理解，而且運行正常。 但是這樣的話,你基礎平台的函數修改了名字，容易被業務線的人投訴的，因為我們每次都要將一個函數作為參數傳遞給show_time函數。而且這種方式已經破壞了原有的代碼邏輯結構，之前執行業務邏輯時，執行運行foo()，但是現在不得不改成show_time(foo)。那么有沒有更好的方式的呢？當然有，答案就是裝飾器。

　　if  foo()==show_time(foo) :問題解決!  

   所以，我們需要show_time(foo)返回一個函數對象，而這個函數對象內則是核心業務函數:執行func()與裝飾函數時間計算，修改如下：

import time
 
def show_time(func):
    def wrapper():
        start_time=time.time()
        func()
        end_time=time.time()
        print('spend %s'%(end_time-start_time))
 
    return wrapper
 
 
def foo():
    print('hello foo')
    time.sleep(3)
 
foo=show_time(foo)
foo()

　　

函數show_time就是裝飾器，它把真正的業務方法func包裹在函數里面，看起來像foo被上下時間函數裝飾了。在這個例子中，函數進入和退出時 ，被稱為一個橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。　

@符號是裝飾器的語法糖，在定義函數的時候使用，避免再一次賦值操作

import time
 
def show_time(func):
    def wrapper():
        start_time=time.time()
        func()
        end_time=time.time()
        print('spend %s'%(end_time-start_time))
 
    return wrapper
 
@show_time   #foo=show_time(foo)
def foo():
    print('hello foo')
    time.sleep(3)
 
 
@show_time  #bar=show_time(bar)
def bar():
    print('in the bar')
    time.sleep(2)
 
foo()
print('***********')
bar()

　　

　　如上所示，這樣我們就可以省去bar = show_time(bar)這一句了，直接調用bar()即可得到想要的結果。如果我們有其他的類似函數，我們可以繼續調用裝飾器來修飾函數，而不用重復修改函數或者增加新的封裝。這樣，我們就提高了程序的可重復利用性，並增加了程序的可讀性。

      這里需要注意的問題：  foo=show_time(foo)其實是把wrapper引用的對象引用給了foo，而wrapper里的變量func之所以可以用，就是因為wrapper是一個閉包函數。

二，帶參數的被裝飾函數

import time
 
def show_time(func):
 
    def wrapper(a,b):
        start_time=time.time()
        func(a,b)
        end_time=time.time()
        print('spend %s'%(end_time-start_time))
 
    return wrapper
 
@show_time   #add=show_time(add)
def add(a,b):
 
    time.sleep(1)
    print(a+b)
 
add(2,4)

　　

import time

def show_time(func):

    def wrapper(a,b):
        start_time=time.time()
        ret=func(a,b)
        end_time=time.time()
        print('spend %s'%(end_time-start_time))
        return ret

    return wrapper

@show_time   #add=show_time(add)
def add(a,b):

    time.sleep(1)
    return a+b

print(add(2,5))

　　

不定長參數

#***********************************不定長參數
import time

def show_time(func):

    def wrapper(*args,**kwargs):
        start_time=time.time()
        func(*args,**kwargs)
        end_time=time.time()
        print('spend %s'%(end_time-start_time))

    return wrapper

@show_time   #add=show_time(add)
def add(*args,**kwargs):

    time.sleep(1)
    sum=0
    for i in args:
        sum+=i
    print(sum)

add(2,4,8,9)

　　

三，帶參數的裝飾器

　　裝飾器還有更大的靈活性，例如帶參數的裝飾器：在上面的裝飾器調用中，比如@show_time，該裝飾器唯一的參數就是執行業務的函數。裝飾器的語法允許我們在調用時，提供其它參數，比如@decorator(a)。這樣，就為裝飾器的編寫和使用提供了更大的靈活性。

import time
 
def time_logger(flag=0):
 
    def show_time(func):
 
            def wrapper(*args,**kwargs):
                start_time=time.time()
                func(*args,**kwargs)
                end_time=time.time()
                print('spend %s'%(end_time-start_time))
 
                if flag:
                    print('將這個操作的時間記錄到日志中')
 
            return wrapper
 
    return show_time
 
 
@time_logger(3)
def add(*args,**kwargs):
    time.sleep(1)
    sum=0
    for i in args:
        sum+=i
    print(sum)
 
add(2,7,5)

　　

@time_logger(3) 做了兩件事：

    （1）time_logger(3)：得到閉包函數show_time，里面保存環境變量flag

    （2）@show_time   ：add＝show_time(add)

上面的time_logger是允許帶參數的裝飾器。它實際上是對原有裝飾器的一個函數封裝，並返回一個裝飾器(一個含有參數的閉包函數)。當我 們使用@time_logger(3)調用的時候，Python能夠發現這一層的封裝，並把參數傳遞到裝飾器的環境中。

四，多層裝飾器

def makebold(fn):
    def wrapper():
        return "<b>" + fn() + "</b>"
    return wrapper
 
def makeitalic(fn):
    def wrapper():
        return "<i>" + fn() + "</i>"
    return wrapper
 
@makebold
@makeitalic
def hello():
    return "hello alvin"
 
hello()

　　

過程：

 五，類裝飾器

　　再來看看類裝飾器，相比函數裝飾器，類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的__call__方法，當使用 @ 形式將裝飾器附加到函數上時，就會調用此方法。

import time

class Foo(object):
    def __init__(self, func):
        self._func = func

    def __call__(self):
        start_time=time.time()
        self._func()
        end_time=time.time()
        print('spend %s'%(end_time-start_time))

@Foo  #bar=Foo(bar)

def bar():

    print ('bar')
    time.sleep(2)

bar()    #bar=Foo(bar)()>>>>>>>沒有嵌套關系了,直接active Foo的 __call__方法

　　

六，functools.wraps

　　使用裝飾器極大地復用了代碼，但是他有一個缺點就是原函數的元信息不見了，比如函數的docstring、__name__、參數列表，先看例子：

def foo():
    print("hello foo")

print(foo.__name__)
#####################

def logged(func):
    def wrapper(*args, **kwargs):

        print (func.__name__ + " was called")
        return func(*args, **kwargs)

    return wrapper


@logged
def cal(x):
   return x + x * x


print(cal.__name__)

########
# foo
# wrapper

　　

解釋：

@logged
def f(x):
   return x + x * x

等價於：

def f(x):
    return x + x * x
f = logged(f)

　　

不難發現，函數f被wrapper取代了，當然它的docstring，__name__就是變成了wrapper函數的信息了。

print f.__name__    # prints 'wrapper'
print f.__doc__     # prints None

　　

這個問題就比較嚴重的，好在我們有functools.wraps，wraps本身也是一個裝飾器，它能把原函數的元信息拷貝到裝飾器函數中，這使得裝飾器函數也有和原函數一樣的元信息了。

from functools import wraps
 
 
def logged(func):
 
    @wraps(func)
 
    def wrapper(*args, **kwargs):
        print (func.__name__ + " was called")
        return func(*args, **kwargs)
    return wrapper
 
@logged
def cal(x):
   return x + x * x
 
print(cal.__name__)  #cal

　　

 練習題：

一：編寫3個函數，每個函數執行的時間是不一樣的，

提示：可以使用time.sleep(2)，讓程序sleep 2s或更多，

二：編寫裝飾器，為每個函數加上統計運行時間的功能

提示：在函數開始執行時加上start=time.time()就可紀錄當前執行的時間戳，函數執行結束后在time.time() - start就可以拿到執行所用時間

三：編寫裝飾器，為函數加上認證的功能，即要求認證成功后才能執行函數

四：編寫裝飾器，為多個函數加上認證的功能（用戶的賬號密碼來源於文件），要求登錄成功一次，后續的函數都無需再輸入用戶名和密碼

提示：從文件中讀出字符串形式的字典，可以用eval('{"name":"egon","password":"123"}')轉成字典格式