Python魔法函数(特殊函数)

Python中如何实现运算符的重载，即实现例如a+b这样的运算符操作呢？

在C++中可以使用operator关键字实现运算符的重载。但是在Python中没有类似这样的关键字，所以要实现运算符的重载，就要用到Python的魔法函数。Python魔法函数是以双下划线开头，双下划线结尾的一组函数。我们在类定义中最常用到的__init__函数就是这样一个魔法函数，它在创建类对象时被自动调用。

下面我们来看个简单的例子。

#定义一个三维向量,实现加减等基本运算
class Vector3:
    def __init__(self,x,y,z):
        self.x = x
        self.y = y
        self.z = z
    
    # 重载 '+' 二元运算符（a+b）
    def __add__(self, other):
        return Vector3(self.x+other.x,self.y+other.y,self.z+other.z)
    
    # 重载 '-' 二元运算符(a-b)
    def __sub__(self, other):
        return Vector3(self.x-other.x,self.y-other.y,self.z-other.z)
    
    # 重载 '+=' 二元运算符 (a+=b)
    def __iadd__(self, other):
        self.x+=other.x
        self.y+=other.y
        self.z+=other.z
        return self
    
    # 重载 '-=' 二元运算符 (a-=b)
    def __isub__(self, other):
        self.x-=other.x
        self.y-=other.y
        self.z-=other.z
        return self
    
    ## 重载 '-' 一元运算符 (-a)
    def __neg__(self):
        return Vector3(-self.x,-self.y,-self.z)
    
    #重载 str()
    def __str__(self):
        return "[{},{},{}]".format(self.x,self.y,self.z)
    
    #重载 操作符'()'
    def __call__(self):
        print("{}({}, {}, {})".format(self.__class__.__name__,self.x,self.y,self.z))

v1 = Vector3(1,5,6)
v2 = Vector3(3,2,1)
v3 = Vector3(-1,0,1)

print("v1+v2 =",v1+v2) #输出结果： v1+v2= [4,7,7]
print("v1+v2+v3 =",v1+v2+v3) #输出结果： v1+v2+v3 = [3,7,8]
print("v1-v2 =",v1-v2) #输出结果： v1-v2= [-2,3,5]

v1+=v2
print("v1+=v2; v1 =",v1) #输出结果： v1+=v2; v1 = [4,7,7]

v1-=v2
print("v1-=v2; v1 =",v1) #输出结果： v1-=v2; v1 = [1,5,6]

print("-v1 =", -v1)   #输出结果： -v1 = [-1,-5,-6]

v1() #输出结果： Vector3(1, 5, 6)

上述代码示例了几个魔法函数的用法。__add__函数对应了二元运算符+，当执行a+b语句时，python就会自动调用a.add(b)。 对于上述例子中的v1+v2+v3，则相当于调用了(v1.add(v2)).add(v3)。

代码中还有一个在Python类定义经常使用的__str__函数，当使用str()时会被调用。print函数对传入的参数都调用了str()将其转换成易读的字符串形式，便于打印输出，因而会调用类定义的__str__函数打出自定义的字符串。

代码中还有一个特殊的__call__函数，该函数在将对象采用函数调用方式使用时被调用, 例如v1()相当于v1.call()。

以上就是魔法函数的基本使用方法。常见的魔法函数我们可以使用dir()函数来查看。

dir(v1)

输出结果为：

['__add__',
'__call__',
'__class__',
'__delattr__',
'__dict__',
'__dir__',
'__doc__',
'__eq__',
'__format__',
'__ge__',
'__getattribute__',
'__gt__',
'__hash__',
'__iadd__',
'__init__',
'__init_subclass__',
'__isub__',
'__le__',
'__lt__',
'__module__',
'__ne__',
'__neg__',
'__new__',
'__reduce__',
'__reduce_ex__',
'__repr__',
'__setattr__',
'__sizeof__',
'__str__',
'__sub__',
'__subclasshook__',
'__weakref__',
'x',
'y',
'z']

上述结果中形式为‘__函数名__’的函数为魔法函数，注意有些对象也是这种形式，例如__class__, __module__等, 这些不是魔法函数。具体的魔法函数说明可以参考Python官方说明文档。

以上代码在Python3.6运行通过.