Clarify Three Types of Method in Python

在 Python 中， Method 被呼叫的方式有三種，Instance, Class, Static 其中 Class Method 跟一般我們用物件導向程式語言溝通有別，參考 RealPython 撰寫的文章釐清差異

Instance Method

• 可以直接存取被實例化(New)出來後的實體(Instance)本身所有屬性(Property)

• 其中 Instance Method 的第一個參數需傳入 self

• 可看成: 能夠任意修改 Object 的 State 狀態

Class Method

• 使用 @classmethod Decorator

• 其中 Class Method 的第一個參數需傳入 cls

• 代表會指向整個 Class Instance 而不是 Object Instace

• 可看成: 能夠任意修改 Class 的 State，並套用到所有相同的類別實體

Static Method

• 使用 @staticmethod Decorator

• 其中 Static Method 的第一個參數不需傳入， 不用 cls, 也不用 self

• 故可看成: 既不能修改 Class State，也不能修改 Object state

• Static Method 用來限制能存取的資料

使用範例

Instance Method

>>> obj = MyClass()
>>> obj.method()
('instance method called', <MyClass instance at 0x101a2f4c8>)

使用 Instance Method 是透過 self 來操作 New 出來的 Object 本身 當 .method() 被呼叫的時候，Python 會自動把原先定義的第一個參數 self 自動改成 obj 也就是這個 Object 本身

故如果手動轉入 obj 本身，也會得到一樣的結果

>>> MyClass.method(obj)
('instance method called', <MyClass instance at 0x101a2f4c8>)

BTW, Instance Method 是可以透過 self.__class__ 屬性來存取 Class 本身的喔

代表可以同時操作 Object State 也能越級操作 Class State

Class Method

>>> obj.classmethod()
('class method called', <class MyClass at 0x101a2f4c8>)

Class Mtehod 被呼叫時與 Instance Method 相同， 當 MyClass.classmethod() 被呼叫的時候，Python 會自動把整個 Class 傳入原先定義的第一個參數 cls 其中糖衣作(dot syntax trigger)用與 Instance Method 被呼叫時雷同

PS. self, cls 只是命名，也可以用 _object, _class，但其實還是遵照 self, cls 大家都看得懂

Staic Method

>>> obj.staticmethod()
'static method called'

其實背後，一樣也是透過糖衣(dot syntax)呼叫 Staic Method，Python 只是不幫你傳入 Class 或是 Object 而已 。其用意如文起所及，為了限制被存取的資料與屬性而生

關鍵重點 Key Takeaways

• Instance Method
  • 最常見的物件導向觀念，需要建立整個 Class Instance 並且可以透過 self 存取 Instance 本身 data 和 properties
• Class Method
  • 不需要 Class Instance，無法透過 self 存取 Instance，但可以使用 cls 存取 Class 本身的 data 和 properies
• Static Method 無法使用 self, cls 存取 data 和 properties。操作有如一般的 function 但屬於 Class 的 Namespace

進階了解 Class Method 應用實例，可以參考 RealPython - Delicious Pizza Factories With @classmethod

其他參考資料 - Instance vs. Static vs. Class Methods in Python: The Important Differences