Python 模拟数字类型特殊方法

说明

《Python 教程》持续更新中，提供建议、纠错、催更等加作者微信: gr99123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》和《Python之光》。

要模拟Python中数字类型的特殊方法，你可以创建一个自定义类，并实现这些特殊方法。这些特殊方法包括__add__()、__sub__()、__mul__()、__truediv__()、__floordiv__() 等，它们分别用于实现对象的加法、减法、乘法、真除法、地板除法等操作。

规则

当你在Python中定义一个类，并希望模拟数字类型的行为时，你可以通过实现一系列特殊方法来实现这个目标。下面是对每个方法的简要介绍：

__add__(self, other): 实现对象与另一个对象的加法操作。当你对对象执行 ``obj1 + obj2 时调用
__sub__(self, other): 实现对象与另一个对象的减法操作。当你对对象执行 `obj1 - obj2 时调用
__mul__(self, other): 实现对象与另一个对象的乘法操作。当你对对象执行 `obj1 * obj2 时调用
__matmul__(self, other): 实现对象与另一个对象的矩阵乘法操作。当你对对象执行 obj1 @ obj2 时调用。这个方法在Python 3.5版本中引入。
__truediv__(self, other): 实现对象与另一个对象的真除法操作。当你对对象执行 obj1 / obj2 时调用。
__floordiv__(self, other): 实现对象与另一个对象的地板除法操作。当你对对象执行 obj1 // obj2 时调用。
__mod__(self, other): 实现对象与另一个对象的模操作（取余数）。当你对对象执行 obj1 % obj2 时调用。
__divmod__(self, other): 实现对象与另一个对象的除法操作，并返回商和余数的元组。当你对对象执行 divmod(obj1, obj2) 时调用。
__pow__(self, other[, modulo]): 实现对象的幂运算操作。当你对对象执行 obj1 ** obj2 时调用。可选的 modulo 参数表示取模运算。
__lshift__(self, other): 实现对象与另一个对象的左移位操作。当你对对象执行 obj1 << obj2 时调用。
__rshift__(self, other): 实现对象与另一个对象的右移位操作。当你对对象执行 obj1 >> obj2 时调用。
__and__(self, other): 实现对象与另一个对象的按位与操作。当你对对象执行 obj1 & obj2 时调用。
__xor__(self, other): 实现对象与另一个对象的按位异或操作。当你对对象执行 obj1 ^ obj2 时调用
__or__(self, other): 实现对象与另一个对象的按位或操作。当你对对象执行 obj1 | obj2 时调用

通过实现这些特殊方法，你可以自定义对象在与数值运算时的行为，从而使其表现得像内置的数字类型一样。

调用这些方法来实现双目算术运算 (+, -, *, @, /, //, %, divmod(), pow(), **, <<, >>, &, ^, |)。例如，求表达式 x + y 的值，其中 x 是具有 __add__() 方法的类的一个实例，则会调用 type(x).__add__(x, y)。 __divmod__() 方法应该等价于使用 __floordiv__() 和 __mod__()；它不应该被关联到 __truediv__()。请注意如果要支持三目版本的内置 pow() 函数则 __pow__() 应当被定义为接受可选的第三个参数。

如果这些方法中的某一个不支持与所提供参数进行运算，它应该返回 NotImplemented 。

示例

这些特殊方法用于定义对象的运算行为，例如加法、减法、乘法等。以下是每个方法的一个简单示例及其注释：

class MyClass:
    def __init__(self, value):
        self.value = value

    def __add__(self, other):
        return self.value + other.value  # 定义加法操作

    def __sub__(self, other):
        return self.value - other.value  # 定义减法操作

    def __mul__(self, other):
        return self.value * other.value  # 定义乘法操作

    def __truediv__(self, other):
        return self.value / other.value  # 定义真除法操作

    def __floordiv__(self, other):
        return self.value // other.value  # 定义整除操作

    def __mod__(self, other):
        return self.value % other.value  # 定义取模操作

    def __divmod__(self, other):
        return divmod(self.value, other.value)  # 定义取商和余数操作

    def __pow__(self, other, modulo=None):
        return pow(self.value, other.value, modulo)  # 定义乘方操作

    def __lshift__(self, other):
        return self.value << other.value  # 定义左移操作

    def __rshift__(self, other):
        return self.value >> other.value  # 定义右移操作

    def __and__(self, other):
        return self.value & other.value  # 定义按位与操作

    def __xor__(self, other):
        return self.value ^ other.value  # 定义按位异或操作

    def __or__(self, other):
        return self.value | other.value  # 定义按位或操作

# 示例用法
a = MyClass(5)
b = MyClass(3)

print(a + b)  # 输出 8
print(a - b)  # 输出 2
print(a * b)  # 输出 15
print(a / b)  # 输出 1.6666666666666667
print(a // b)  # 输出 1
print(a % b)  # 输出 2
print(divmod(a, b))  # 输出 (1, 2)
print(pow(a, b))  # 输出 125
print(a ** b)  # 输出 125
print(a << b)  # 输出 40
print(a >> b)  # 输出 0
print(a & b)  # 输出 1
print(a ^ b)  # 输出 6
print(a | b)  # 输出 7

示例中，我们定义了一个类 MyClass，并实现了这些特殊方法来定义对象之间的不同运算操作。

参考

https://docs.python.org/zh-cn/3/reference/datamodel.html#emulating-numeric-types

< `__contains__()` 实现成员检测 Python 的特殊方法 `__radd__()` 反向数字运算符特殊方法 >

更新时间：2024-03-05 08:35:18 标签：python 特殊方法数字