12步入門Python中的decorator裝飾器使用方法
裝飾器(decorator)是一種高級(jí)Python語法。裝飾器可以對(duì)一個(gè)函數(shù)、方法或者類進(jìn)行加工。在Python中,我們有多種方法對(duì)函數(shù)和類進(jìn)行加工,比如在Python閉包中,我們見到函數(shù)對(duì)象作為某一個(gè)函數(shù)的返回結(jié)果。相對(duì)于其它方式,裝飾器語法簡(jiǎn)單,代碼可讀性高。因此,裝飾器在Python項(xiàng)目中有廣泛的應(yīng)用。
裝飾器最早在Python 2.5中出現(xiàn),它最初被用于加工函數(shù)和方法這樣的可調(diào)用對(duì)象(callable object,這樣的對(duì)象定義有call方法)。在Python 2.6以及之后的Python版本中,裝飾器被進(jìn)一步用于加工類。
1. 函數(shù)
在python中,函數(shù)通過def關(guān)鍵字、函數(shù)名和可選的參數(shù)列表定義。通過return關(guān)鍵字返回值。我們舉例來說明如何定義和調(diào)用一個(gè)簡(jiǎn)單的函數(shù):
>>> def foo(): ... return 1 >>> foo() 1
方法體(當(dāng)然多行也是一樣的)是必須的,通過縮進(jìn)來表示,在方法名的后面加上雙括號(hào)()就能夠調(diào)用函數(shù)
2. 作用域
在python中,函數(shù)會(huì)創(chuàng)建一個(gè)新的作用域。python開發(fā)者可能會(huì)說函數(shù)有自己的命名空間,差不多一個(gè)意思。這意味著在函數(shù)內(nèi)部碰到一個(gè)變量的時(shí)候函數(shù)會(huì)優(yōu)先在自己的命名空間里面去尋找。讓我們寫一個(gè)簡(jiǎn)單的函數(shù)看一下 本地作用域 和 全局作用域有什么不同:
>>> a_string = "This is a global variable" >>> def foo(): ... print locals() >>> print globals() {..., 'a_string': 'This is a global variable'} >>> foo() # 2 {}
內(nèi)置的函數(shù)globals返回一個(gè)包含所有python解釋器知道的變量名稱的字典(為了干凈和洗的白白的,我省略了python自行創(chuàng)建的一些變量)。在#2我調(diào)用了函數(shù) foo 把函數(shù)內(nèi)部本地作用域里面的內(nèi)容打印出來。我們能夠看到,函數(shù)foo有自己獨(dú)立的命名空間,雖然暫時(shí)命名空間里面什么都還沒有。
3. 變量解析規(guī)則
當(dāng)然這并不是說我們?cè)诤瘮?shù)里面就不能訪問外面的全局變量。在python的作用域規(guī)則里面,創(chuàng)建變量一定會(huì)一定會(huì)在當(dāng)前作用域里創(chuàng)建一個(gè)變量,但是訪問或者修改變量時(shí)會(huì)先在當(dāng)前作用域查找變量,沒有找到匹配變量的話會(huì)依次向上在閉合的作用域里面進(jìn)行查看找。所以如果我們修改函數(shù)foo的實(shí)現(xiàn)讓它打印全局的作用域里的變量也是可以的:
>>> a_string = "This is a global variable" >>> def foo(): ... print a_string # 1 >>> foo() This is a global variable
在#1處,python解釋器會(huì)嘗試查找變量a_string,當(dāng)然在函數(shù)的本地作用域里面是找不到的,所以接著會(huì)去上層的作用域里面去查找。
但是另一方面,假如我們?cè)诤瘮?shù)內(nèi)部給全局變量賦值,結(jié)果卻和我們想的不一樣:
>>> a_string = "This is a global variable" >>> def foo(): ... a_string = "test" # 1 ... print locals() >>> foo() {'a_string': 'test'} >>> a_string # 2 'This is a global variable'
我們能夠看到,全局變量能夠被訪問到(如果是可變數(shù)據(jù)類型(像list,dict這些)甚至能夠被更改)但是賦值不行。在函數(shù)內(nèi)部的#1處,我們實(shí)際上新創(chuàng)建了一個(gè)局部變量,隱藏全局作用域中的同名變量。我們可以通過打印出局部命名空間中的內(nèi)容得出這個(gè)結(jié)論。我們也能看到在#2處打印出來的變量a_string的值并沒有改變。
4. 變量生存周期
值得注意的一個(gè)點(diǎn)是,變量不僅是生存在一個(gè)個(gè)的命名空間內(nèi),他們都有自己的生存周期,請(qǐng)看下面這個(gè)例子:
>>> def foo(): ... x = 1 >>> foo() >>> print x # 1 Traceback (most recent call last): ... NameError: name 'x' is not defined
#1處發(fā)生的錯(cuò)誤不僅僅是因?yàn)樽饔糜蛞?guī)則導(dǎo)致的(盡管這是拋出了NameError的錯(cuò)誤的原因)它還和python以及其它很多編程語言中函數(shù)調(diào)用實(shí)現(xiàn)的機(jī)制有關(guān)。在這個(gè)地方這個(gè)執(zhí)行時(shí)間點(diǎn)并沒有什么有效的語法讓我們能夠獲取變量x的值,因?yàn)樗@個(gè)時(shí)候壓根不存在!函數(shù)foo的命名空間隨著函數(shù)調(diào)用開始而開始,結(jié)束而銷毀。
5. 函數(shù)參數(shù)
python允許我們向函數(shù)傳遞參數(shù),參數(shù)會(huì)變成本地變量存在于函數(shù)內(nèi)部。
>>> def foo(x): ... print locals() >>> foo(1) {'x': 1}
在Python里有很多的方式來定義和傳遞參數(shù),完整版可以查看 python官方文檔。我們這里簡(jiǎn)略的說明一下:函數(shù)的參數(shù)可以是必須的位置參數(shù)或者是可選的命名,默認(rèn)參數(shù)。
>>> def foo(x, y=0): # 1 ... return x - y >>> foo(3, 1) # 2 2 >>> foo(3) # 3 3 >>> foo() # 4 Traceback (most recent call last): ... TypeError: foo() takes at least 1 argument (0 given) >>> foo(y=1, x=3) # 5 2
在#1處我們定義了函數(shù)foo,它有一個(gè)位置參數(shù)x和一個(gè)命名參數(shù)y。在#2處我們能夠通過常規(guī)的方式來調(diào)用函數(shù),盡管有一個(gè)命名參數(shù),但參數(shù)依然可以通過位置傳遞給函數(shù)。在調(diào)用函數(shù)的時(shí)候,對(duì)于命名參數(shù)y我們也可以完全不管就像#3處所示的一樣。如果命名參數(shù)沒有接收到任何值的話,python會(huì)自動(dòng)使用聲明的默認(rèn)值也就是0。需要注意的是我們不能省略第一個(gè)位置參數(shù)x, 否則的話就會(huì)像#5處所示發(fā)生錯(cuò)誤。
目前還算簡(jiǎn)潔清晰吧, 但是接下來可能會(huì)有點(diǎn)令人困惑。python支持函數(shù)調(diào)用時(shí)的命名參數(shù)(個(gè)人覺得應(yīng)該是命名實(shí)參)。看看#5處的函數(shù)調(diào)用,我們傳遞的是兩個(gè)命名實(shí)參,這個(gè)時(shí)候因?yàn)橛忻Q標(biāo)識(shí),參數(shù)傳遞的順序也就不用在意了。
當(dāng)然相反的情況也是正確的:函數(shù)的第二個(gè)形參是y,但是我們通過位置的方式傳遞值給它。在#2處的函數(shù)調(diào)用foo(3,1),我們把3傳遞給了第一個(gè)參數(shù),把1傳遞給了第二個(gè)參數(shù),盡管第二個(gè)參數(shù)是一個(gè)命名參數(shù)。
桑不起,感覺用了好大一段才說清楚這么一個(gè)簡(jiǎn)單的概念:函數(shù)的參數(shù)可以有名稱和位置。這意味著在函數(shù)的定義和調(diào)用的時(shí)候會(huì)稍稍在理解上有點(diǎn)兒不同。我們可以給只定義了位置參數(shù)的函數(shù)傳遞命名參數(shù)(實(shí)參),反之亦然!如果覺得不夠可以查看官方文檔
6. 嵌套函數(shù)
Python允許創(chuàng)建嵌套函數(shù)。這意味著我們可以在函數(shù)里面定義函數(shù)而且現(xiàn)有的作用域和變量生存周期依舊適用。
>>> def outer(): ... x = 1 ... def inner(): ... print x # 1 ... inner() # 2 ... >>> outer() 1
這個(gè)例子有一點(diǎn)兒復(fù)雜,但是看起來也還行。想一想在#1發(fā)生了什么:python解釋器需找一個(gè)叫x的本地變量,查找失敗之后會(huì)繼續(xù)在上層的作用域里面尋找,這個(gè)上層的作用域定義在另外一個(gè)函數(shù)里面。對(duì)函數(shù)outer來說,變量x是一個(gè)本地變量,但是如先前提到的一樣,函數(shù)inner可以訪問封閉的作用域(至少可以讀和修改)。在#2處,我們調(diào)用函數(shù)inner,非常重要的一點(diǎn)是,inner也僅僅是一個(gè)遵循python變量解析規(guī)則的變量名,python解釋器會(huì)優(yōu)先在outer的作用域里面對(duì)變量名inner查找匹配的變量.
7. 函數(shù)是python世界里的一級(jí)類對(duì)象
顯而易見,在python里函數(shù)和其他東西一樣都是對(duì)象。(此處應(yīng)該大聲歌唱)?。“兞康暮瘮?shù),你也并不是那么特殊!
>>> issubclass(int, object) # all objects in Python inherit from a common baseclass True >>> def foo(): ... pass >>> foo.__class__ # 1 <type 'function'> >>> issubclass(foo.__class__, object) True
你也許從沒有想過,你定義的函數(shù)居然會(huì)有屬性。沒辦法,函數(shù)在python里面就是對(duì)象,和其他的東西一樣,也許這樣描述會(huì)太學(xué)院派太官方了點(diǎn):在python里,函數(shù)只是一些普通的值而已和其他的值一毛一樣。這就是說你尅一把函數(shù)想?yún)?shù)一樣傳遞給其他的函數(shù)或者說從函數(shù)了里面返回函數(shù)!如果你從來沒有這么想過,那看看下面這個(gè)例子:
>>> def add(x, y): ... return x + y >>> def sub(x, y): ... return x - y >>> def apply(func, x, y): # 1 ... return func(x, y) # 2 >>> apply(add, 2, 1) # 3 3 >>> apply(sub, 2, 1) 1
這個(gè)例子對(duì)你來說應(yīng)該不會(huì)很奇怪。add和sub是非常普通的兩個(gè)python函數(shù),接受兩個(gè)值,返回一個(gè)計(jì)算后的結(jié)果值。在#1處你們能看到準(zhǔn)備接收一個(gè)函數(shù)的變量只是一個(gè)普通的變量而已,和其他變量一樣。在#2處我們調(diào)用傳進(jìn)來的函數(shù):“()代表著調(diào)用的操作并且調(diào)用變量包含的值。在#3處,你們也能看到傳遞函數(shù)并沒有什么特殊的語法?!?函數(shù)的名稱只是很其他變量一樣的表標(biāo)識(shí)符而已。
你們也許看到過這樣的行為:“python把頻繁要用的操作變成函數(shù)作為參數(shù)進(jìn)行使用,像通過傳遞一個(gè)函數(shù)給內(nèi)置排序函數(shù)的key參數(shù)從而來自定義排序規(guī)則。那把函數(shù)當(dāng)做返回值回事這樣的情況呢:
>>> def outer(): ... def inner(): ... print "Inside inner" ... return inner # 1 ... >>> foo = outer() #2 >>> foo <function inner at 0x...> >>> foo() Inside inner
這個(gè)例子看起來也許會(huì)更加的奇怪。在#1處我把恰好是函數(shù)標(biāo)識(shí)符的變量inner作為返回值返回出來。這并沒有什么特殊的語法:”把函數(shù)inner返回出來,否則它根本不可能會(huì)被調(diào)用到?!斑€記得變量的生存周期嗎?每次函數(shù)outer被調(diào)用的時(shí)候,函數(shù)inner都會(huì)被重新定義,如果它不被當(dāng)做變量返回的話,每次執(zhí)行過后它將不復(fù)存在。
在#2處我們捕獲住返回值 - 函數(shù)inner,將它存在一個(gè)新的變量foo里。我們能夠看到,當(dāng)對(duì)變量foo進(jìn)行求值,它確實(shí)包含函數(shù)inner,而且我們能夠?qū)λM(jìn)行調(diào)用。初次看起來可能會(huì)覺得有點(diǎn)奇怪,但是理解起來并不困難是吧。堅(jiān)持住,因?yàn)槠婀值霓D(zhuǎn)折馬上就要來了(嘿嘿嘿嘿,我笑的并不猥瑣?。?/p>
8. 閉包
我們先不急著定義什么是閉包,先來看看一段代碼,僅僅是把上一個(gè)例子簡(jiǎn)單的調(diào)整了一下:
>>> def outer(): ... x = 1 ... def inner(): ... print x # 1 ... return inner >>> foo = outer() >>> foo.func_closure (<cell at 0x...: int object at 0x...>,)
在上一個(gè)例子中我們了解到,inner作為一個(gè)函數(shù)被outer返回,保存在一個(gè)變量foo,并且我們能夠?qū)λM(jìn)行調(diào)用foo()。不過它會(huì)正常的運(yùn)行嗎?我們先來看看作用域規(guī)則。
所有的東西都在python的作用域規(guī)則下進(jìn)行工作:“x是函數(shù)outer里的一個(gè)局部變量。當(dāng)函數(shù)inner在#1處打印x的時(shí)候,python解釋器會(huì)在inner內(nèi)部查找相應(yīng)的變量,當(dāng)然會(huì)找不到,所以接著會(huì)到封閉作用域里面查找,并且會(huì)找到匹配。
但是從變量的生存周期來看,該怎么理解呢?我們的變量x是函數(shù)outer的一個(gè)本地變量,這意味著只有當(dāng)函數(shù)outer正在運(yùn)行的時(shí)候才會(huì)存在。根據(jù)我們已知的python運(yùn)行模式,我們沒法在函數(shù)outer返回之后繼續(xù)調(diào)用函數(shù)inner,在函數(shù)inner被調(diào)用的時(shí)候,變量x早已不復(fù)存在,可能會(huì)發(fā)生一個(gè)運(yùn)行時(shí)錯(cuò)誤。
萬萬沒想到,返回的函數(shù)inner居然能夠正常工作。Python支持一個(gè)叫做函數(shù)閉包的特性,用人話來講就是,嵌套定義在非全局作用域里面的函數(shù)能夠記住它在被定義的時(shí)候它所處的封閉命名空間。這能夠通過查看函數(shù)的func_closure屬性得出結(jié)論,這個(gè)屬性里面包含封閉作用域里面的值(只會(huì)包含被捕捉到的值,比如x,如果在outer里面還定義了其他的值,封閉作用域里面是不會(huì)有的)
記住,每次函數(shù)outer被調(diào)用的時(shí)候,函數(shù)inner都會(huì)被重新定義?,F(xiàn)在變量x的值不會(huì)變化,所以每次返回的函數(shù)inner會(huì)是同樣的邏輯,假如我們稍微改動(dòng)一下呢?
>>> def outer(x): ... def inner(): ... print x # 1 ... return inner >>> print1 = outer(1) >>> print2 = outer(2) >>> print1() 1 >>> print2() 2
從這個(gè)例子中你能夠看到閉包 - 被函數(shù)記住的封閉作用域 - 能夠被用來創(chuàng)建自定義的函數(shù),本質(zhì)上來說是一個(gè)硬編碼的參數(shù)。事實(shí)上我們并不是傳遞參數(shù)1或者2給函數(shù)inner,我們實(shí)際上是創(chuàng)建了能夠打印各種數(shù)字的各種自定義版本。
閉包單獨(dú)拿出來就是一個(gè)非常強(qiáng)大的功能, 在某些方面,你也許會(huì)把它當(dāng)做一個(gè)類似于面向?qū)ο蟮募夹g(shù):outer像是給inner服務(wù)的構(gòu)造器,x像一個(gè)私有變量。使用閉包的方式也有很多:你如果熟悉python內(nèi)置排序方法的參數(shù)key,你說不定已經(jīng)寫過一個(gè)lambda方法在排序一個(gè)列表的列表的時(shí)候基于第二個(gè)元素而不是第一個(gè)?,F(xiàn)在你說不定也可以寫一個(gè)itemgetter方法,接收一個(gè)索引值來返回一個(gè)完美的函數(shù),傳遞給排序函數(shù)的參數(shù)key。
不過,我們現(xiàn)在不會(huì)用閉包做這么low的事(⊙o⊙)…!相反,讓我們?cè)偎淮?,寫一個(gè)高大上的裝飾器!
9. 裝飾器
裝飾器其實(shí)就是一個(gè)閉包,把一個(gè)函數(shù)當(dāng)做參數(shù)然后返回一個(gè)替代版函數(shù)。我們一步步從簡(jiǎn)到繁來瞅瞅:
>>> def outer(some_func): ... def inner(): ... print "before some_func" ... ret = some_func() # 1 ... return ret + 1 ... return inner >>> def foo(): ... return 1 >>> decorated = outer(foo) # 2 >>> decorated() before some_func 2
仔細(xì)看看上面這個(gè)裝飾器的例子。們定義了一個(gè)函數(shù)outer,它只有一個(gè)some_func的參數(shù),在他里面我們定義了一個(gè)嵌套的函數(shù)inner。inner會(huì)打印一串字符串,然后調(diào)用some_func,在#1處得到它的返回值。在outer每次調(diào)用的時(shí)候some_func的值可能會(huì)不一樣,但是不管some_func的之如何,我們都會(huì)調(diào)用它。最后,inner返回some_func() + 1的值 - 我們通過調(diào)用在#2處存儲(chǔ)在變量decorated里面的函數(shù)能夠看到被打印出來的字符串以及返回值2,而不是期望中調(diào)用函數(shù)foo得到的返回值1。
我們可以認(rèn)為變量decorated是函數(shù)foo的一個(gè)裝飾版本,一個(gè)加強(qiáng)版本。事實(shí)上如果打算寫一個(gè)有用的裝飾器的話,我們可能會(huì)想愿意用裝飾版本完全取代原先的函數(shù)foo,這樣我們總是會(huì)得到我們的”加強(qiáng)版“foo。想要達(dá)到這個(gè)效果,完全不需要學(xué)習(xí)新的語法,簡(jiǎn)單地賦值給變量foo就行了:
>>> foo = outer(foo) >>> foo # doctest: +ELLIPSIS <function inner at 0x...>
現(xiàn)在,任何怎么調(diào)用都不會(huì)牽扯到原先的函數(shù)foo,都會(huì)得到新的裝飾版本的foo,現(xiàn)在我們還是來寫一個(gè)有用的裝飾器。
想象我們有一個(gè)庫,這個(gè)庫能夠提供類似坐標(biāo)的對(duì)象,也許它們僅僅是一些x和y的坐標(biāo)對(duì)。不過可惜的是這些坐標(biāo)對(duì)象不支持?jǐn)?shù)學(xué)運(yùn)算符,而且我們也不能對(duì)源代碼進(jìn)行修改,因此也就不能直接加入運(yùn)算符的支持。我們將會(huì)做一系列的數(shù)學(xué)運(yùn)算,所以我們想要能夠?qū)蓚€(gè)坐標(biāo)對(duì)象進(jìn)行合適加減運(yùn)算的函數(shù),這些方法很容易就能寫出:
>>> class Coordinate(object): ... def __init__(self, x, y): ... self.x = x ... self.y = y ... def __repr__(self): ... return "Coord: " + str(self.__dict__) >>> def add(a, b): ... return Coordinate(a.x + b.x, a.y + b.y) >>> def sub(a, b): ... return Coordinate(a.x - b.x, a.y - b.y) >>> one = Coordinate(100, 200) >>> two = Coordinate(300, 200) >>> add(one, two) Coord: {'y': 400, 'x': 400}
如果不巧我們的加減函數(shù)同時(shí)也需要一些邊界檢查的行為那該怎么辦呢?搞不好你只能夠?qū)φ淖鴺?biāo)對(duì)象進(jìn)行加減操作,任何返回的值也都應(yīng)該是正的坐標(biāo)。所以現(xiàn)在的期望是這樣:
>>> one = Coordinate(100, 200) >>> two = Coordinate(300, 200) >>> three = Coordinate(-100, -100) >>> sub(one, two) Coord: {'y': 0, 'x': -200} >>> add(one, three) Coord: {'y': 100, 'x': 0}
我們期望在不更改坐標(biāo)對(duì)象one, two, three的前提下one減去two的值是{x: 0, y: 0},one加上three的值是{x: 100, y: 200}。與其給每個(gè)方法都加上參數(shù)和返回值邊界檢查的邏輯,我們來寫一個(gè)邊界檢查的裝飾器!
>>> def wrapper(func): ... def checker(a, b): # 1 ... if a.x < 0 or a.y < 0: ... a = Coordinate(a.x if a.x > 0 else 0, a.y if a.y > 0 else 0) ... if b.x < 0 or b.y < 0: ... b = Coordinate(b.x if b.x > 0 else 0, b.y if b.y > 0 else 0) ... ret = func(a, b) ... if ret.x < 0 or ret.y < 0: ... ret = Coordinate(ret.x if ret.x > 0 else 0, ret.y if ret.y > 0 else 0) ... return ret ... return checker >>> add = wrapper(add) >>> sub = wrapper(sub) >>> sub(one, two) Coord: {'y': 0, 'x': 0} >>> add(one, three) Coord: {'y': 200, 'x': 100}
這個(gè)裝飾器能想先前的裝飾器例子一樣進(jìn)行工作,返回一個(gè)經(jīng)過修改的函數(shù),但是在這個(gè)例子中,它能夠?qū)瘮?shù)的輸入?yún)?shù)和返回值做一些非常有用的檢查和格式化工作,將負(fù)值的x和 y替換成0。
顯而易見,通過這樣的方式,我們的代碼變得更加簡(jiǎn)潔:將邊界檢查的邏輯隔離到單獨(dú)的方法中,然后通過裝飾器包裝的方式應(yīng)用到我們需要進(jìn)行檢查的地方。另外一種方式通過在計(jì)算方法的開始處和返回值之前調(diào)用邊界檢查的方法也能夠達(dá)到同樣的目的。但是不可置否的是,使用裝飾器能夠讓我們以最少的代碼量達(dá)到坐標(biāo)邊界檢查的目的。事實(shí)上,如果我們是在裝飾自己定義的方法的話,我們能夠讓裝飾器應(yīng)用的更加有逼格。
10. 使用 @ 標(biāo)識(shí)符將裝飾器應(yīng)用到函數(shù)
Python2.4支持使用標(biāo)識(shí)符@將裝飾器應(yīng)用在函數(shù)上,只需要在函數(shù)的定義前加上@和裝飾器的名稱。在上一節(jié)的例子里我們是將原本的方法用裝飾后的方法代替:
>>> add = wrapper(add)
這種方式能夠在任何時(shí)候?qū)θ我夥椒ㄟM(jìn)行包裝。但是如果我們自定義一個(gè)方法,我們可以使用@進(jìn)行裝飾:
>>> @wrapper ... def add(a, b): ... return Coordinate(a.x + b.x, a.y + b.y)
需要明白的是,這樣的做法和先前簡(jiǎn)單的用包裝方法替代原有方法是一毛一樣的, python只是加了一些語法糖讓裝飾的行為更加的直接明確和優(yōu)雅一點(diǎn)。
11. *args and **kwargs
我們已經(jīng)完成了一個(gè)有用的裝飾器,但是由于硬編碼的原因它只能應(yīng)用在一類具體的方法上,這類方法接收兩個(gè)參數(shù),傳遞給閉包捕獲的函數(shù)。如果我們想實(shí)現(xiàn)一個(gè)能夠應(yīng)用在任何方法上的裝飾器要怎么做呢?再比如,如果我們要實(shí)現(xiàn)一個(gè)能應(yīng)用在任何方法上的類似于計(jì)數(shù)器的裝飾器,不需要改變?cè)蟹椒ǖ娜魏芜壿?。這意味著裝飾器能夠接受擁有任何簽名的函數(shù)作為自己的被裝飾方法,同時(shí)能夠用傳遞給它的參數(shù)對(duì)被裝飾的方法進(jìn)行調(diào)用。
非常巧合的是Python正好有支持這個(gè)特性的語法??梢蚤喿x Python Tutorial 獲取更多的細(xì)節(jié)。當(dāng)定義函數(shù)的時(shí)候使用了*,意味著那些通過位置傳遞的參數(shù)將會(huì)被放在帶有*前綴的變量中, 所以:
>>> def one(*args): ... print args # 1 >>> one() () >>> one(1, 2, 3) (1, 2, 3) >>> def two(x, y, *args): # 2 ... print x, y, args >>> two('a', 'b', 'c') a b ('c',)
第一個(gè)函數(shù)one只是簡(jiǎn)單地講任何傳遞過來的位置參數(shù)全部打印出來而已,你們能夠看到,在代碼#1處我們只是引用了函數(shù)內(nèi)的變量args, *args僅僅只是用在函數(shù)定義的時(shí)候用來表示位置參數(shù)應(yīng)該存儲(chǔ)在變量args里面。Python允許我們制定一些參數(shù)并且通過args捕獲其他所有剩余的未被捕捉的位置參數(shù),就像#2處所示的那樣。
*操作符在函數(shù)被調(diào)用的時(shí)候也能使用。意義基本是一樣的。當(dāng)調(diào)用一個(gè)函數(shù)的時(shí)候,一個(gè)用*標(biāo)志的變量意思是變量里面的內(nèi)容需要被提取出來然后當(dāng)做位置參數(shù)被使用。同樣的,來看個(gè)例子:
>>> def add(x, y): ... return x + y >>> lst = [1,2] >>> add(lst[0], lst[1]) # 1 3 >>> add(*lst) # 2 3
#1處的代碼和#2處的代碼所做的事情其實(shí)是一樣的,在#2處,python為我們所做的事其實(shí)也可以手動(dòng)完成。這也不是什么壞事,*args要么是表示調(diào)用方法大的時(shí)候額外的參數(shù)可以從一個(gè)可迭代列表中取得,要么就是定義方法的時(shí)候標(biāo)志這個(gè)方法能夠接受任意的位置參數(shù)。
接下來提到的**會(huì)稍多更復(fù)雜一點(diǎn),**代表著鍵值對(duì)的參數(shù)字典,和*所代表的意義相差無幾,也很簡(jiǎn)單對(duì)不對(duì):
>>> def foo(**kwargs): ... print kwargs >>> foo() {} >>> foo(x=1, y=2) {'y': 2, 'x': 1}
當(dāng)我們定義一個(gè)函數(shù)的時(shí)候,我們能夠用**kwargs來表明,所有未被捕獲的關(guān)鍵字參數(shù)都應(yīng)該存儲(chǔ)在kwargs的字典中。如前所訴,argshe kwargs并不是python語法的一部分,但在定義函數(shù)的時(shí)候,使用這樣的變量名算是一個(gè)不成文的約定。和*一樣,我們同樣可以在定義或者調(diào)用函數(shù)的時(shí)候使用**。
>>> dct = {'x': 1, 'y': 2} >>> def bar(x, y): ... return x + y >>> bar(**dct) 3
12. 更通用的裝飾器
有了這招新的技能,我們隨隨便便就可以寫一個(gè)能夠記錄下傳遞給函數(shù)參數(shù)的裝飾器了。先來個(gè)簡(jiǎn)單地把日志輸出到界面的例子:
>>> def logger(func): ... def inner(*args, **kwargs): #1 ... print "Arguments were: %s, %s" % (args, kwargs) ... return func(*args, **kwargs) #2 ... return inner
請(qǐng)注意我們的函數(shù)inner,它能夠接受任意數(shù)量和類型的參數(shù)并把它們傳遞給被包裝的方法,這讓我們能夠用這個(gè)裝飾器來裝飾任何方法。
>>> @logger ... def foo1(x, y=1): ... return x * y >>> @logger ... def foo2(): ... return 2 >>> foo1(5, 4) Arguments were: (5, 4), {} 20 >>> foo1(1) Arguments were: (1,), {} 1 >>> foo2() Arguments were: (), {} 2
隨便調(diào)用我們定義的哪個(gè)方法,相應(yīng)的日志也會(huì)打印到輸出窗口,和我們預(yù)期的一樣。
總結(jié)
裝飾器的核心作用是name binding。這種語法是Python多編程范式的又一個(gè)體現(xiàn)。大部分Python用戶都不怎么需要定義裝飾器,但有可能會(huì)使用裝飾器。鑒于裝飾器在Python項(xiàng)目中的廣泛使用,了解這一語法是非常有益的。
相關(guān)文章
Python中摘要算法MD5,SHA1簡(jiǎn)介及應(yīng)用實(shí)例代碼
這篇文章主要介紹了Python中摘要算法MD5,SHA1簡(jiǎn)介及應(yīng)用實(shí)例代碼,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01對(duì)python添加模塊路徑的三種方法總結(jié)
今天小編就為大家分享一篇對(duì)python添加模塊路徑的三種方法總結(jié),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-10-10Tornado實(shí)現(xiàn)多進(jìn)程/多線程的HTTP服務(wù)詳解
這篇文章主要介紹了Tornado實(shí)現(xiàn)多進(jìn)程/多線程的HTTP服務(wù)詳解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值2019-07-07從Pytorch模型pth文件中讀取參數(shù)成numpy矩陣的操作
這篇文章主要介紹了從Pytorch模型pth文件中讀取參數(shù)成numpy矩陣的操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2021-03-03python實(shí)現(xiàn)畫五角星和螺旋線的示例
今天小編就為大家分享一篇python實(shí)現(xiàn)畫五角星和螺旋線的示例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2019-01-01教你Pycharm安裝使用requests第三方庫的詳細(xì)教程
PyCharm安裝第三方庫是十分方便的,無需pip或其他工具,平臺(tái)就自帶了這個(gè)功能而且操作十分簡(jiǎn)便,今天通過本文帶領(lǐng)大家學(xué)習(xí)Pycharm安裝使用requests第三方庫的詳細(xì)教程,感興趣的朋友一起看看吧2021-07-07