一文了解 Python 的 「Magic」 方法

在之前的文章中，我聊過了Python的 __getitem__ 和 __setitem__ 方法。這些方法被稱爲「魔法」方法、特殊方法或者dunger方法(譯者：國內書籍用「魔法」一詞較多)。那麼，什麼是魔法方法呢？這正是今天咱們要說的內容。

P.S.你會再一次的深深的愛上Python語言。

也將是一篇較長的文章，來讓咱們開始。

魔法方法到底是什麼？

魔法方法是一種具備特殊魅力的正常方法。Python經過這些魔法方法能夠賦予你的class魔力。這些魔法方法都是以雙下劃線（__）做爲前綴和後綴。坦率的講，其實這些方法並無什麼魔法，另外這些方法這Python的文檔中也沒有較爲詳細的介紹，所以，今天咱們就來詳細的看一看這些方法。

魔法方法之初始化

全部的Python開發者都知道，__init__()是一個類(class)的第一個方法，也能夠叫作構造函數。雖然，__init__()方法是第一個被建立的，可是它卻不是第一個被調用的執行的，__new__()方法纔是最先被調用的方法。

• __new__()方法：先讀取參數，如：類名稱，args，和kwargs。而後，__new__()方法把這些參數傳遞給對類名稱的__init__()方法。 語法：__new__(class_name, args, kwargs)
• __init__()方法：是類的初始化方法或構造方法，這也幾乎用於全局的初始化目的。 語法：__init__(self, args, kwargs)
• __del__()方法：類的析構函數。切記，這並非定義del x，而是定義了一個對象被垃圾回收的行爲。 語法：__del__(self)

看一個例子：

class SimpleInit(object): ''' Class to initialize a list with a value ''' def __init__(self, value=10): self._list = [value] def __del__(self): del self._list

魔法方法之算術運算

算術運算是很是常見的，所以，若是你想建立屬於本身的數據結構，魔法方法會使你的實現更容易。例如：咱們能夠像這樣，some_list + some_list2，實現Python的列表（list）拼接。相似這種的有趣行爲，咱們能夠經過魔法方法的算術運算實現定義。

• __add__(self, other) 定義加法 (+)
• __sub__(self, other) 定義減法 (-)
• __mul__(self, other) 定義乘法 (*)
• __floordiv__(self, other) 定義整除法 (//)
• __div__(self, other) 定義浮點型除法 (/)
• __mod__(self, other) 定義取餘模運算 (%)
• __and__(self, other) 定義按位與 (&)
• __or__(self, other) 定義按位或 (|)
• __xor__(self, other) 定義按位異或 (^)
• __pow__(self, other) 定義指數運算 (**)
• __lshift__(self, other) 定義按位左移 (<<)
• __rshift__(self, other) 定義按位右移 (>>)

例如：

class SimpleAdder(object): def __init__(self, elements=[]): self._list = elements def __add__(self, other): return self._list + other._list def __str__(self): return str(self._list) a = SimpleAdder(elements=[1,2,3,4])b = SimpleAdder(elements=[2, 3, 4])print(a + b) # [1, 2, 3, 4, 2, 3, 4]

魔法方法之增量賦值

Python不只容許咱們定義算術運算，也容許咱們定義增量賦值運算。若是你不知道什麼是增量賦值是什麼？那麼咱們來看一個簡單的例子：

x = 5 x += 1 # This first adds 5 and 1 and then assigns it back to 'x'

所以有的時候，你可能想寫一些自自定義邏輯實現增量賦值操做。魔法方法支持的運算符有：

• __iadd__(self, other) 定義加法 (+=)
• __isub__(self, other) 定義減法 (-=)
• __imul__(self, other) 定義乘法 (*=)
• __ifloordiv__(self, other) 定義整除法 (//=)
• __idiv__(self, other) 定義浮點型除法 (/=)
• __imod__(self, other) 定義取模運算 (%=)
• __iand__(self, other) 定義按位與 (&=)
• __ior__(self, other) 定義按位或 (|=)
• __ixor__(self, other) 定義按位異或(^=)
• __ipow__(self, other) 定義指數運算 (**=)
• __ilshift__(self, other) 定義按位左移 (<<=)
• __irshift__(self, other) 定義按位右移 (>>=)

 

魔法方法之比較運算

Python有一組普遍的魔術方法實現比較。咱們能夠覆蓋默認的比較行爲，來定義使用對象的引用方法。下面是比較魔法方法的列表：

• __eq__(self, other) 幫助檢查兩個對象的相等。它定義了相等運算 (==)
• __ne__(self, other) 定義了不等運算 (!=)
• __lt__(self, other) 定義了小於運算 (<)
• __gt__(self, other) 定義了大於運算 (>)
• __le__(self, other) 定義了小於等於運算 (<=)
• __ge__(self, other) 定義了大於等於運算 (>=)

例如:

class WordCounter(object): ''' Simple class to count number of words in a sentence ''' def __init__(self, sentence): # split the sentence on ' ' if type(sentence) != str: raise TypeError('The sentence should be of type str and not {}'.format(type(sentence))) self.sentence = sentence.split(' ') self.count = len(self.sentence) def __eq__(self, other_class_name): ''' Check the equality w.r.t length of the list with other class ''' return self.count == other_class_name.count def __lt__(self, other_class_name): ''' Check the less-than w.r.t length of the list with other class ''' return self.count < other_class_name.count def __gt__(self, other_class_name): ''' Check the greater-than w.r.t length of the list with other class ''' return self.count > other_class_name.count word = WordCounter('Omkar Pathak')print(word.count)

魔法方法之類型轉換

不少時候開發人員須要隱性的轉換變量類型，來知足最要想要的結果。Python是關心你內在數據的類型的一種動態類型語言，除此以外，Python也關心你，哈哈！若是你想要自定義屬於本身的方法，能夠藉助以下方法：

• __int__(self) 定義類型轉化爲 int
• __long__(self) 定義類型轉化爲 long
• __float__(self) 定義類型轉化爲 float
• __complex__(self) 定義類型轉化爲 complex（複數）
• __oct__(self) 定義類型轉化爲 octal（八進制）
• __hex__(self) 定義類型轉化爲 （十六進制）
• __index__(self) 定義類型轉化爲一種int， 當對象被用於切片表達式（ a slice expression）時

 

最經常使用的魔法方法

這裏有一些魔法方法你應該常常遇到：

• __str__(self) 定義了str()行爲。例如,當你調用print(object_name)，不管object_name是什麼都會被__str__()執行
• __repr__(self) 定義了repr()行爲。這個很大程度上相似於__str__()。這兩個之間的主要區別是,str()主要是人類可讀的和repr()是機器可讀的
• __hash__(self) 定義了行爲調用hash()
• __len__(self) 返回容器的長度
• __getitem__(self) 和 __setitem__(self). 更多內容能夠詳見我之前的博客文章。
• __delitem__(self, key) 定義了一個刪除一個項目的行爲. 例如, del _list[3]
• __iter__(self) 返回一個迭代容器

class CustomList(object): def __init__(self, elements=0): self.my_custom_list = [0] * elements def __str__(self): return str(self.my_custom_list) def __setitem__(self, index, value): self.my_custom_list[index] = value def __getitem__(self, index): return "Hey you are accessing {} element whose value is: {}".format(index, self.my_custom_list[index]) def __iter__(self): return iter(self.my_custom_list)obj = CustomList(12)obj[0] = 1print(obj[0])print(obj)

把這些有魔法的Python禮物送給你！！

coding 快樂！