11个Python开发者必会的魔术方法（上）

大家好，在Python中，魔术方法可以帮助模拟内置函数在Python类中的行为。这些方法的名称前后都有双下划线（__），因此也被称为双下划线（dunder）方法。

这些魔术方法还可以帮助在Python中实现运算符重载。简单列举一些常见的例子，比如使用乘法运算符*将两个整数相乘得到乘积，而将它与一个字符串和一个整数k结合使用时，则会将该字符串重复k次：

 >>> 3 * 4
12
>>> 'code' * 3
'codecodecode'

这里我们将通过创建一个简单的二维向量Vector2D类来探索Python中的魔术方法。

1、__init__

考虑以下的Vector2D类：

class Vector2D:
    pass

当创建一个类并实例化一个对象时，可以像这样添加属性：obj_name.attribute_name = value。

不过与其在创建的每个实例中手动添加属性，还不如在实例化对象时用一种方法来初始化这些属性。

为此，我们可以定义__init__方法，接下来让我们为Vector2D类定义__init__方法：

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

v = Vector2D(3, 5)

2、__repr__

当你尝试检查或打印实例化的对象时，会发现并没有得到任何有用的信息。

v = Vector2D(3, 5)
print(v)

Output >>> <__main__.Vector2D object at 0x7d2fcfaf0ac0>

这就是为什么应该添加一个表示字符串，即对象的字符串表示形式。为此，可以添加一个__repr__方法，如下所示：

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

    def __repr__(self):
        return f"Vector2D(x={self.x}, y={self.y})"

v = Vector2D(3, 5)
print(v)

Output >>> Vector2D(x=3, y=5)

__repr__应包含创建类的实例所需的所有属性和信息，__repr__方法通常用于调试。

3、__str__

__str__也用于添加对象的字符串表示形式，一般来说，__str__方法用于向类的最终用户提供信息。接下来为我们的类添加一个__str__方法：

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

    def __str__(self):
        return f"Vector2D(x={self.x}, y={self.y})"

v = Vector2D(3, 5)
print(v)

Output >>> Vector2D(x=3, y=5)

如果没有__str__的实现，它就会回退到__repr__。因此，对于你创建的每个类，至少应该添加一个__repr__方法。

4、__eq__

接下来，让我们添加一个方法来检查任意两个Vector2D类的对象是否相等。如果两个向量对象具有完全相同的x和y坐标，则它们是相等的。

现在创建两个x和y坐标值均相等的Vector2D对象，并比较它们是否相等：

v1 = Vector2D(3, 5)
v2 = Vector2D(3, 5)
print(v1 == v2)

结果是False。因为默认情况下，“比较”会检查的是内存中对象的ID是否相等。

Output >>> False

接下来添加__eq__方法来检查是否相等：

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

    def __repr__(self):
        return f"Vector2D(x={self.x}, y={self.y})"

    def __eq__(self, other):
        return self.x == other.x and self.y == other.y

现在，相等性检查应该可以按预期工作：

v1 = Vector2D(3, 5)
v2 = Vector2D(3, 5)
print(v1 == v2)

Output >>> True 

5、__len__

Python的内置len()函数可以帮助计算内置可迭代对象的长度，对于一个向量来说，长度应该返回向量包含的元素数量。

因此，为Vector2D类添加一个__len__方法：

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

    def __repr__(self):
        return f"Vector2D(x={self.x}, y={self.y})"

    def __len__(self):
        return 2

v = Vector2D(3, 5)
print(len(v))

所有的Vector2D类对象的长度都是2：

Output >>> 2

本文已经介绍了5个Python开发者必会的魔术方法，截下来我们将在下一文中继续讲解剩下的6个魔术方法。