?什么是魔法方法？

魔法方法(Magic Methods)是Python中的內(nèi)置函數(shù)，一般以雙下劃線(xiàn)開(kāi)頭和結(jié)尾，例如__init__、__del__等。之所以稱(chēng)之為魔法方法，是因?yàn)檫@些方法會(huì)在進(jìn)行特定的操作時(shí)會(huì)自動(dòng)被調(diào)用。

在Python中，可以通過(guò)dir()方法來(lái)查看某個(gè)對(duì)象的所有方法和屬性，其中雙下劃線(xiàn)開(kāi)頭和結(jié)尾的就是該對(duì)象的魔法方法。以字符串對(duì)象為例：

>>> 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']

可以看到字符串對(duì)象有__add__方法，所以在Python中可以直接對(duì)字符串對(duì)象使用"+"操作，當(dāng)Python識(shí)別到"+"操作時(shí)，就會(huì)調(diào)用該對(duì)象的__add__方法。有需要時(shí)我們可以在自己的類(lèi)中重寫(xiě)__add__方法來(lái)完成自己想要的效果。

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"

我們重寫(xiě)了__add__方法，當(dāng)Python識(shí)別"+"操作時(shí)，會(huì)自動(dòng)調(diào)用重寫(xiě)后的__add__方法。可以看到，魔法方法在類(lèi)或?qū)ο蟮哪承┦录霭l(fā)后會(huì)自動(dòng)執(zhí)行，如果希望根據(jù)自己的程序定制特殊功能的類(lèi)，那么就需要對(duì)這些方法進(jìn)行重寫(xiě)。使用魔法方法，我們可以非常方便地給類(lèi)添加特殊的功能。

常用的魔法方法

1.構(gòu)造與初始化

__new__、__init__ 這兩個(gè)魔法方法常用于對(duì)類(lèi)的初始化操作。上面我們創(chuàng)建a1 = A("hello")時(shí)，但首先調(diào)用的是__new__;初始化一個(gè)類(lèi)分為兩步:    

• a.調(diào)用該類(lèi)的new方法，返回該類(lèi)的實(shí)例對(duì)象  
• b.調(diào)用該類(lèi)的init方法，對(duì)實(shí)例對(duì)象進(jìn)行初始化

__new__(cls, *args, **kwargs)至少需要一個(gè)cls參數(shù)，代表傳入的類(lèi)。后面兩個(gè)參數(shù)傳遞給__init__。在__new__可以決定是否繼續(xù)調(diào)用__init__方法，只有當(dāng)__new__返回了當(dāng)前類(lèi)cls的實(shí)例，才會(huì)接著調(diào)用__init__。結(jié)合__new__方法的特性，我們可以通過(guò)重寫(xiě)__new__方法實(shí)現(xiàn)Python的單例模式：

class Singleton(object):
  def __init__(self):
      print("__init__")

?   def __new__(cls, *args, **kwargs):
?       print("__new__")
?       if not hasattr(Singleton, "_instance"):
?           print("創(chuàng)建新實(shí)例")
?           Singleton._instance = object.__new__(cls)
?       return Singleton._instance

>>> obj1 = Singleton()
>>> __new__
>>> 創(chuàng)建新實(shí)例
>>> __init__
>>> obj2 = Singleton()
>>> __new__
>>> __init__
>>> print(obj1, obj2)
>>> (<__main__.Singleton object at 0x0000000003599748>, <__main__.Singleton object at 0x0000000003599748>)

可以看到雖然創(chuàng)建了兩個(gè)對(duì)象，但兩個(gè)對(duì)象的地址相同。

2.控制屬性訪問(wèn)這類(lèi)魔法

方法主要對(duì)對(duì)象的屬性進(jìn)行訪問(wèn)、定義、修改時(shí)起作用。主要有：

• __getattr__(self, name): 定義當(dāng)用戶(hù)試圖獲取一個(gè)屬性時(shí)的行為。
• __getattribute__(self, name)：定義當(dāng)該類(lèi)的屬性被訪問(wèn)時(shí)的行為（先調(diào)用該方法，查看是否存在該屬性，若不存在，接著去調(diào)用getattr）。
• __setattr__(self, name, value)：定義當(dāng)一個(gè)屬性被設(shè)置時(shí)的行為。

當(dāng)初始化屬性時(shí)如self.a=a時(shí)或修改實(shí)例屬性如ins.a=1時(shí)本質(zhì)時(shí)調(diào)用魔法方法self.__setattr__(name,values)；當(dāng)實(shí)例訪問(wèn)某個(gè)屬性如ins.a本質(zhì)是調(diào)用魔法方法a.__getattr__(name)

3.容器類(lèi)操作

有一些方法可以讓我們自己定義自己的容器，就像Python內(nèi)置的List,Tuple,Dict等等；容器分為可變?nèi)萜骱筒豢勺內(nèi)萜鳌?/p>

如果自定義一個(gè)不可變?nèi)萜鞯脑?huà)，只能定義__len__和__getitem__；定義一個(gè)可變?nèi)萜鞒瞬豢勺內(nèi)萜鞯乃心Хǚ椒ǎ€需要定義__setitem__和__delitem__；如果容器可迭代。還需要定義__iter__。

• __len__(self):返回容器的長(zhǎng)度
•  __getitem__(self,key):當(dāng)需要執(zhí)行self[key]的方式去調(diào)用容器中的對(duì)象，調(diào)用的是該方法    __setitem__(self,key,value):當(dāng)需要執(zhí)行self[key] = value時(shí)，調(diào)用的是該方法
• __iter__(self):當(dāng)容器可以執(zhí)行 for x in container:，或者使用iter(container)時(shí)，需要定義該方法

下面舉一個(gè)例子，實(shí)現(xiàn)一個(gè)容器，該容器有List的一般功能，同時(shí)增加一些其它功能如訪問(wèn)第一個(gè)元素，最后一個(gè)元素,記錄每個(gè)元素被訪問(wèn)的次數(shù)等。

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):  # 通過(guò)len(obj)訪問(wèn)容器長(zhǎng)度
        return len(self.values)

    def __getitem__(self, key):  # 通過(guò)obj[key]訪問(wèn)容器內(nèi)的對(duì)象
        self.count[key] += 1
        return self.values[key]

    def __setitem__(self, key, value):  # 通過(guò)obj[key]=value去修改容器內(nèi)的對(duì)象
        self.values[key] = value

    def __iter__(self):  # 通過(guò)for 循環(huán)來(lái)遍歷容器
        return iter(self.values)

    def __next__(self):
        # 迭代的具體細(xì)節(jié)
        # 如果__iter__返回時(shí)self 則必須實(shí)現(xiàn)此方法
        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):
        # 獲取第一個(gè)元素
        return self.values[0]
    
    def last(self):
        # 獲取最后一個(gè)元素
        return self.values[-1]

 這類(lèi)方法的使用場(chǎng)景主要在你需要定義一個(gè)滿(mǎn)足需求的容器類(lèi)數(shù)據(jù)結(jié)構(gòu)時(shí)會(huì)用到，比如可以嘗試自定義實(shí)現(xiàn)樹(shù)結(jié)構(gòu)、鏈表等數(shù)據(jù)結(jié)構(gòu)（在collections中均已有），或者項(xiàng)目中需要定制的一些容器類(lèi)型。

總結(jié)

魔法方法在Python代碼中能夠簡(jiǎn)化代碼，提高代碼可讀性，在常見(jiàn)的Python第三方庫(kù)中可以看到很多對(duì)于魔法方法的運(yùn)用。因此當(dāng)前這篇文章僅是拋磚引玉，真正的使用需要在開(kāi)源的優(yōu)秀源碼中以及自身的工程實(shí)踐中不斷加深理解并合適應(yīng)用。