Python：魔法函数

注意：本文引用自专业人工智能社区Venus AI

更多AI知识请参考原站 （[www.aideeplearning.cn]）

Python 的魔法函数，又称为特殊方法，是 Python 类中定义的一组特殊的方法，具有一些独特的特性和用途。这些方法以双下划线（__）开头和结尾，它们在 Python 编程中扮演着特殊角色。魔法函数不是显式调用的，而是在特定的语境下由 Python 解释器隐式自动调用。它们的触发通常与 Python 中的某些内置行为或操作相对应。

魔法函数的工作原理

1. 自动触发：魔法函数的调用不是直接进行的。例如，当你对类的实例执行 a + b 操作时，Python 将自动调用该类的 __add__ 方法（如果定义了的话）。
2. 模仿内置类型：魔法函数可以让自定义对象模仿内置类型的行为。例如，通过实现 __len__ 方法，可以使对象支持 len() 函数；通过实现 __getitem__ 方法，可以使对象支持索引操作，如 obj[key]。
3. 增强灵活性：魔法函数提供了一种方式，可以在不改变语法结构的前提下，为自定义对象添加额外的功能。

常见的魔法函数

1. __init__(self, ...)

• 功能：构造函数，创建对象时自动调用。
• 代码：

class Example:

    def __init__(self, value):

        self.value = value

• 解读：这段代码定义了一个名为Example的类，并提供了一个构造函数__init__。构造函数接受一个参数value，并将其赋值给对象的value属性。当您创建Example类的实例时，如Example(10)，数字10就会被存储在该实例的value属性中。

2. __str__(self)

• 功能：定义对象的字符串表示，例如用于print()。
• 代码：

class Example:

    def __str__(self):
        return "这是一个示例对象"

• 解读：此方法定义了对象的字符串表示。当您打印该对象或在需要字符串表示的地方使用该对象时，例如print(Example())，它将输出字符串"这是一个示例对象"。

3. __repr__(self)

• 功能：定义对象的官方字符串表示。
• 代码：

class Example:

    def __repr__(self):

        return 'Example()'

• 解读：这个方法定义了对象的官方字符串表示，通常用于调试。当您在解释器中直接输入该对象或调用repr()函数时，例如repr(Example())，它将返回字符串'Example()'。

4. __len__(self)

• 功能：定义对象的长度，用于len()函数。
• 代码：

class Example:

    def __len__(self):

        return 10

• 解读：该方法定义了对象的长度。当您调用len()函数获取对象的长度时，如len(Example())，它将返回10。

5. __getitem__(self, key)

• 功能：允许对象使用索引操作，如obj[key]。
• 代码：

class Example:

    def __getitem__(self, key):

        return key * 2

• 解读：这个方法允许对象使用索引操作。例如，当您执行Example()[5]时，它将返回10（因为5 * 2 = 10）。

6. __setitem__(self, key, value)

• 功能：允许对象使用索引赋值，如obj[key] = value。
• 代码：

class Example:

    def __setitem__(self, key, value):

        print(f"设置索引 {key} 的值为 {value}")

• 解读：该方法允许对象使用索引赋值。例如，执行Example()[5] = 100时，它将打印设置索引 5 的值为 100。

7. __eq__(self, other)

• 功能：定义等号==的行为。
• 代码：

class Example:

    def __eq__(self, other):

        return self.value == other.value

• 解读：这个方法定义了等号==的行为。当您比较两个对象是否相等时，例如Example(10) == Example(10)，它将返回True，因为两个对象的value属性值相同。

8. __add__(self, other)

• 功能：定义加号+的行为。
• 代码：

class Example:

    def __add__(self, other):

        return self.value + other.value

• 解读：此方法定义了加号+的行为。例如，当您将两个Example对象相加时，如Example(10) + Example(20)，它将返回它们value属性值的和，即30。

9. __iter__(self) 和 __next__(self)

• 功能：这两个方法共同使得对象成为迭代器。__iter__返回迭代器本身，__next__返回序列的下一个元素。
• 代码：

class CountDown:

    def __init__(self, start):

        self.current = start

    def __iter__(self):

        return self

    def __next__(self):

        if self.current <= 0:

            raise StopIteration

        else:

            self.current -= 1

            return self.current

• 解读：这个CountDown类实现了一个倒计时迭代器。初始化时设置开始的计数值。当迭代这个对象时（比如在for循环中），__next__方法会被调用，返回当前值后将其减一，直到计数到0时抛出StopIteration异常来停止迭代。

10. __call__(self, ...)

• 功能：使得实例能够像函数一样被调用。
• 代码：

class Multiply:

    def __call__(self, a, b):

        return a * b

• 解读：在这个例子中，Multiply类的实例可以被用作函数。当您创建一个Multiply实例并像调用函数那样调用它时，例如Multiply()(5, 3)，它会返回两个参数的乘积，这里是15。

这些魔法方法允许自定义类更加灵活和强大，使它们的行为更接近Python的内置类型，如字符串、列表等。