Python与下划线（二）从__init__到__str__

Python 采用一种自然而充满表达力的设计，使用前后包裹双下划线（__）的“魔法方法”，实现了对象的自定义行为。这些魔法方法常用于重定义 Python 内置运算和操作，如构造函数、运算符重贴、下标访问等。本文将从基础到高级，全面解析 Python 魔法方法的原理和实现。

免费专栏在这里：Python的下划线知识

目录

1. 什么是魔法方法？

1.1 魔法方法概念

1.2 魔法方法的主要类型

2. Python 构造与初始化魔法方法

2.1 __new__ 和 __init__ 的区别

2.2 示例：自定义对象的创建

2.3 使用场景

3. 字符串表示魔法方法

3.1 __str__ 和 __repr__ 的区别

3.2 示例：字符串表示方法的应用

3.3 适用场景

4. 运算符重载魔法方法

4.1 基本运算符重载

4.2 示例：实现向量加法

4.3 其他运算符的扩展

5. 下标操作魔法方法

5.1 定义对象的下标行为

5.2 示例：自定义字典行为

6. 魔法方法的应用场景与注意事项

6.1 常见应用场景

6.2 注意事项

1. 什么是魔法方法？

1.1 魔法方法概念

• 魔法方法的定义：魔法方法是 Python 中一类特殊的函数，通常用于实现对象的特殊行为，例如初始化、字符串表示、加减法操作等。

• 自动调用：这些方法无需手动调用，而是由 Python 解释器在特定场景下自动触发。

• 灵活性：通过魔法方法，开发者可以定义自定义类与内置类的交互逻辑，让对象的行为更加灵活。

1.2 魔法方法的主要类型

• 构造和初始化方法：如 __new__ 和 __init__。

• 字符串表示方法：如 __str__ 和 __repr__。

• 运算符重载：如 __add__、__sub__、__mul__ 等。

• 对象比较方法：如 __eq__、__lt__、__hash__。

• 下标和迭代操作：如 __getitem__、__setitem__、__iter__。

• 功能扩展：如 __call__、__len__。

这些方法的存在，使得 Python 类可以像内置类型一样，与语言的核心特性紧密结合。

2. Python 构造与初始化魔法方法

2.1 __new__ 和 __init__ 的区别

• __new__：在对象创建时被调用，负责返回一个新的实例。它通常用于控制实例化过程，或实现单例模式。

• __init__：在对象创建完成后调用，用于初始化对象的属性。

这两个方法的组合让开发者既能控制对象的创建过程，又能定义对象的初始化逻辑。

2.2 示例：自定义对象的创建

class Singleton:
    _instance = None

    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = super().__new__(cls)
        return cls._instance

    def __init__(self, name):
        self.name = name

s1 = Singleton("实例1")
s2 = Singleton("实例2")
print(s1.name)  # 输出：实例1
print(s2.name)  # 输出：实例1
print(s1 is s2)  # 输出：True

解释：

• __new__ 确保始终返回同一个实例。

• __init__ 定义实例的初始化逻辑，但不会影响实例的唯一性。

2.3 使用场景

• 单例模式：确保类只有一个实例。

• 自定义元类：通过控制对象的创建，动态修改类的行为。

3. 字符串表示魔法方法

3.1 __str__ 和 __repr__ 的区别

• __str__：定义面向用户的对象字符串表示，通常用于打印或日志。

• __repr__：定义面向开发者的对象字符串表示，主要用于调试和开发。

3.2 示例：字符串表示方法的应用

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

    def __str__(self):
        return f"姓名：{self.name}, 年龄：{self.age}"

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

p = Person("小红", 22)
print(str(p))  # 输出：姓名：小红, 年龄：22
print(repr(p))  # 输出：Person(name=小红, age=22)

解释：

• __str__ 是用户友好的表示。

• __repr__ 则是开发者友好的表示，用于清晰展示对象的构造信息。

3.3 适用场景

• __str__：当需要美化输出时使用，例如报告生成。

• __repr__：调试工具和日志记录中非常有用。

4. 运算符重载魔法方法

4.1 基本运算符重载

通过运算符重载，开发者可以定义对象间的数学运算或逻辑操作。

4.2 示例：实现向量加法

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

    def __add__(self, other):
        return Vector(self.x + other.x, self.y + other.y)

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

v1 = Vector(1, 2)
v2 = Vector(3, 4)
print(v1 + v2)  # 输出：Vector(4, 6)

解释：

• 通过重载 __add__ 方法，定义了向量相加的逻辑。

• __repr__ 方法确保了结果的可读性。

4.3 其他运算符的扩展

• 比较运算符：__eq__、__lt__、__gt__。

• 位运算符：__and__、__or__、__xor__。

• 索引和切片：__getitem__、__setitem__。

5. 下标操作魔法方法

5.1 定义对象的下标行为

• __getitem__：控制对象在下标访问时的行为。

• __setitem__：控制对象在下标赋值时的行为。

5.2 示例：自定义字典行为

class MyDict:
    def __init__(self):
        self.store = {}

    def __getitem__(self, key):
        return self.store.get(key, None)

    def __setitem__(self, key, value):
        self.store[key] = value

    def __repr__(self):
        return str(self.store)

my_dict = MyDict()
my_dict["a"] = 10
print(my_dict["a"])  # 输出：10
print(my_dict)  # 输出：{'a': 10}

解释：

• 通过 __getitem__ 和 __setitem__，开发者可以定义自定义数据结构的存取逻辑。

• 这种方法广泛应用于实现类似字典、列表的容器类。

6. 魔法方法的应用场景与注意事项

6.1 常见应用场景

• 自定义类行为：如加法、减法、字符串表示。

• 实现容器类型：支持下标访问、迭代操作等。

• 定义接口：如 __call__ 实现对象调用。

6.2 注意事项

• 避免滥用魔法方法：过多的重载会导致代码可读性降低。

• 明确用途：魔法方法应服务于类的核心功能，避免为不相关逻辑使用。

通过对 Python 魔法方法的全面解析，大家可以清楚地了解到这些特殊方法如何赋予对象更多灵活性和表达力。在实际开发中，合理地使用魔法方法，可以让代码更加优雅和高效。