python 中的self和cls

python 中的self和cls

一句話描述：self是類（Class）實例化對象，cls就是類（或子類）本身，取決於調用的是那個類。
@staticmethod 屬於靜態方法裝飾器，@classmethod屬於類方法裝飾器。我們需要從聲明和使用兩個方面來理解。

詳細介紹

一般來說，要使用某個類的方法，需要先⚠️實例化一個對象再調用方法。而使用@staticmethod或@classmethod，就可以不需要實例化，直接類名.方法名()來調用。這有利於組織代碼，把某些應該屬於某個類的函數給放到那個類裏去，同時有利於命名空間的整潔。🤔

首先定義一個類A，類A中有三個函數，foo1爲靜態函數，用@staticmethod裝飾器裝飾，這種方法與類有某種關係但不需要使用到實例或者類來參與。

class A(object):
    a = 'a'
    @staticmethod
    def foo1(name):
        print('hello', name, A.a)
    def foo2(self, name):
        print('hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello', name, cls.a)
class B(A):
    a = 'b'
    @staticmethod
    def foo1(name):
        print('hello', name, B.a)
    def foo2(self, name):
        print('subclass B')
        print('hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello', name, cls.a)

如下兩種方法都可以正常輸出，也就是說

既可以作爲類的方法使用，也可以作爲類的實例的方法使用。

a = A()
b = B()
a.foo1("小熊貓") # hello 小熊貓 
A.foo1("小熊貓") # hello 小熊貓 
b.foo1("大熊貓") # subclass B， hello 大熊貓 b
B.foo1("大熊貓") # subclass B， hello 大熊貓 b

foo2爲正常的函數，是類的實例的函數，調用方式如下。

將實參實例化對象或者類名稱傳入self對象，取到不同的屬性和方法。

a.foo2("小熊貓") # hello 小熊貓 a
A.foo2(a, "小熊貓") # hello 小熊貓 a
A.foo2(b, "小熊貓") # hello 小熊貓 b
A.foo2(A, "小熊貓") # hello 小熊貓 a 
A.foo2(B, "小熊貓") # hello 小熊貓 b
B.foo2(a, "小熊貓") # subclass B， hello 小熊貓 a

foo3爲類函數，cls作爲第一個參數用來表示類本身. 在類方法中用到，類方法是隻與類本身有關而與實例無關的方法。如下兩種方法都可以正常輸出。

可以看出，傳入形參cls的值爲前面的調用函數，如果再傳入對象或者類名稱，會報類型錯誤，多傳了一個參數。

a.foo3("小熊貓")
A.foo3("小熊貓")
# a.foo3(a, "小熊貓") # TypeError: foo3() takes 2 positional arguments but 3 were given
# A.foo3(A, "小熊貓") # TypeError: foo3() takes 2 positional arguments but 3 were given
b.foo3("大熊貓")
B.foo3("大熊貓")

@staticmethod和@classmethod的用法

相同：

• @staticmethod和@classmethod都可以直接類名.方法名()來調用

區別：

• 從它們的使用上來看,@staticmethod不需要表示自身對象的self和自身類的cls參數，就跟使用函數一樣。@classmethod也不需要self參數，但第一個參數是調用類方法的類。
• 如果在@staticmethod中要調用到這個類的一些屬性方法，只能直接類名.屬性名或類名.方法名。
• 而@classmethod因爲持有cls參數，可以來調用類的屬性，類的方法，實例化對象等，避免硬編碼。

class A(object):
    a = 'a'
    @staticmethod
    def foo1(name):
        print('hello foo1', name, A.a)
        print("hello foo4 ", B.foo2(B, "小熊貓"))
    def foo2(self, name):
        print('hello foo2', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('hello foo3', name, cls.a)
        print("hello foo5", cls().foo2(name))
        print("hello foo6", cls().foo1(name))
class B(A):
    a = 'b'
    @staticmethod
    def foo1(name):
        print('subclass B， hello', name, B.a)
    def foo2(self, name):
        print('subclass B， hello', name, self.a)
    @classmethod
    def foo3(cls, name):
        print('subclass B， hello', name, cls.a)

重點應關注@staticmethod和@classmethod調用本類或其他類的函數和屬性的區別

例子1：

關鍵看第二句 subclass B， hello 小熊貓 b，在調用 B.foo2(B, “小熊貓”) 時，執行了B類型下的foo2()方法，該方法無返回值，因此 下句輸出爲 hello foo4 None

a = A()
a.foo1("小熊貓")
# 輸出
hello foo1 小熊貓 a
subclass B， hello 小熊貓 b
hello foo4  None

例子2：

a.foo3("小熊貓")
# 輸出
hello foo3 小熊貓 a
hello foo2 小熊貓 a
hello foo5 None
hello foo1 小熊貓 a
subclass B， hello 小熊貓 b
hello foo4  None
hello foo6 None

最後一個小例子

class A(object):
    @classmethod
    def acquire(cls, param):
        if cls is A:
            raise Exception("只有子類才能調用！！！")
        return "類 a %r 的參數爲 %r" % (cls, param)

class B(A):
    pass

class C(A):
    pass

print(B.acquire("小熊貓"))
print(C.acquire("大熊貓"))
print(A.acquire("愛喫竹子"))
# 結果
類 a <class '__main__.B'> 的參數爲 '小熊貓'
類 a <class '__main__.C'> 的參數爲 '大熊貓'
Exception: 只有子類才能調用！！！