在 Python 开发中，有一类特殊的方法被称为 "魔术方法"（Magic Methods），它们通过双下划线命名（如__init__、__str__），在类的定义中实现特定的功能逻辑。这些方法并非 Python 的 "黑魔法"，而是框架设计者为开发者预留的标准化接口 —— 掌握它们，能让你写出更符合 Pythonic 规范的代码，显著提升类的实用性和代码效率。

对于中高级开发者而言，魔术方法是突破编码瓶颈的关键：自定义数据结构时需要__getitem__实现索引访问，处理资源管理要靠__enter__/__exit__构建上下文管理器，就连日常调试中__repr__方法都能让对象打印信息更易读。本次分享精选开发者高频使用的 10 个核心魔术方法，涵盖对象生命周期管理、容器操作、运算符重载等核心场景，无论是优化现有代码还是实现复杂功能，都能从中找到实用解决方案。

一、init：初始化对象的魔法钥匙

__init__方法是 Python 中最常用的魔术方法之一，它在创建对象时被自动调用，用于初始化对象的属性。可以说，它是对象诞生的 "第一站"，为对象的初始状态奠定基础。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

person = Person("Alice", 30)
print(person.name)  # 输出: Alice
print(person.age)   # 输出: 30

在这个例子中，我们定义了一个Person类，__init__方法接收name和age两个参数，并将它们赋值给对象的属性。当我们创建Person对象时，__init__方法会自动执行，完成对象的初始化。

注意事项

• __init__方法的第一个参数必须是self，它代表对象本身。

• 在__init__方法中，可以对对象的属性进行各种初始化操作，包括设置默认值、进行类型检查等。

二、str：让对象开口说话

__str__方法用于定义对象的字符串表示，当我们使用print()函数输出对象时，会调用该方法返回的字符串。它的作用是让对象以一种友好、易读的方式展示自己。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __str__(self):
        return f"Person(name={self.name}, age={self.age})"

person = Person("Bob", 25)
print(person)  # 输出: Person(name=Bob, age=25)

如果我们不定义__str__方法，当打印对象时，默认会输出对象的内存地址，这对于调试和用户来说都不友好。而定义了__str__方法后，对象就有了自己的 "语言"，能够清晰地表达自己的状态。

注意事项

• __str__方法的返回值应该是一个简洁明了的字符串，能够准确描述对象的状态。

• 尽量让__str__方法的输出对用户友好，方便调试和日志记录。

三、repr：开发者的调试利器

__repr__方法也是用于定义对象的字符串表示，但它主要用于开发和调试阶段，其返回值应该是一个可以准确重现对象的字符串。也就是说，通过__repr__方法返回的字符串，应该能够重新创建出该对象。

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __repr__(self):
        return f"Person('{self.name}', {self.age})"

person = Person("Charlie", 35)
print(repr(person))  # 输出: Person('Charlie', 35)

在 Python 解释器中，当我们直接输入对象并回车时，显示的就是__repr__方法返回的字符串。它对于开发者来说非常重要，能够帮助我们快速了解对象的状态和创建方式。

与__str__的区别

• __str__方法的目标是给用户看的，注重易读性；__repr__方法的目标是给开发者看的，注重准确性和重现性。

• 如果没有定义__str__方法，会默认使用__repr__方法的返回值。

四、len：告诉世界你的长度

__len__方法用于定义对象的长度，当我们使用len()函数获取对象的长度时，会调用该方法。它在集合类对象中非常常见，比如列表、字典、字符串等，我们自定义的对象也可以通过实现__len__方法来支持len()函数。

class MyList:
    def __init__(self, data):
        self.data = data

    def __len__(self):
        return len(self.data)

my_list = MyList([1, 2, 3, 4, 5])
print(len(my_list))  # 输出: 5

通过实现__len__方法，我们的自定义对象就具备了和内置集合类对象一样的行为，使用起来更加方便和直观。

应用场景

• 自定义的集合类对象，如列表、集合、字典等。

• 需要表示对象包含元素数量的场景。

五、getitem：让对象支持索引访问

__getitem__方法用于定义对象的索引访问行为，当我们使用对象[key]的形式访问对象时，会调用该方法。它使得我们的自定义对象可以像列表、字典一样通过索引或键来获取元素。

class MyList:
    def __init__(self, data):
        self.data = data

    def __getitem__(self, index):
        return self.data[index]

my_list = MyList([10, 20, 30, 40, 50])
print(my_list[2])  # 输出: 30

不仅如此，__getitem__方法还支持切片操作，让我们的自定义对象具备更强大的索引访问能力。

print(my_list[1:4])  # 输出: [20, 30, 40]

实现细节

• index参数可以是整数（表示索引）、切片对象（表示切片）或其他类型的键（根据对象的定义）。

• 需要处理各种可能的索引情况，如越界访问等，以保证程序的健壮性。

六、setitem：赋予对象修改元素的能力

__setitem__方法用于定义对象的索引赋值行为，当我们使用对象[key] = value的形式为对象赋值时，会调用该方法。它与__getitem__方法相辅相成，让我们的自定义对象可以像内置集合类对象一样修改元素。

class MyList:
    def __init__(self, data):
        self.data = data

    def __getitem__(self, index):
        return self.data[index]

    def __setitem__(self, index, value):
        self.data[index] = value

my_list = MyList([1, 2, 3])
my_list[1] = 20
print(my_list[1])  # 输出: 20

通过实现__setitem__方法，我们的自定义对象就具备了修改元素的能力，进一步增强了对象的实用性。

注意事项

• 要确保赋值操作的合法性，如检查键的类型、索引是否越界等。

• 根据对象的设计，合理处理不同类型的键和赋值逻辑。

七、delitem：让对象支持删除元素

__delitem__方法用于定义对象的索引删除行为，当我们使用del 对象[key]的形式删除对象中的元素时，会调用该方法。它使得我们的自定义对象可以像列表、字典一样删除元素。

class MyList:
    def __init__(self, data):
        self.data = data

    def __getitem__(self, index):
        return self.data[index]

    def __setitem__(self, index, value):
        self.data[index] = value

    def __delitem__(self, index):
        del self.data[index]

my_list = MyList([1, 2, 3, 4, 5])
del my_list[2]
print(my_list[2])  # 输出: 4

实现__delitem__方法后，我们的自定义对象就具备了完整的索引操作能力，包括获取、修改和删除元素。

应用场景

• 自定义的集合类对象，需要支持元素的删除操作。

• 根据业务需求，需要对删除操作进行特殊处理的场景。

八、call：让对象成为可调用的 "函数"

__call__方法用于定义对象的可调用行为，当我们像调用函数一样调用对象时，会调用该方法。这使得我们的自定义对象可以具备函数的特性，实现一些灵活的功能。

class Adder:
    def __init__(self, n):
        self.n = n

    def __call__(self, x):
        return x + self.n

adder = Adder(5)
print(adder(3))  # 输出: 8

在这个例子中，Adder类的对象adder可以像函数一样被调用，接收一个参数x，并返回x + 5的结果。这种特性在实现装饰器、回调函数等场景中非常有用。

优势

• 使对象具有函数的行为，增加了代码的灵活性和可读性。

• 可以在对象中保存状态，实现有状态的函数功能。

九、enter__和__exit：上下文管理的魔法

__enter__和__exit__方法用于实现上下文管理器，当我们使用with语句时，会自动调用这两个方法。__enter__方法在进入上下文时被调用，通常用于资源的获取；__exit__方法在退出上下文时被调用，通常用于资源的释放和清理。

class FileHandler:
    def __init__(self, filename, mode):
        self.filename = filename
        self.mode = mode
        self.file = None

    def __enter__(self):
        self.file = open(self.filename, self.mode)
        return self.file

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.file.close()

with FileHandler("test.txt", "w") as f:
    f.write("Hello, World!")

在这个例子中，我们定义了一个FileHandler类，用于管理文件的打开和关闭。使用with语句时，会自动打开文件（调用__enter__方法），并在语句块结束后自动关闭文件（调用__exit__方法），即使发生异常也能保证文件被正确关闭。

异常处理

• __exit__方法的三个参数exc_type、exc_val、exc_tb分别表示异常的类型、值和追溯信息。

• 如果在上下文内部发生异常，可以在__exit__方法中进行处理，返回True表示异常已处理，否则异常会被向上抛出。

十、eq、ne、lt、__gt__等：对象比较的魔法

在 Python 中，我们可以通过定义__eq__（等于）、__ne__（不等于）、__lt__（小于）、__gt__（大于）等方法来实现对象的比较操作。这些方法使得我们的自定义对象可以像内置类型一样进行比较。

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

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

    def __lt__(self, other):
        return self.x < other.x or (self.x == other.x and self.y < other.y)

p1 = Point(1, 2)
p2 = Point(1, 2)
p3 = Point(2, 3)
print(p1 == p2)  # 输出: True
print(p1 < p3)   # 输出: True

通过实现这些比较方法，我们的自定义对象就具备了丰富的比较功能，方便在排序、条件判断等场景中使用。

注意事项

• 要确保比较逻辑的一致性，比如__eq__和__ne__应该相互对应。

• 如果只需要实现部分比较方法，可以根据实际需求选择，但通常建议实现一组相关的比较方法以保证功能的完整性。

这 10 个魔术方法是 Python 中非常重要的特性，它们让我们的代码更加简洁、优雅、强大。从对象的初始化和字符串表示，到索引访问、可调用行为和上下文管理，每个魔术方法都有其独特的用途和魅力。