python裝飾器5的簡單介紹

本文目錄一覽：

• 1、「低門檻 手把手」python 裝飾器(Decorators)原理說明
• 2、Python筆記：Python裝飾器
• 3、python裝飾器使用
• 4、推薦 8 個炫酷的 Python 裝飾器
• 5、什麼是Python裝飾器
• 6、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功能是一樣的，同時，這個裝飾器類還可以作為基類被其他繼承，進一步增加功能。

原文

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–

python裝飾器使用

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

一、怎麼編寫裝飾器

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

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

二、帶參數的裝飾器

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

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

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

三、函數名字問題

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

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

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

推薦 8 個炫酷的 Python 裝飾器

1、 lru_cache

這個裝飾器來自functools模塊。該模塊包含在標準庫中，非常易於使用。它還包含比這個裝飾器更酷的功能，但這個裝飾器是非常受人喜歡的。此裝飾器可用於使用緩存加速函數的連續運行。當然，這應該在使用時記住一些關於緩存的注意事項，但在通用使用情況下，大多數時候這個裝飾器都是值得使用的。

2、JIT

JIT是即時編譯的縮寫。通常每當我們在Python中運行一些代碼時，發生的第一件事就是編譯。這種編譯會產生一些開銷，因為類型被分配了內存，並存儲為未分配但已命名的別名，使用即時編譯，我們在執行時才進行編譯。

在很多方面，我們可以將其視為類似於並行計算的東西，其中Python解釋器同時處理兩件事以節省時間。Numba JTI編譯器因將這一概念提到Python中而聞名，可以非常輕鬆地調用此裝飾器，並立即提高代碼的性能。Numba包提供了JIT裝飾器，它使運行更密集的軟體變得更加容易，而不必進入C。

3、do_twice

do_twice裝飾器的功能與它的名字差不多。此裝飾器可用於通過一次調用運行兩次函數，對調試特別有用。它可以用於測量兩個不同迭代的功能。

4、count_calls

count_calls裝飾器可用於提供有關函數在軟體中使用多少次的信息。與do_twice一樣，對調試也特別有用。

5、dataclass

為了節省編寫類的時間，推薦使用dataclass裝飾器。這個裝飾器可用於快速編寫類中常見的標準方法，這些方法通常會在我們編寫的類中找到。

6、singleton

singleton是一個單例裝飾器。通常，單例裝飾器是由用戶自己編寫的，實際上並不是導入的。

7、use_unit

在科學計算中經常派上用場的一種裝飾器是use_unit裝飾器。此裝飾器可用於更改返回結果的表示單位。這對於那些不想在數據中添加度量單位但仍希望人們知道這些單位是什麼的人很有用。這個裝飾器可不是在任何模塊中真正有用，但它是非常常見的，對科學應用程序非常有用。

什麼是Python裝飾器

裝飾器(decorator)是Python中的高級語法。裝飾的意思就是動態擴展被裝飾對象的功能。裝飾器可以用於裝飾函數、方法和類。

一 嵌套函數

# 定義一個外層函數def foo(): # 定義了一個內部函數 def bar(): print(“hello world”)

函數bar是一個定義在foo函數內部的函數。

Python中的函數是支持嵌套的，也就是可以在一個函數內部再定義一個函數。

然後，我們還知道函數是可以當作變數的，於是我們就可以在foo函數中把定義的這個bar函數返回。就像下面這樣：

# 定義一個外層函數def foo(): # 定義了一個內層函數 def bar(): print(“hello world”) return

barfunc = foo()func() # func — bar，這裡執行func其實就相當於執行了在foo函數內部定義的bar函數

二 閉包形態1

# 閉包形態1def foo(): name = “Andy” # 外部函數的局部變數 # 定義了一個內部函數 def bar():

print(name) # 雖然bar函數中沒有定義name變數，但是它可以訪問外部函數的局部變數name return barfunc =

foo()func() # func — bar — 除了是一個函數，還包含一個值(它外層函數的局部變數)的引用

三 閉包形態2

# 閉包形態2def foo(name): # 給一個函數傳參也相當於給函數定義了一個局部變數 # 定義了一個內部函數 def bar():

print(name) # 內部函數同樣可以獲取到傳到外部函數的變數(參數) return barfunc = foo(“Andy”) #

把「Andy」當成參數傳入foo函數 — 其內部定義的bar函數也能拿到這個「Andy」func() # func — bar —

除了是一個函數，還包含一個值(它外層函數的參數)的引用

四 裝飾器形態1

# 還是定義一個外層函數def foo(name): # 我接收的參數是一個函數名 # 定義了一個內部函數 def bar():

print(“這是新功能。。。”) # 新功能 name() # 函數名加()就相當於執行– 我傳進來原函數的函數名，這裡就相當於執行了原函數

return bar# 定義一個被裝飾的函數def f1(): print(“hello world.”) # 用foo函數裝飾f1函數f1 =

foo(f1)# 不改變f1的調用方式f1() # — 此時函數已經擴展了新功能

五 裝飾器形態2

# 還是定義一個外層函數def foo(name): # 接收的參數是一個函數名 # 定義了一個內部函數 def bar():

print(“這是新功能。。。”) # 新功能 name() # 函數名加()就相當於執行– 傳進來原函數的函數名，這裡就相當於執行了原函數

return bar# 定義一個被裝飾的函數# 用foo函數裝飾f1函數@foo # 使用f1 =

foo(f1)語法裝飾的話稍顯啰嗦，Python就提供了@語法，讓裝飾過程更簡便def f1(): print(“hello world.”) #

不改變f1的調用方式f1() # — 此時函數已經擴展了新功能。

python裝飾器的作用和功能

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