python 裝飾器功能與用法案例詳解

更新時(shí)間：2020年03月06日 12:57:56 作者：hankleo

這篇文章主要介紹了python 裝飾器功能與用法,結(jié)合具體實(shí)例形式詳細(xì)分析了python 裝飾器的基本原理、功能、用法及操作注意事項(xiàng)

本文實(shí)例講述了python 裝飾器功能與用法。分享給大家供大家參考，具體如下：

1、必備

#### 第一波 ####
def foo():
  print 'foo'
 
foo   #表示是函數(shù)
foo()  #表示執(zhí)行foo函數(shù)
 
#### 第二波 ####
def foo():
  print 'foo'
 
foo = lambda x: x + 1
foo()  # 執(zhí)行下面的lambda表達(dá)式，而不再是原來的foo函數(shù)，因?yàn)楹瘮?shù) foo 被重新定義了

2、需求來了

初創(chuàng)公司有N個(gè)業(yè)務(wù)部門，1個(gè)基礎(chǔ)平臺部門，基礎(chǔ)平臺負(fù)責(zé)提供底層的功能，如：數(shù)據(jù)庫操作、redis調(diào)用、監(jiān)控API等功能。業(yè)務(wù)部門使用基礎(chǔ)功能時(shí)，只需調(diào)用基礎(chǔ)平臺提供的功能即可。如下：

############### 基礎(chǔ)平臺提供的功能如下 ###############
def f1():
  print 'f1'
 
def f2():
  print 'f2'
 
def f3():
  print 'f3'
 
def f4():
  print 'f4'
 
############### 業(yè)務(wù)部門A 調(diào)用基礎(chǔ)平臺提供的功能 ###############
f1()
f2()
f3()
f4()
 
############### 業(yè)務(wù)部門B 調(diào)用基礎(chǔ)平臺提供的功能 ###############
f1()
f2()
f3()
f4()

目前公司有條不紊的進(jìn)行著，但是，以前基礎(chǔ)平臺的開發(fā)人員在寫代碼時(shí)候沒有關(guān)注驗(yàn)證相關(guān)的問題，即：基礎(chǔ)平臺的提供的功能可以被任何人使用?，F(xiàn)在需要對基礎(chǔ)平臺的所有功能進(jìn)行重構(gòu)，為平臺提供的所有功能添加驗(yàn)證機(jī)制，即：執(zhí)行功能前，先進(jìn)行驗(yàn)證。

老大把工作交給 Low B，他是這么做的：

跟每個(gè)業(yè)務(wù)部門交涉，每個(gè)業(yè)務(wù)部門自己寫代碼，調(diào)用基礎(chǔ)平臺的功能之前先驗(yàn)證。誒，這樣一來基礎(chǔ)平臺就不需要做任何修改了。

當(dāng)天Low B 被開除了...

老大把工作交給 Low BB，他是這么做的：

只對基礎(chǔ)平臺的代碼進(jìn)行重構(gòu)，讓N業(yè)務(wù)部門無需做任何修改

############### 基礎(chǔ)平臺提供的功能如下 ############### 

def f1():
  # 驗(yàn)證1
  # 驗(yàn)證2
  # 驗(yàn)證3
  print 'f1'

def f2():
  # 驗(yàn)證1
  # 驗(yàn)證2
  # 驗(yàn)證3
  print 'f2'

def f3():
  # 驗(yàn)證1
  # 驗(yàn)證2
  # 驗(yàn)證3
  print 'f3'

def f4():
  # 驗(yàn)證1
  # 驗(yàn)證2
  # 驗(yàn)證3
  print 'f4'
############### 業(yè)務(wù)部門不變 ############### 
### 業(yè)務(wù)部門A 調(diào)用基礎(chǔ)平臺提供的功能### 

f1()
f2()
f3()
f4()

### 業(yè)務(wù)部門B 調(diào)用基礎(chǔ)平臺提供的功能 ### 

f1()
f2()
f3()
f4()

過了一周 Low BB 被開除了...

老大把工作交給 Low BBB，他是這么做的：

只對基礎(chǔ)平臺的代碼進(jìn)行重構(gòu)，其他業(yè)務(wù)部門無需做任何修改

############### 基礎(chǔ)平臺提供的功能如下 ############### 

def check_login():
  # 驗(yàn)證1
  # 驗(yàn)證2
  # 驗(yàn)證3
  pass

def f1():
  
  check_login()

  print 'f1'

def f2():
  
  check_login()

  print 'f2'

def f3():
  
  check_login()

  print 'f3'

def f4():
  
  check_login()
  
  print 'f4'

老大看了下Low BBB 的實(shí)現(xiàn)，嘴角漏出了一絲的欣慰的笑，語重心長的跟Low BBB聊了個(gè)天：

老大說：

寫代碼要遵循開發(fā)封閉原則，雖然在這個(gè)原則是用的面向?qū)ο箝_發(fā)，但是也適用于函數(shù)式編程，簡單來說，它規(guī)定已經(jīng)實(shí)現(xiàn)的功能代碼不允許被修改，但可以被擴(kuò)展，即：

封閉：已實(shí)現(xiàn)的功能代碼塊
開放：對擴(kuò)展開發(fā)

如果將開放封閉原則應(yīng)用在上述需求中，那么就不允許在函數(shù) f1 、f2、f3、f4的內(nèi)部進(jìn)行修改代碼，老板就給了Low BBB一個(gè)實(shí)現(xiàn)方案：

def w1(func):
  def inner():
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func()
  return inner
 
@w1
def f1():
  print 'f1'
@w1
def f2():
  print 'f2'
@w1
def f3():
  print 'f3'
@w1
def f4():
  print 'f4'

對于上述代碼，也是僅僅對基礎(chǔ)平臺的代碼進(jìn)行修改，就可以實(shí)現(xiàn)在其他人調(diào)用函數(shù) f1 f2 f3 f4 之前都進(jìn)行【驗(yàn)證】操作，并且其他業(yè)務(wù)部門無需做任何操作。

Low BBB心驚膽戰(zhàn)的問了下，這段代碼的內(nèi)部執(zhí)行原理是什么呢？

老大正要生氣，突然Low BBB的手機(jī)掉到地上，恰恰屏保就是Low BBB的女友照片，老大一看一緊一抖，喜笑顏開，交定了Low BBB這個(gè)朋友。詳細(xì)的開始講解了：

單獨(dú)以f1為例：

def w1(func):
  def inner():
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func()
  return inner
@w1
def f1():
  print 'f1'

當(dāng)寫完這段代碼后（函數(shù)未被執(zhí)行、未被執(zhí)行、未被執(zhí)行），python解釋器就會(huì)從上到下解釋代碼，步驟如下：

def w1(func): ==>將w1函數(shù)加載到內(nèi)存
@w1

沒錯(cuò)，從表面上看解釋器僅僅會(huì)解釋這兩句代碼，因?yàn)楹瘮?shù)在沒有被調(diào)用之前其內(nèi)部代碼不會(huì)被執(zhí)行。

從表面上看解釋器著實(shí)會(huì)執(zhí)行這兩句，但是 @w1 這一句代碼里卻有大文章，@函數(shù)名是python的一種語法糖。

如上例@w1內(nèi)部會(huì)執(zhí)行一下操作：

執(zhí)行w1函數(shù)，并將 @w1 下面的 函數(shù) 作為w1函數(shù)的參數(shù)，即：@w1 等價(jià)于 w1(f1)
所以，內(nèi)部就會(huì)去執(zhí)行：

  def inner:
    #驗(yàn)證
    return f1()  # func是參數(shù)，此時(shí) func 等于 f1
  return inner   # 返回的 inner，inner代表的是函數(shù)，非執(zhí)行函數(shù)

其實(shí)就是將原來的 f1 函數(shù)塞進(jìn)另外一個(gè)函數(shù)中
將執(zhí)行完的 w1 函數(shù)返回值賦值給@w1下面的函數(shù)的函數(shù)名
w1函數(shù)的返回值是：
def inner:
#驗(yàn)證
return 原來f1() # 此處的 f1 表示原來的f1函數(shù)
然后，將此返回值再重新賦值給 f1，即：
新f1 = def inner:
#驗(yàn)證
return 原來f1()
所以，以后業(yè)務(wù)部門想要執(zhí)行 f1 函數(shù)時(shí)，就會(huì)執(zhí)行新f1 函數(shù)，在新f1 函數(shù)內(nèi)部先執(zhí)行驗(yàn)證，再執(zhí)行原來的f1函數(shù)，然后將原來f1 函數(shù)的返回值返回給了業(yè)務(wù)調(diào)用者。
如此一來，即執(zhí)行了驗(yàn)證的功能，又執(zhí)行了原來f1函數(shù)的內(nèi)容，并將原f1函數(shù)返回值返回給業(yè)務(wù)調(diào)用著

Low BBB 你明白了嗎？要是沒明白的話，我晚上去你家?guī)湍憬鉀Q吧?。?！

先把上述流程看懂，之后還會(huì)繼續(xù)更新...

3、問答時(shí)間

問題：被裝飾的函數(shù)如果有參數(shù)呢？

一個(gè)參數(shù)：

def w1(func):
  def inner(arg):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(arg)
  return inner

@w1
def f1(arg):
  print 'f1'

兩個(gè)參數(shù)：

def w1(func):
  def inner(arg1,arg2):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(arg1,arg2)
  return inner

@w1
def f1(arg1,arg2):
  print 'f1'

三個(gè)參數(shù)：

def w1(func):
  def inner(arg1,arg2,arg3):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(arg1,arg2,arg3)
  return inner

@w1
def f1(arg1,arg2,arg3):
  print 'f1'

問題：可以裝飾具有處理n個(gè)參數(shù)的函數(shù)的裝飾器？

def w1(func):
  def inner(*args,**kwargs):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(*args,**kwargs)
  return inner
 
@w1
def f1(arg1,arg2,arg3):
  print 'f1'

問題：一個(gè)函數(shù)可以被多個(gè)裝飾器裝飾嗎？

def w1(func):
  def inner(*args,**kwargs):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(*args,**kwargs)
  return inner
 
def w2(func):
  def inner(*args,**kwargs):
    # 驗(yàn)證1
    # 驗(yàn)證2
    # 驗(yàn)證3
    return func(*args,**kwargs)
  return inner
 
@w1
@w2
def f1(arg1,arg2,arg3):
  print 'f1'

問題：還有什么更吊的裝飾器嗎？

#!/usr/bin/env python
#coding:utf-8
 
def Before(request,kargs):
  print 'before'
   
def After(request,kargs):
  print 'after'
 
 
def Filter(before_func,after_func):
  def outer(main_func):
    def wrapper(request,kargs):
       
      before_result = before_func(request,kargs)
      if(before_result != None):
        return before_result;
       
      main_result = main_func(request,kargs)
      if(main_result != None):
        return main_result;
       
      after_result = after_func(request,kargs)
      if(after_result != None):
        return after_result;
       
    return wrapper
  return outer
   
@Filter(Before, After)
def Index(request,kargs):
  print 'index'

4、functools.wraps

上述的裝飾器雖然已經(jīng)完成了其應(yīng)有的

功能，即：裝飾器內(nèi)的函數(shù)代指了原函數(shù)，注意其只是代指而非相等，原函數(shù)的元信息沒有被賦值到裝飾器函數(shù)內(nèi)部。例如：函數(shù)的注釋信息

無元信息：

def outer(func):
  def inner(*args, **kwargs):
    print(inner.__doc__) # None
    return func()
  return inner

@outer
def function():
  """
  asdfasd
  :return:
  """
  print('func')

如果使用@functools.wraps裝飾裝飾器內(nèi)的函數(shù)，那么就會(huì)代指元信息和函數(shù)。

含元信息：

def outer(func):
  @functools.wraps(func)
  def inner(*args, **kwargs):
    print(inner.__doc__) # None
    return func()
  return inner

@outer
def function():
  """
  asdfasd
  :return:
  """
  print('func')

更多關(guān)于Python相關(guān)內(nèi)容感興趣的讀者可查看本站專題：《Python面向?qū)ο蟪绦蛟O(shè)計(jì)入門與進(jìn)階教程》、《Python數(shù)據(jù)結(jié)構(gòu)與算法教程》、《Python函數(shù)使用技巧總結(jié)》、《Python字符串操作技巧匯總》、《Python編碼操作技巧總結(jié)》及《Python入門與進(jìn)階經(jīng)典教程》

希望本文所述對大家Python程序設(shè)計(jì)有所幫助。

您可能感興趣的文章: