Python 類的魔術方法
Python中類的魔術方法
在Python中以兩個下劃線開頭的方法,__init__、__str__、__doc__、__new__等,被稱為"魔術方法"(Magic methods)。魔術方法在類或對象的某些事件出發後會自動執行,如果希望根據自己的程序定制自己特殊功能的類,那麽就需要對這些方法進行重寫。 註意:Python 將所有以 __(兩個下劃線)開頭的類方法保留為魔術方法。所以在定義類方法時,除了上述魔術方法,建議不要以 __ 為前綴。Python提供的魔術方法
魔術方法這裏按照不同的類別有如下分類:
魔法方法 | 含義 |
基本的魔法方法 | |
__new__(cls[, ...]) |
1. __new__ 是在一個對象實例化的時候所調用的第一個方法 2. 它的第一個參數是這個類,其他的參數是用來直接傳遞給 __init__ 方法 3. __new__ 決定是否要使用該 __init__ 方法,因為 __new__ 可以調用其他類的構造方法或者直接返回別的實例對象來作為本類的實例,如果 __new__ 沒有返回實例對象,則 __init__ 不會被調用 4. __new__ 主要是用於繼承一個不可變的類型比如一個 tuple 或者 string |
__init__(self[, ...]) | 構造器,當一個實例被創建的時候調用的初始化方法 |
__del__(self) |
析構器,當一個實例被銷毀的時候調用的方法 |
__call__(self[, args...]) | 允許一個類的實例像函數一樣被調用:x(a, b) 調用 x.__call__(a, b) |
__len__(self) | 定義當被 len() 調用時的行為 |
__repr__(self) | 定義當被 repr() 調用或者直接執行對象時的行為 |
__str__(self) | 定義當被 str() 調用或者打印對象時的行為 |
__bytes__(self) | 定義當被 bytes() 調用時的行為 |
__hash__(self) |
定義當被 hash() 調用時的行為 |
__bool__(self) | 定義當被 bool() 調用時的行為,應該返回 True 或 False |
__format__(self, format_spec) | 定義當被 format() 調用時的行為 |
有關屬性 | |
__getattr__(self, name) | 定義當用戶試圖獲取一個不存在的屬性時的行為 |
__getattribute__(self, name) | 定義當該類的屬性被訪問時的行為 |
__setattr__(self, name, value) | 定義當一個屬性被設置時的行為 |
__delattr__(self, name) | 定義當一個屬性被刪除時的行為 |
__dir__(self) | 定義當 dir() 被調用時的行為 |
__get__(self, instance, owner) | 定義當描述符的值被取得時的行為 |
__set__(self, instance, value) | 定義當描述符的值被改變時的行為 |
__delete__(self, instance) | 定義當描述符的值被刪除時的行為 |
比較操作符 | |
__lt__(self, other) | 定義小於號的行為:x < y 調用 x.__lt__(y) |
__le__(self, other) | 定義小於等於號的行為:x <= y 調用 x.__le__(y) |
__eq__(self, other) | 定義等於號的行為:x == y 調用 x.__eq__(y) |
__ne__(self, other) | 定義不等號的行為:x != y 調用 x.__ne__(y) |
__gt__(self, other) | 定義大於號的行為:x > y 調用 x.__gt__(y) |
__ge__(self, other) | 定義大於等於號的行為:x >= y 調用 x.__ge__(y) |
算數運算符 | |
__add__(self, other) | 定義加法的行為:+ |
__sub__(self, other) | 定義減法的行為:- |
__mul__(self, other) | 定義乘法的行為:* |
__truediv__(self, other) | 定義真除法的行為:/ |
__floordiv__(self, other) | 定義整數除法的行為:// |
__mod__(self, other) | 定義取模算法的行為:% |
__divmod__(self, other) | 定義當被 divmod() 調用時的行為 |
__pow__(self, other[, modulo]) | 定義當被 power() 調用或 ** 運算時的行為 |
__lshift__(self, other) | 定義按位左移位的行為:<< |
__rshift__(self, other) | 定義按位右移位的行為:>> |
__and__(self, other) | 定義按位與操作的行為:& |
__xor__(self, other) | 定義按位異或操作的行為:^ |
__or__(self, other) | 定義按位或操作的行為:| |
反運算 | |
__radd__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rsub__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rmul__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rtruediv__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rfloordiv__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rmod__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rdivmod__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rpow__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rlshift__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rrshift__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rand__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__rxor__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
__ror__(self, other) | (與上方相同,當左操作數不支持相應的操作時被調用) |
增量賦值運算 | |
__iadd__(self, other) | 定義賦值加法的行為:+= |
__isub__(self, other) | 定義賦值減法的行為:-= |
__imul__(self, other) | 定義賦值乘法的行為:*= |
__itruediv__(self, other) | 定義賦值真除法的行為:/= |
__ifloordiv__(self, other) | 定義賦值整數除法的行為://= |
__imod__(self, other) | 定義賦值取模算法的行為:%= |
__ipow__(self, other[, modulo]) | 定義賦值冪運算的行為:**= |
__ilshift__(self, other) | 定義賦值按位左移位的行為:<<= |
__irshift__(self, other) | 定義賦值按位右移位的行為:>>= |
__iand__(self, other) | 定義賦值按位與操作的行為:&= |
__ixor__(self, other) | 定義賦值按位異或操作的行為:^= |
__ior__(self, other) | 定義賦值按位或操作的行為:|= |
一元操作符 | |
__pos__(self) | 定義正號的行為:+x |
__neg__(self) | 定義負號的行為:-x |
__abs__(self) | 定義當被 abs() 調用時的行為 |
__invert__(self) | 定義按位求反的行為:~x |
類型轉換 | |
__complex__(self) | 定義當被 complex() 調用時的行為(需要返回恰當的值) |
__int__(self) | 定義當被 int() 調用時的行為(需要返回恰當的值) |
__float__(self) | 定義當被 float() 調用時的行為(需要返回恰當的值) |
__round__(self[, n]) | 定義當被 round() 調用時的行為(需要返回恰當的值) |
__index__(self) | 1. 當對象是被應用在切片表達式中時,實現整形強制轉換 2. 如果你定義了一個可能在切片時用到的定制的數值型,你應該定義 __index__ 3. 如果 __index__ 被定義,則 __int__ 也需要被定義,且返回相同的值 |
上下文管理(with 語句) | |
__enter__(self) | 1. 定義當使用 with 語句時的初始化行為 2. __enter__ 的返回值被 with 語句的目標或者 as 後的名字綁定 |
__exit__(self, exc_type, exc_value, traceback) | 1. 定義當一個代碼塊被執行或者終止後上下文管理器應該做什麽 2. 一般被用來處理異常,清除工作或者做一些代碼塊執行完畢之後的日常工作 |
容器類型 | |
__len__(self) | 定義當被 len() 調用時的行為(返回容器中元素的個數) |
__getitem__(self, key) | 定義獲取容器中指定元素的行為,相當於 self[key] |
__setitem__(self, key, value) | 定義設置容器中指定元素的行為,相當於 self[key] = value |
__delitem__(self, key) | 定義刪除容器中指定元素的行為,相當於 del self[key] |
__iter__(self) | 定義當叠代容器中的元素的行為 |
__reversed__(self) | 定義當被 reversed() 調用時的行為 |
__contains__(self, item) | 定義當使用成員測試運算符(in 或 not in)時的行為 |
Python的魔術方法舉例
這裏僅針對常用的魔術方法進行舉例,便於理解及靈活運用,部分魔術方法已經在:這篇博客中舉例說明
小技巧:如果在需要返回對象的魔術方法裏面不知道如何返回,可以調用super函數來執行父類的相同方法。
註意:魔法方法必須要使用return進行返回。
基本的魔法方法
__repr__(self):直接執行對象時執行的方法
>>> >>> class A: def __repr__(self): return ‘__repr__‘ >>> a = A() >>> a __repr__
__bool__(self):判斷對象的bool值時執行的方法,返回值只能是bool類型
>>> >>> class C: def __bool__(self): return False >>> c = C() >>> bool(c) False >>>
屬性相關的魔術方法
__getattr__(self,name):獲取一個不存在的屬性時執行的方法。
__setattr__(self,name,value):設置一個屬性時執行的方法。
__delattr__(self,name):刪除一個屬性時執行的方法。
__getattribute__(self,name):當該類的屬性被訪問時執行的方法。
>>> class A: def __getattr__(self,name): print(‘__getattr__‘) def __setattr__(self,name,value): print(‘__setattr__‘) super().__setattr__(name,value) def __delattr__(self,name): print(‘__delattr__‘) return super().__delattr__(name) def __getattribute__(self,name): print(‘__getattribute__‘) return super().__getattribute__(name) >>> a = A() >>> a.name __getattribute__ __getattr__ >>> a.name = ‘daxin‘ __setattr__ >>> a.name __getattribute__ ‘daxin‘ >>> del a.name __delattr__ >>>
註意
1、__getattribute__,先於__getattr__訪問
2、__getattr__,沒有在父類中進行定義,所以不能繼承
3、__setattr__,為設置屬性,所以無需return
3、在__setattr__時,不能直接使用self.name = value ,會造成死循環,因為在執行self.name = value的時候又會調用本身,無限循環下去
小技巧
在__setattr__的時候,除了使用super的方式設置變量和值以外,還可以使用__dict__來設置。(建議使用super的方法)
>>> class A: def __getattr__(self,name): print(‘__getattr__‘) def __setattr__(self,name,value): print(‘__setattr__‘) self.__dict__[name] = value def __delattr__(self,name): print(‘__delattr__‘) return super().__delattr__(name) def __getattribute__(self,name): print(‘__getattribute__‘) return super().__getattribute__(name) >>> a = A() >>> a.name __getattribute__ __getattr__ >>> a.name = ‘daxin‘ __setattr__ __getattribute__ >>> a.name __getattribute__ ‘daxin‘ >>>
運算符相關魔術方法
__add__:在執行加法時執行的方法
>>> class A(int): def __add__(self,other): print(‘__add__‘) return super().__sub__(other) # 這裏改寫了 add方法,調用了父類的減法 >>> a = A(8) >>> a + 6 __add__ 2 >>>
__radd__:當左邊的對象沒有__add__方法時,執行右邊對象的__radd__方法
>>> class A: pass >>> class B(int): def __radd__(self,other): return ‘I am B,because right object not have __add__‘ >>> >>> a = A() >>> b = B(12) >>> a + b ‘I am B,because right object not have __add__‘ >>>
小練習
光看這麽多的魔術方法,難免會很頭痛,那麽就以兩個小例子來看下該怎麽用
1、寫一個矩形的類,那麽這個類默認有長和寬兩個參數,當傳入一個叫square的屬性時,值就等於邊長,由於是正方形那麽長和寬就等於邊長。
class Rectangle(object): # init object def __init__(self,width,height): self.width = width self.height = height def getacreage(self): return self.width * self.height def __setattr__(self,name,value): if name == ‘square‘: self.width = value self.height = value else: super().__setattr__(name,value)
Python 類的魔術方法