@classmethod與@staticmethod的區(qū)別
Python面向?qū)ο缶幊讨?,類中定義的方法可以是 @classmethod 裝飾的類方法,也可以是 @staticmethod 裝飾的靜態(tài)方法,用的最多的還是不帶裝飾器的實例方法,如果把這幾個方法放一塊,對初學(xué)者來說無疑是一頭霧水,那我們該如何正確地使用它們呢?
先來看一個簡單示例:
- class A(object):
- def m1(self, n):
- print("self:", self)
- @classmethod
- def m2(cls, n):
- print("cls:", cls)
- @staticmethod
- def m3(n):
- pass
- a = A()
- a.m1(1) # self: <__main__.A object at 0x000001E596E41A90>
- A.m2(1) # cls: <class '__main__.A'>
- A.m3(1)
我在類中一共定義了3個方法,m1 是實例方法,***個參數(shù)必須是 self(約定俗成的)。m2 是類方法,***個參數(shù)必須是cls(同樣是約定俗成),m3 是靜態(tài)方法,參數(shù)根據(jù)業(yè)務(wù)需求定,可有可無。當(dāng)程序運行時,大概發(fā)生了這么幾件事(結(jié)合下面的圖來看)。
- ***步:代碼從***行開始執(zhí)行 class 命令,此時會創(chuàng)建一個類 A 對象(沒錯,類也是對象,一切皆對象嘛)同時初始化類里面的屬性和方法,記住,此刻實例對象還沒創(chuàng)建出來。
- 第二、三步:接著執(zhí)行 a=A(),系統(tǒng)自動調(diào)用類的構(gòu)造器,構(gòu)造出實例對象 a
- 第四步:接著調(diào)用 a.m1(1) ,m1 是實例方法,內(nèi)部會自動把實例對象傳遞給 self 參數(shù)進行綁定,也就是說, self 和 a 指向的都是同一個實例對象。
- 第五步:調(diào)用A.m2(1)時,python內(nèi)部隱式地把類對象傳遞給 cls 參數(shù),cls 和 A 都指向類對象。
嚴格意義上來說,左邊的都是變量名,是對象的引用,右邊才是真正的對像,為了描述方便,我直接把 a 稱為對象,你應(yīng)該明白我說對象其實是它所引用右邊的那個真正的對象。
再來看看每個方法各有什么特性。
實例方法
- print(A.m1)
- # A.m1在py2中顯示為<unbound method A.m1>
- <function A.m1 at 0x000002BF7FF9A488>
- print(a.m1)
- <bound method A.m1 of <__main__.A object at 0x000002BF7FFA2BE0>>
A.m1是一個還沒有綁定實例對象的方法,對于未綁定方法,調(diào)用 A.m1 時必須顯示地傳入一個實例對象進去,而 a.m1是已經(jīng)綁定了實例的方法,python隱式地把對象傳遞給了self參數(shù),所以不再手動傳遞參數(shù),這是調(diào)用實例方法的過程。
- A.m1(a, 1)
- # 等價
- a.m1(1)
如果未綁定的方法 A.m1 不傳實例對象給 self 時,就會報參數(shù)缺失錯誤,在 py3 與 py2 中,兩者報的錯誤不一致,python2 要求***個參數(shù)self是實例對象,而python3中可以是任意對象。
- A.m1(1)
- TypeError: m1() missing 1 required positional argument: 'n'
類方法
- print(A.m2)
- <bound method A.m2 of <class '__main__.A'>>
- print(a.m2)
- <bound method A.m2 of <class '__main__.A'>>
m2是類方法,不管是 A.m2 還是 a.m2,都是已經(jīng)自動綁定了類對象A的方法,對于后者,因為python可以通過實例對象a找到它所屬的類是A,找到A之后自動綁定到 cls。
- A.m2(1)
- # 等價
- a.m2(1)
這使得我們可以在實例方法中通過使用 self.m2()這種方式來調(diào)用類方法和靜態(tài)方法。
- def m1(self, n):
- print("self:", self)
- self.m2(n)
靜態(tài)方法
- print(A.m3)
- <function A.m3 at 0x000002BF7FF9A840>
- print(a.m3)
- <function A.m3 at 0x000002BF7FF9A840>
m3是類里面的一個靜態(tài)方法,跟普通函數(shù)沒什么區(qū)別,與類和實例都沒有所謂的綁定關(guān)系,它只不過是碰巧存在類中的一個函數(shù)而已。不論是通過類還是實例都可以引用該方法。
- A.m3(1)
- # 等價
- a.m3(1)
以上就是幾個方法的基本介紹?,F(xiàn)在把幾個基本的概念理清楚了,那么現(xiàn)在來說說幾個方法之間的使用場景以及他們之間的優(yōu)缺點。
應(yīng)用場景
靜態(tài)方法的使用場景:
如果在方法中不需要訪問任何實例方法和屬性,純粹地通過傳入?yún)?shù)并返回數(shù)據(jù)的功能性方法,那么它就適合用靜態(tài)方法來定義,它節(jié)省了實例化對象的開銷成本,往往這種方法放在類外面的模塊層作為一個函數(shù)存在也是沒問題的,而放在類中,僅為這個類服務(wù)。
例如下面是微信公眾號開發(fā)中驗證微信簽名的一個例子,它沒有引用任何類或者實例相關(guān)的屬性和方法。
- from hashlib import sha1
- import tornado.web
- class SignatureHandler(tornado.web.RequestHandler):
- def get(self):
- """
- 根據(jù)簽名判斷請求是否來自微信
- """
- if self._check_sign(TOKEN, timestamp, nonce, signature):
- self.write(echostr)
- else:
- self.write("你不是微信發(fā)過來的請求")
- @staticmethod
- def _check_sign(token, timestamp, nonce, signature):
- sign = [token, timestamp, nonce]
- sign.sort()
- sign = "".join(sign)
- sign = sha1(sign).hexdigest()
- return sign == signature
類方法的使用場景有:
作為工廠方法創(chuàng)建實例對象,例如內(nèi)置模塊 datetime.date 類中就有大量使用類方法作為工廠方法,以此來創(chuàng)建date對象。
- class date:
- def __new__(cls, year, month=None, day=None):
- self = object.__new__(cls)
- self._year = year
- self._month = month
- self._day = day
- return self
- @classmethod
- def fromtimestamp(cls, t):
- y, m, d, * = _time.localtime(t)
- return cls(y, m, d)
- @classmethod
- def today(cls):
- t = _time.time()
- return cls.fromtimestamp(t)
如果希望在方法裡面調(diào)用靜態(tài)類,那么把方法定義成類方法是合適的,因為要是定義成靜態(tài)方法,那么你就要顯示地引用類A,這對繼承來說可不是一件好事情。
- class A:
- @staticmethod
- def m1()
- pass
- @staticmethod
- def m2():
- A.m1() # bad
- @classmethod
- def m3(cls):
- cls.m1() # good
其實也不算是什么深入理解吧,最多算是明白怎么用,真要深入理解恐怕還要另寫一篇文章,有興趣的可以去了解一下Python的描述符。
【本文是51CTO專欄作者“劉志軍”的原創(chuàng)文章,作者微信公眾號:Python之禪(VTtalk)】