聊聊Python中常見魔法方法
?什么是魔法方法？
魔法方法(Magic Methods)是Python中的內置函數，一般以雙下劃線開頭和結尾，例如__init__、__del__等。之所以稱之為魔法方法，是因為這些方法會在進行特定的操作時會自動被調用。
在Python中，可以通過dir()方法來查看某個對象的所有方法和屬性，其中雙下劃線開頭和結尾的就是該對象的魔法方法。以字符串對象為例：
>>> dir("hello")
['__add__', '__class__', '__contains__', '__delattr__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__',
'__getitem__', '__getnewargs__', '__getslice__', '__gt__', '__hash__', '__init__', '__le__', '__len__', '__lt__', '__mo
d__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__rmod__', '__rmul__', '__setattr__',
'__sizeof__', '__str__', '__subclasshook__', '_formatter_field_name_split', '_formatter_parser', 'capitalize', 'center',
'count', 'decode', 'encode', 'endswith', 'expandtabs', 'find', 'format', 'index', 'isalnum', 'isalpha', 'isdigit', 'isl
ower', 'isspace', 'istitle', 'isupper', 'join', 'ljust', 'lower', 'lstrip', 'partition', 'replace', 'rfind', 'rindex', '
rjust', 'rpartition', 'rsplit', 'rstrip', 'split', 'splitlines', 'startswith', 'strip', 'swapcase', 'title', 'translate'
, 'upper', 'zfill']
可以看到字符串對象有__add__方法，所以在Python中可以直接對字符串對象使用"+"操作，當Python識別到"+"操作時，就會調用該對象的__add__方法。有需要時我們可以在自己的類中重寫__add__方法來完成自己想要的效果。
class A(object):
def __init__(self, str):
self.str = str
? def __add__(self, other):
? print ('overwrite add method')
? return self.str + "---" + other.str
>>>a1 = A("hello")
>>>a2 = A("world")
>>>print (a1 + a2)
>>>overwrite add method
>>>"hello---world"
我們重寫了__add__方法，當Python識別"+"操作時，會自動調用重寫后的__add__方法。可以看到，魔法方法在類或對象的某些事件出發后會自動執行，如果希望根據自己的程序定制特殊功能的類，那么就需要對這些方法進行重寫。使用魔法方法，我們可以非常方便地給類添加特殊的功能。
常用的魔法方法
1.構造與初始化
__new__、__init__ 這兩個魔法方法常用于對類的初始化操作。上面我們創建a1 = A("hello")時，但首先調用的是__new__;初始化一個類分為兩步:
- a.調用該類的new方法，返回該類的實例對象
- b.調用該類的init方法，對實例對象進行初始化
__new__(cls, *args, **kwargs)至少需要一個cls參數，代表傳入的類。后面兩個參數傳遞給__init__。在__new__可以決定是否繼續調用__init__方法，只有當__new__返回了當前類cls的實例，才會接著調用__init__。結合__new__方法的特性，我們可以通過重寫__new__方法實現Python的單例模式：
class Singleton(object):
def __init__(self):
print("__init__")
? def __new__(cls, *args, **kwargs):
? print("__new__")
? if not hasattr(Singleton, "_instance"):
? print("創建新實例")
? Singleton._instance = object.__new__(cls)
? return Singleton._instance
>>> obj1 = Singleton()
>>> __new__
>>> 創建新實例
>>> __init__
>>> obj2 = Singleton()
>>> __new__
>>> __init__
>>> print(obj1, obj2)
>>> (<__main__.Singleton object at 0x0000000003599748>, <__main__.Singleton object at 0x0000000003599748>)
可以看到雖然創建了兩個對象，但兩個對象的地址相同。
2.控制屬性訪問這類魔法
方法主要對對象的屬性進行訪問、定義、修改時起作用。主要有：
- __getattr__(self, name): 定義當用戶試圖獲取一個屬性時的行為。
- __getattribute__(self, name)：定義當該類的屬性被訪問時的行為（先調用該方法，查看是否存在該屬性，若不存在，接著去調用getattr）。
- __setattr__(self, name, value)：定義當一個屬性被設置時的行為。
當初始化屬性時如self.a=a時或修改實例屬性如ins.a=1時本質時調用魔法方法self.__setattr__(name,values)；當實例訪問某個屬性如ins.a本質是調用魔法方法a.__getattr__(name)
3.容器類操作
有一些方法可以讓我們自己定義自己的容器，就像Python內置的List,Tuple,Dict等等；容器分為可變容器和不可變容器。
如果自定義一個不可變容器的話，只能定義__len__和__getitem__；定義一個可變容器除了不可變容器的所有魔法方法，還需要定義__setitem__和__delitem__；如果容器可迭代。還需要定義__iter__。
- __len__(self):返回容器的長度
- __getitem__(self,key):當需要執行self[key]的方式去調用容器中的對象，調用的是該方法 __setitem__(self,key,value):當需要執行self[key] = value時，調用的是該方法
- __iter__(self):當容器可以執行 for x in container:，或者使用iter(container)時，需要定義該方法
下面舉一個例子，實現一個容器，該容器有List的一般功能，同時增加一些其它功能如訪問第一個元素，最后一個元素,記錄每個元素被訪問的次數等。
class SpecialList(object):
def __init__(self, values=None):
self._index = 0
if values is None:
self.values = []
else:
self.values = values
self.count = {}.fromkeys(range(len(self.values)), 0)
def __len__(self): # 通過len(obj)訪問容器長度
return len(self.values)
def __getitem__(self, key): # 通過obj[key]訪問容器內的對象
self.count[key] += 1
return self.values[key]
def __setitem__(self, key, value): # 通過obj[key]=value去修改容器內的對象
self.values[key] = value
def __iter__(self): # 通過for 循環來遍歷容器
return iter(self.values)
def __next__(self):
# 迭代的具體細節
# 如果__iter__返回時self 則必須實現此方法
if self._index >= len(self.values):
raise StopIteration()
value = self.values[self._index]
self._index += 1
return value
def append(self, value):
self.values.append(value)
def head(self):
# 獲取第一個元素
return self.values[0]
def last(self):
# 獲取最后一個元素
return self.values[-1]
這類方法的使用場景主要在你需要定義一個滿足需求的容器類數據結構時會用到，比如可以嘗試自定義實現樹結構、鏈表等數據結構（在collections中均已有），或者項目中需要定制的一些容器類型。
總結
魔法方法在Python代碼中能夠簡化代碼，提高代碼可讀性，在常見的Python第三方庫中可以看到很多對于魔法方法的運用。因此當前這篇文章僅是拋磚引玉，真正的使用需要在開源的優秀源碼中以及自身的工程實踐中不斷加深理解并合適應用。
