中間件裝飾器python

『壹』 「低門檻 手把手」python 裝飾器(Decorators)原理說明

本文目的是由淺入深地介紹python裝飾器原理

裝飾器(Decorators)是 Python 的一個重要部分

其功能是， 在不修改原函數(類)定義代碼的情況下，增加新的功能

為了理解和實現裝飾器，我們先引入2個核心操作：

在這個例子中，函數hi的形參name，默認為'world'

在函數內部，又定義了另一個函數 howdoyoudo，定義這個函數時，將形參name作為新函數的形參name2的默認值。

因此，在函數內部調用howdoyoudo()時，將以調用hi時的實參為默認值，但也可以給howdoyoudo輸入其他參數。

上面的例子運行後輸出結果為：

這里新定義的howdoyoudo可以稱作一個「閉包」。不少關於裝飾器的blog都提到了這個概念，但其實沒必要給它取一個多專業的名字。我們知道閉包是 函數內的函數 就可以了

當我們進行 def 的時候，我們在做什麼？

這時，hi函數，列印一個字元串，同時返回一個字元串。

但hi函數本身也是一個對象，一個可以執行的對象。執行的方式是hi()。

這里hi和hi()有本質區別，

hi 代表了這個函數對象本身

hi() 則是運行了函數，得到函數的返回值。

作為對比，可以想像以下代碼

此時也是b存在，可以正常使用。

我們定義2個函數，分別實現自加1， 自乘2，

再定義一個函數double_exec，內容是將某個函數調用2次

在調用double_exec時，可以將函數作為輸入傳進來

輸出結果就是

7

27

同樣，也可以將函數作為輸出

輸出結果為

6

10

有了以上兩個核心操作，我們可以嘗試構造裝飾器了。

裝飾器的目的： 在不修改原函數(類)定義代碼的情況下，增加新的功能

試想一下，現在有一個原函數

在不修改原函數定義代碼的情況下，如果想進行函數內容的添加，可以將這個函數作為一個整體，添加到這樣的包裹中：

我們定義了一個my_decorator函數，這個函數進行了一種操作：

對傳入的f，添加操作(運行前後增加列印)，並把添加操作後的內容連同運行原函數的內容，一起傳出

這個my_decorator，定義了一種增加前後列印內容的行為

調用my_decorator時，對這個行為進行了操作。

因此，new_function是一個在original_function上增加了前後列印行為的新函數

這個過程被可以被稱作裝飾。

這里已經可以發現，裝飾器本身對於被裝飾的函數是什麼，是不需要考慮的。裝飾器本身只定義了一種裝飾行為，這個行為是通過裝飾器內部的閉包函數()進行定義的。

運行裝飾前後的函數，可以清晰看到裝飾的效果

我們復現一下實際要用裝飾器的情況，我們往往有一種裝飾器，想應用於很多個函數，比如

此時，如果我們想給3個print函數都加上裝飾器，需要這么做

實際調用的時候，就需要調用添加裝飾器的函數名了

當然，也可以賦值給原函數名

這樣至少不需要管理一系列裝飾前後的函數。

同時，在不需要進行裝飾的時候，需要把

全部刪掉。

事實上，這樣並不方便，尤其對於更復雜的裝飾器來說

為此，python提供了一種簡寫方式

這個定義print1函數前的@my_decorator，相當於在定義完print1後，自動直接運行了

不論採用@my_decorator放在新函數前，還是顯示地重寫print1 = my_decorator(print1)，都會存在一個問題：

裝飾後的函數，名字改變了(其實不止名字，一系列的索引都改變了)

輸出結果為:

這個現象的原因是，裝飾行為本身，是通過構造了一個新的函數（例子中是wrap_func函數）來實現裝飾這個行為的，然後把這個修改後的函數賦給了原函數名。

這樣，會導致我們預期的被裝飾函數的一些系統變數（比如__name__）發生了變化。

對此，python提供了解決方案：

經過這個行為後，被裝飾函數的系統變數問題被解決了

輸出結果為

剛才的例子都比較簡單，被裝飾的函數是沒有參數的。如果被裝飾的函數有參數，只需要在定義裝飾行為時（事實上，這個才更通用），增加(*args, **kwargs)描述即可

之前的描述中可以感受到，對於例子中的裝飾行為(前後加列印)，函數被裝飾後，本質上是調用了新的裝飾函數wrap_func。

因此，如果原函數需要有輸入參數傳遞，只需要在wrap_func（或其他任意名字的裝飾函數）定義時，也增加參數輸入(*args, **kwargs)，並將這些參數，原封不動地傳給待裝飾函數f。

這種定義裝飾行為的方式更具有普遍性，忘記之前的定義方式吧

我們試一下

輸出

這里需要注意的是，如果按照以下的方式定義裝飾器

那麼以下語句將不會執行

因為裝飾後實際的函數wrap_func(雖然名字被改成了原函數，系統參數也改成了原函數)，運行到return f(*args, **kwargs) 的時候已經結束了

因為裝飾器my_decorator本身也是可以輸入的，因此，只需要在定義裝飾器時，增加參數，並在後續函數中使用就可以了，比如

此時裝飾器已經可以有輸入參數了

輸出

你可能發現，為什麼不用簡寫版的方法了

因為以上代碼會報錯！！

究其原因，雖然

等價於

但是，

並不等價於

這本身和@語法有關，使用@my_decorator時，是系統在應用一個以單個函數作為參數的閉包函數。即，@是不能帶參數的。

但是你應該發現了，之前的@wraps(f)不是帶參數了嗎？請仔細觀察以下代碼

通過一層嵌套，my_decorator_with_parma本質上是返回了一個參數僅為一個函數的函數(my_decorator)，但因為my_decorator對my_decorator_with_parma來說是一個閉包，my_decorator_with_parma是可以帶參數的。（這句話真繞）

通過以上的定義，我們再來看

可以這么理解，my_decorator_with_parma(msg='yusheng')的結果是原來的my_decorator函數，同時，因為my_decorator_with_parma可以傳參，參數實際上是參與了my_decorator的（因為my_decorator對my_decorator_with_parma是閉包）， my_decorator_with_parma(msg='yusheng') 全等於 一個有參數參加的my_decorator

因此，以上代碼等價於有參數msg傳遞的

比較繞，需要理解一下，或者乾脆強記這種範式：

以上範式包含函數的輸入輸出、裝飾器的輸入，可以應對大部分情況了。

實驗一下：

輸出

以上是一個log裝飾器，利用datetime統計了函數的耗時，

並且，裝飾器可以進行輸出文件操作，如果給出了文件路徑，則輸出文件，否則就列印。

利用這個裝飾器，可以靈活地進行耗時統計

不設置輸出文件地址，則列印。運行結果為：

也可以輸出到文件

輸出結果為

同時在當前目錄生成了一個test.log 文件，內容為：

以上的裝飾器都是以函數形式出現的，但我們可以稍做改寫，將裝飾器以類的形式實現。

這個裝飾器類Log 上個例子里的裝飾器函數log功能是一樣的，同時，這個裝飾器類還可以作為基類被其他繼承，進一步增加功能。

原文 http://www.cnblogs.com/yushengchn/p/15636944.html

『貳』 如何理解Python裝飾器

裝飾器本質上是一個Python函數，它可以讓其他函數在不需要做任何代碼變動的前提下增加額外功能，裝飾器的返回值也是一個函數對象。它經常用於有切面需求的場景，比如：插入日誌、性能測試、事務處理、緩存、許可權校驗等場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數功能本身無關的雷同代碼並繼續重用。概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。

先來看一個簡單例子：
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 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 wrapper(*args, **kwargs):
logging.warn("%s is running" % func.__name__)
return func(*args)
return wrapper

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

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

bar()

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

裝飾器在Python使用如此方便都要歸因於Python的函數能像普通的對象一樣能作為參數傳遞給其他函數，可以被賦值給其他變數，可以作為返回值，可以被定義在另外一個函數內。

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

foo()

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

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

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

def __call__(self):
print ('class decorator runing')
self._func()
print ('class decorator ending')

@Foo
def bar():
print ('bar')

bar()

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)
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'

內置裝飾器
@staticmathod、@classmethod、@property
裝飾器的順序
@a
@b
@c
def f ():

等效於

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

『叄』 什麼是Python裝飾器

所謂裝飾器就是把函數包裝一下，為函數添加一些附加功能，裝飾器就是一個函數，參數為被包裝的函數，返回包裝後的函數：你可以試下：

defd(fp):
def_d(*arg,**karg):
print"dosthbeforefp.."
r=fp(*arg,**karg)
print"dosthafterfp.."
returnr
return_d
@d
deff():
print"callf"
#上面使用@d來表示裝飾器和下面是一個意思
#f=d(f)
f()#調用f

『肆』 python裝飾器使用

裝飾器是從英文decorator翻譯過來的，從字面上來看就是對某個東西進行修飾，增強被修飾物的功能，下面我們對裝飾器做下簡單介紹。

一、怎麼編寫裝飾器

裝飾器的實現很簡單，本質是一個可調用對象，可以是函數、方法、對象等，它既可以裝飾函數也可以裝飾類和方法，為了簡單說明問題，我們實現一個函數裝飾器，如下代碼：

有了這個裝飾器，我們就可以列印出什麼時候開始和結束調用函數，對於排查函數的調用鏈非常方便。

二、帶參數的裝飾器

上面的例子無論什麼時候調用sum都會輸出信息，如果我們需要按需輸出信息怎麼實現呢，這時就要用到帶參數的裝飾器了，如下代碼：

對sum使用裝飾器時沒有參數，這時debug為0，所以調用sum時不會輸出函數調用相關信息。

對multi使用裝飾器時有參數，這時debug為1，所以調用multi時會輸出函數調用相關信息。

三、函數名字問題

當我們列印被裝飾後的函數名字時，不知道大家有沒發現輸出的不是函數本身的名字，如下代碼會輸出『wrap』而不是『sum』：

有時這種表現並不是我們想要的，我們希望被裝飾後的函數名字還是函數本身，那要怎麼實現呢？很簡單，只需要引入functools.wraps即可，如下代碼就會輸出『sum』了：

看完後是不是覺得python裝飾器很簡單，只要了解它的本質，怎麼寫都行，有好多種玩法呢。

『伍』 關於python裝飾器的問題

裝飾器函數參數要傳函數，而不是字元串。

裝飾器函數特點:

1，參數為函數對象

2，使用內部函數

3，返回函數對象

在你的代碼中:

裝飾器函數是arg_func(sex)

內部函數是func1()

被裝飾函數是man()和woman()

所以代碼要改成:

defarg_func(sex):

deffunc1():

sex()

if(sex.__name__=='man'):

print("youcan't")

if(sex.__name__=='woman'):

print("youcan")

returnfunc1

@arg_func

defman():

print('goodgoodstudy')

@arg_func

defwoman():

print('goodgoodstudy')

man()

woman()

PS:裝飾器就是為了簡化代碼，增加可讀性，方便團隊開發，在不修改原函數代碼的前提下，通過封裝修改功能，而@修飾就是為了通過原函數名調用時，不直接執行原函數，而是把原函數傳遞到裝飾器函數，通過內部函數(閉包)來調用原函數。這樣好處，就是統一調用方式。

『陸』 Python內置裝飾器——@property

@property是Python中的一個內置裝飾器，它允許我們將方法轉變為可以像屬性一樣直接調用的形式，提供了一種數據封裝的靈活性和安全性。具體來說：

• 功能轉換：

  • 當一個方法被@property裝飾後，它就被轉換為一個getter方法，可以像訪問屬性一樣直接調用該方法。

• setter和deleter功能：

  • 除了getter功能，@property還允許通過@.setter裝飾器定義setter方法，用於設置屬性值。
  • 通過@.deleter裝飾器還可以定義deleter方法，用於刪除屬性。

• 數據封裝和安全性：

  • 使用@property可以將一些內部屬性封裝起來，只通過定義好的屬性介面進行訪問和修改，增強了數據的安全性。
  • 可以在setter方法中加入驗證邏輯，確保數據的一致性和完整性。

• 代碼可維護性：

  • @property使得代碼更加簡潔和直觀，減少了直接操作內部屬性的代碼，提高了代碼的可維護性。

總之，@property裝飾器是Python中一個非常有用的特性，它使得我們可以更加靈活和安全地管理對象的屬性。

『柒』 Python筆記：Python裝飾器

裝飾器是通過裝飾器函數修改原函數的一些功能而不需要修改原函數，在很多場景可以用到它，比如① 執行某個測試用例之前，判斷是否需要登錄或者執行某些特定操作；② 統計某個函數的執行時間；③ 判斷輸入合法性等。合理使用裝飾器可以極大地提高程序的可讀性以及運行效率。本文將介紹Python裝飾器的使用方法。

python裝飾器可以定義如下：

輸出：

python解釋器將test_decorator函數作為參數傳遞給my_decorator函數，並指向了內部函數 wrapper()，內部函數 wrapper() 又會調用原函數 test_decorator()，所以decorator()的執行會先列印'this is wrapper'，然後列印'hello world'， test_decorator()執行完成後，列印 'bye' ，*args和**kwargs，表示接受任意數量和類型的參數。

裝飾器 my_decorator() 把真正需要執行的函數 test_decorator() 包裹在其中，並且改變了它的行為，但是原函數 test_decorator() 不變。

一般使用如下形式使用裝飾器：

@my_decorator就相當於 decorator = my_decorator(test_decorator) 語句。

內置裝飾器@functools.wrap可用於保留原函數的元信息（將原函數的元信息，拷貝到對應的裝飾器函數里）。先來看看沒有使用functools的情況：

輸出：

從上面的輸出可以看出test_decorator() 函數被裝飾以後元信息被wrapper() 函數取代了，可以使用@functools.wrap裝飾器保留原函數的元信息：

輸出：

裝飾器可以接受自定義參數。比如定義一個參數來設置裝飾器內部函數的執行次數：

輸出：

Python 支持多個裝飾器嵌套：

裝飾的過程：

順序從里到外：

test_decorator('hello world') 執行順序和裝飾的過程相反。

輸出：

類也可以作為裝飾器，類裝飾器主要依賴__call__()方法，是python中所有能被調用的對象具有的內置方法（python魔術方法），每當調用一個類的實例時，__call__()就會被執行一次。

下面的類裝飾器實現統計函數執行次數：

輸出：

下面介紹兩種裝飾器使用場景

統計函數執行所花費的時間

輸出：

在使用某些web服務時，需要先判斷用戶是否登錄，如果沒有登錄就跳轉到登錄頁面或者提示用戶登錄：

--THE END--