84、Python之鸭子类型：魔术方法&自定义类型也可以实现加减乘除

引言

上一篇文章中，我们简单聊了通过定义魔术方法，自定义类型也可以像内置的整型、浮点型等一样，也能进行比较运算。今天，我们接着聊运算符重载的话题，通过魔术方法实现自定义类型四则运算的功能。

需要说明的是，虽然，我们一直在用“运算符重载”这个名词，实际上是C++等编程语言中的技术，Java中虽然支持函数重载，但是也不支持运算符重载，所以很难实现类似于内置类型的操作。Python虽然没有运算符重载的功能，但是，魔术方法实现了运算符重载同样的功能。

本文的主要内容有：

1、算术运算符的分类

2、算术运算相关的魔术方法

3、自定义类型实现算术运算操作

算术运算符的分类

算术运算符常见的分类方法有如下几种：

1、按照参与运算的对象个数，可以分为一元运算符和二元运算符。

2、按照真正调用方法的对象来看，二元运算符中，又可以分为正向运算（左侧对象真正调用方法）和反向运算（右侧对象真正调用方法）。

3、按照运算符的结果来看，又可以分为普通运算符（不可变操作对象本身）和增量运算符（改变操作对象本身）。

这不同的算术运算符，在Python中都有对应的魔术方法，我们在实际业务中，可以根据操作的需要，自由选择实现其中某个或者某几个的组合。

算术运算相关的魔术方法

下面简单列举一下Python中关于算术运算相关的魔术方法。

首先是正向的运算符所对应的魔术方法：

1、__add__(self, other)：正向加法运算。

2、__sub__(self, other)：正向减法运算。

3、__mul__(self, other)：正向乘法运算。

4、__truediv__(self, other)：正向除法运算。

5、__floordiv__(self, other)：正向地板除法运算。

6、__mod__(self, other)：正向取模运算。

7、__pow__(self, other)：正向幂运算。

其次是反向运算符所对应的魔术方法：

1、__radd__(self, other)：反向加法运算。

2、__rsub__(self, other)：反向减法运算。

3、__rmul__(self, other)：反向乘法运算。

4、__rtruediv__(self, other)：反向除法运算。

5、__rfloordiv__(self, other)：反向地板除法运算。

6、__rmod__(self, other)：反向取模运算。

7、__rpow__(self, other)：反向幂运算。

可以看到，每个反向运算符对应的魔术方法，都是正向方法前面多了一个前缀r，表示“reverse”。

然后是增量运算符（原地运算）所对应的魔术方法：

1、__iadd__(self, other)：增量加法运算。

2、__isub__(self, other)：增量减法运算。

3、__imul__(self, other)：增量乘法运算。

4、__itruediv__(self, other)：增量除法运算。

5、__ifloordiv__(self, other)：增量地板除法运算。

6、__imod__(self, other)：增量取模运算。

7、__ipow__(self, other)：增量幂运算。

可以看到，每个增量运算符的魔术方法，前面的前缀都是i，表示inplace的意思。

最后再来看一下，一元操作符所对应的魔术方法：

1、__neg__(self)：只有一个参数，用于实现-self。

2、__pos__(self)：只有一个参数，用于实现+self。

3、__invert__(self)：只有一个参数，用于实现~self。

自定义类型实现算术运算操作

接下来，简单通过代码演示一下几个常见的算术运算相关的魔术方法的使用。

直接看代码：

class Vector:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    # 正向加
    def __add__(self, other):
        if isinstance(other, self.__class__):
            return self.__class__(self.x + other.x, self.y + other.y)
        if isinstance(other, tuple) and len(other) == 2:
            return self.__class__(self.x + other[0], self.y + other[1])
        raise NotImplemented

    # 反向减
    def __rsub__(self, other):
        if isinstance(other, self.__class__):
            return self.__class__(other.x - self.x, other.y - self.y)
        if isinstance(other, tuple) and len(other) == 2:
            return self.__class__(other[0] - self.x, other[1] - self.y)
        raise NotImplemented

    # 原地加
    def __iadd__(self, other):
        if isinstance(other, self.__class__):
            self.x += other.x
            self.y += other.y
            return self
        raise NotImplemented

    # 一元运算
    def __neg__(self):
        return self.__class__(-self.x, -self.y)

    def __str__(self):
        return f'Vector({self.x}, {self.y})'


if __name__ == '__main__':
    v1 = Vector(10, 20)
    print(v1)
    v2 = Vector(100, 200)
    print(v2)
    v3 = v1 + v2
    print(v3)
    v4 = v1 + (1, 2)
    print(v4)
    v5 = -v2
    print(v5)
    v5 += v1
    print(v5)

运行结果：

总结

本文简单介绍了算术运算符的分类，比如：一元运算符、二元运算符、增量运算符、反向运算符等。然后，又列举了常见的算术运算符对应的魔术方法。最后通过一个向量类的实例，演示了算术运算符相关魔术方法的使用。

感谢您的拨冗阅读，希望对您有所帮助！