Python擴展之類的魔術方法
Python中類的魔術方法
在Python中以兩個下劃線開頭的方法，__init__、__str__、__doc__、__new__等，被稱爲"魔術方法"（Magic methods）。魔術方法在類或對象的某些事件出發後會自動執行，若是但願根據本身的程序定製本身特殊功能的類，那麼就須要對這些方法進行重寫。
注意：Python 將全部以 __（兩個下劃線）開頭的類方法保留爲魔術方法。因此在定義類方法時，除了上述魔術方法，建議不要以 __ 爲前綴。
一、Python提供的魔術方法html
魔術方法這裏按照不一樣的類別有以下分類：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進行返回。測試
一、基本的魔法方法spa
__repr__(self)：直接執行對象時執行的方法設計
>>> >>> class A: def __repr__(self): return '__repr__' >>> a = A() >>> a __repr__
_bool__(self)：判斷對象的bool值時執行的方法，返回值只能是bool類型code
>>> >>> class C: def __bool__(self): return False >>> c = C() >>> bool(c) False >>>
二、屬性相關的魔術方法orm
__getattr__(self,name)：獲取一個不存在的屬性時執行的方法。htm
__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__ >>>
ps.小技巧
在__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' >>>
三、屬性相關之property
咱們知道使用property能夠把，類的某些方法看成屬性進行訪問，賦值，修改的，而Property內部也是經過類的魔術方法實現的。
下面的三個屬性，主要用於在被看成其餘的類的屬性時使用的。
__set__(self,instance,value)：看成一個描述符(屬性)被賦值時執行的方法
__get__(self,instance,owner)：看成一個描述符(屬性)被獲取時執行的方法
__delete__(self,instance)：看成一個描述符(屬性)被刪除時執行的方法
什麼是看成一個描述符被訪問？
# 看成一個描述符被訪問的含義就是： # 一個函數在實例化的時候調用了其餘類的對象 >>> >>> class A: pass >>> class B: def __init__(self): self.name = A() # 把A類的對象在B實例化的時候看成描述符(屬性)進行賦值 >>>
>>> class A: def __get__(self,instance,owner): print('__get__','self:',self,'instance:',instance,'owner:',owner) def __set__(self,instance,value): print('__set__','self:',self,'instance:',instance,'value:',value) def __delete__(self,instance): print('__delete__','self:',self,'instance:',instance) >>> class B: name = A() >>> >>> b = B() >>> b.name __get__ self: <__main__.A object at 0x1134247f0> instance: <__main__.B object at 0x113411d68> owner: <class '__main__.B'> >>> b.name = 'abc' __set__ self: <__main__.A object at 0x1134247f0> instance: <__main__.B object at 0x113411d68> value: abc >>> del b.name __delete__ self: <__main__.A object at 0x1134247f0> instance: <__main__.B object at 0x113411d68> >>>
ps.擴展
因爲不知道魔術方法傳遞的參數都是什麼東西，因此在上面的例子打印了一下：
- self：表示的是當前類(擁有__set__,__get__等方法的類自己)
- instance：表示的是調用此類的類的實例化對象
- owner：表示調用此類的類
- value：表示要設置的值
根據這三個方法，那麼咱們徹底能夠定義本身的property屬性
class Myproperty: # 定義本身的Property def __init__(self,mget=None,mset=None,mdel=None): # 綁定三個修改方法 self.mget = mget self.mset = mset self.mdel = mdel def __get__(self,instance,owner): return self.mget(instance) def __set__(self,instance,value): return self.mset(instance,value) def __delete__(self,instance): return self.mdel(instance) class A: def __init__(self): self._x = None def setX(self,value): self._x = value def getX(self): try: if self._x: return self._x except AttributeError as e: print('Attribute is not exist') def delX(self): del self._x name = Myproperty(getX,setX,delX) >>> a = A() >>> a.name >>> a.name = 'daxin' >>> a.name 'daxin' >>> del a.name >>> a.name Attribute is not exist >>>
關於爲何在Myproperty中傳遞instance，那麼請注意咱們的setX，getX，默認有一個self參數，使用自定義Property的話，那麼咱們必須手動傳遞，在Myproperty類中instance表示對象本身，因此傳遞instance給setX/getX，其實等同於self。
六、運算符相關魔術方法
__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__' >>>
七、容器類
在Python中，列表、元組、字典和集合等等，這些均可以稱爲容器。
__getitem__：獲取容器中的元素,好比mylist[1]
__setitem__：設置容器中的元素,好比mylist[2] = 'hello'
__delitem__：刪除容器中的某個元素,好比 del mylist[2]
# 定義一個不可變的列表類型 # 記錄元素被訪問的次數 class Mylist: def __init__(self,*args): self.value = [ x for x in args ] # 列表生成式 self.count = {}.fromkeys(range(len(self.value)),0) # 定義字典用於按照索引統計訪問次數 def __getitem__(self,key): self.count[key] += 1 return self.value[key] def __repr__(self): return str(self.value) __str__ = __repr__ >>> a = Mylist(1,2,3,45) >>> a [1, 2, 3，45] >>> a.count {0: 0, 1: 0, 2: 0, 3: 0} >>> a[0] 1 >>> a.count {0: 1, 1: 0, 2: 0, 3: 0} >>> a[2] 3 >>> a.count {0: 1, 1: 0, 2: 1, 3: 0} >>> a[1] = 123
小練習
一、寫一個矩形的類，那麼這個類默認有長和寬兩個參數，當傳入一個叫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)
二、完成以下要求：
- 定製一個計時器類
- start和stop方法表明啓動和中止計時
- 假設計時器對象t1,定製t1對象直接執行和打印時的輸出信息
- 當計時器未啓動或已經中止計時，調用stop方法會給予舒適提示
- 兩個計時器對象能夠進行相加： t1 + t2
import time class Mytimer(): # 初始化 def __init__(self): self.prompt = 'Timer is not start' # 提示信息 self.start_time = None self.stop_time = None # 啓動定時器 def start(self): if self.start_time: print('Please Use Stop() to stop Timer') # 屬性存在，表示已經啓動計時 else: self.start_time = time.time() print('The start of Timer') # 關閉定時器 def stop(self): if self.start_time: self.stop_time = time.time() print('The stop of Timer') self._calc() else: print('Please Use Start() to start Timer') # 沒有執行start()，檢測不到屬性，進行提示 # 計算耗時 def _calc(self): self.prompt = 'Total time : ' self.end_time = self.stop_time - self.start_time self.prompt += str('{:.2f}'.format(self.end_time)) self.start_time = None self.stop_time = None # 直接執行對象時，打印提示信息 def __repr__(self): return self.prompt # 打印對象和執行對象相同 __str__ = __repr__ # 計時器相加 def __add__(self,other): self.prompt = 'All Time : ' add_time = self.end_time + other.end_time self.prompt += str('{:.2f}'.format(add_time)) return self.prompt
三、完成以下需求
- 定義一個溫度類，而後定義兩個描述符類用於描述攝氏度和華氏度兩個屬性。
- 兩個屬性會自定進行轉換，也就是說能夠給攝氏度這個屬性賦值，而後打印的華氏度屬性是自動轉換後的結果。
class Celsius: def __init__(self,value = 37): self.value = value def __set__(self,instance,value): self.value = value def __get__(self,instance,owner): return self.value class Fahrenheit: def __set__(self,instance,value): instance.cel = (float(value) - 32 ) / 1.8 def __get__(self,instance,owner): return instance.cel * 1.8 + 32 # 經過instance實例訪問，實例化後對象的cel屬性 class Temperature: cel = Celsius() fah = Fahrenheit() >>> a = Temperature() >>> a.cel 37 >>> a.fah 98.60000000000001 >>> a.fah = 100 >>> a.cel 37.77777777777778 >>>
PS：因爲instance表示的是實例化的對象自己(a),因此這裏使用instance，指代a，來訪問設置的cel屬性，來進行換算。
__repr__(self)：直接執行對象時執行的方法
|
1
2
3
4
5
6
7
8
|
>>>
>>>
class
A:
def
__repr__(
self
):
return
'__repr__'
>>> a
=
A()
>>> a
__repr__
|
__bool__(self)：判斷對象的bool值時執行的方法，返回值只能是bool類型
|
1
2
3
4
5
6
7
8
9
|
>>>
>>>
class
C:
def
__bool__(
self
):
return
False
>>> c
=
C()
>>>
bool
(c)
False
>>>
|
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
