目录
一、概述
1、定义
2、作用
二、主要应用场景
1、构造和析构
2、操作符重载
3、字符串和表示
4、容器管理
5、可调用对象
6、上下文管理
7、属性访问和描述符
8、迭代器和生成器
9、数值类型
10、复制和序列化
11、自定义元类行为
12、自定义类行为
13、类型检查和转换
14、自定义异常
三、学习方法
1、理解基础
2、查阅文档
3、编写示例
4、实践应用
5、阅读他人代码
6、参加社区讨论
7、持续学习
8、练习与总结
9、注意兼容性
10、避免过度使用
四、魔法方法
11、__delitem__方法
11-1、语法
11-2、参数
11-3、功能
11-4、返回值
11-5、说明
11-6、用法
12、__dir__方法
12-1、语法
12-2、参数
12-3、功能
12-4、返回值
12-5、说明
12-6、用法
13、__divmod__方法
13-1、语法
13-2、参数
13-3、功能
13-4、返回值
13-5、说明
13-6、用法
五、推荐阅读
1、Python筑基之旅
2、Python函数之旅
3、Python算法之旅
4、博客个人主页
一、概述
1、定义
魔法方法(Magic Methods/Special Methods，也称特殊方法或双下划线方法)是Python中一类具有特殊命名规则的方法，它们的名称通常以双下划线(`__`)开头和结尾。
魔法方法用于在特定情况下自动被Python解释器调用，而不需要显式地调用它们，它们提供了一种机制，让你可以定义自定义类时具有与内置类型相似的行为。
2、作用
魔法方法允许开发者重载Python中的一些内置操作或函数的行为，从而为自定义的类添加特殊的功能。
二、主要应用场景
1、构造和析构
1-1、__init__(self, [args...])：在创建对象时初始化属性。
1-2、__new__(cls, [args...])：在创建对象时控制实例的创建过程(通常与元类一起使用)。
1-3、__del__(self)：在对象被销毁前执行清理操作，如关闭文件或释放资源。
2、操作符重载
2-1、__add__(self, other)、__sub__(self, other)、__mul__(self, other)等：自定义对象之间的算术运算。
2-2、__eq__(self, other)、__ne__(self, other)、__lt__(self, other)等：定义对象之间的比较操作。
3、字符串和表示
3-1、__str__(self)：定义对象的字符串表示，常用于print()函数。
3-2、__repr__(self)：定义对象的官方字符串表示，用于repr()函数和交互式解释器。
4、容器管理
4-1、__getitem__(self, key)、__setitem__(self, key, value)、__delitem__(self, key)：用于实现类似列表或字典的索引访问、设置和删除操作。
4-2、__len__(self)：返回对象的长度或元素个数。
5、可调用对象
5-1、__call__(self, [args...])：允许对象像函数一样被调用。
6、上下文管理
6-1、__enter__(self)、__exit__(self, exc_type, exc_val, exc_tb)：用于实现上下文管理器，如with语句中的对象。
7、属性访问和描述符
7-1、__getattr__, __setattr__, __delattr__：这些方法允许对象在访问或修改不存在的属性时执行自定义操作。
7-2、描述符(Descriptors)是实现了__get__, __set__, 和__delete__方法的对象，它们可以控制对另一个对象属性的访问。
8、迭代器和生成器
8-1、__iter__和__next__：这些方法允许对象支持迭代操作，如使用for循环遍历对象。
8-2、__aiter__, __anext__：这些是异步迭代器的魔法方法，用于支持异步迭代。
9、数值类型
9-1、__int__(self)、__float__(self)、__complex__(self)：定义对象到数值类型的转换。
9-2、__index__(self)：定义对象用于切片时的整数转换。
10、复制和序列化
10-1、__copy__和__deepcopy__：允许对象支持浅复制和深复制操作。
10-2、__getstate__和__setstate__：用于自定义对象的序列化和反序列化过程。
11、自定义元类行为
11-1、__metaclass__(Python 2)或元类本身(Python 3)：允许自定义类的创建过程，如动态创建类、修改类的定义等。
12、自定义类行为
12-1、__init__和__new__：用于初始化对象或控制对象的创建过程。
12-2、__init_subclass__：在子类被创建时调用，允许在子类中执行一些额外的操作。
13、类型检查和转换
13-1、__instancecheck__和__subclasscheck__：用于自定义isinstance()和issubclass()函数的行为。
14、自定义异常
14-1、你可以通过继承内置的Exception类来创建自定义的异常类，并定义其特定的行为。
三、学习方法
要学好Python的魔法方法，你可以遵循以下方法及步骤：
1、理解基础
首先确保你对Python的基本语法、数据类型、类和对象等概念有深入的理解，这些是理解魔法方法的基础。
2、查阅文档
仔细阅读Python官方文档中关于魔法方法的部分，文档会详细解释每个魔法方法的作用、参数和返回值。你可以通过访问Python的官方网站或使用help()函数在Python解释器中查看文档。
3、编写示例
为每个魔法方法编写简单的示例代码，以便更好地理解其用法和效果，通过实际编写和运行代码，你可以更直观地感受到魔法方法如何改变对象的行为。
4、实践应用
在实际项目中尝试使用魔法方法。如，你可以创建一个自定义的集合类，使用__getitem__、__setitem__和__delitem__方法来实现索引操作。只有通过实践应用，你才能更深入地理解魔法方法的用途和重要性。
5、阅读他人代码
阅读开源项目或他人编写的代码，特别是那些使用了魔法方法的代码，这可以帮助你学习如何在实际项目中使用魔法方法。通过分析他人代码中的魔法方法使用方式，你可以学习到一些新的技巧和最佳实践。
6、参加社区讨论
参与Python社区的讨论，与其他开发者交流关于魔法方法的使用经验和技巧，在社区中提问或回答关于魔法方法的问题，这可以帮助你更深入地理解魔法方法并发现新的应用场景。
7、持续学习
Python语言和其生态系统不断发展，新的魔法方法和功能可能会不断被引入，保持对Python社区的关注，及时学习新的魔法方法和最佳实践。
8、练习与总结
多做练习，通过编写各种使用魔法方法的代码来巩固你的理解，定期总结你学到的知识和经验，形成自己的知识体系。
9、注意兼容性
在使用魔法方法时，要注意不同Python版本之间的兼容性差异，确保你的代码在不同版本的Python中都能正常工作。
10、避免过度使用
虽然魔法方法非常强大，但过度使用可能会导致代码难以理解和维护，在编写代码时，要权衡使用魔法方法的利弊，避免滥用。
总之，学好Python的魔法方法需要不断地学习、实践和总结，只有通过不断地练习和积累经验，你才能更好地掌握这些强大的工具，并在实际项目中灵活运用它们。
四、魔法方法
11、__delitem__方法
11-1、语法
__delitem__(self, key, /)
Delete self[key]
11-2、参数
11-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。
11-2-2、key(必须)：表示想要从对象中删除的元素的键或索引
11-2-3、/(可选)：这是从Python 3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-only parameters)之后的关键字参数(keyword arguments)。
11-3、功能
用于定义当从容器中删除一个元素时应该执行的操作。
11-4、返回值
当这个方法被调用时，它应该执行删除操作，但不应该返回任何值(或者更具体地说，它应该返回None)。
11-5、说明
对于列表，key通常是一个整数索引；对于字典，key通常是一个键。
11-6、用法
# 011、__delitem__方法：
# 1、简单的自定义字典
# 定义一个名为CustomDict的类，该类继承自内置的dict类
class CustomDict(dict):
# 重写父类dict中的__delitem__方法，该方法在删除字典中的键值对时被调用
def __delitem__(self, key):
# 打印出将要被删除的键
print(f"Deleting key: {key}")
# 调用父类dict的__delitem__方法来实际删除指定的键值对
# 使用super()函数可以调用当前类继承的父类(或多个父类)中的方法
super().__delitem__(key)
# 判断当前模块是否作为主程序运行(而不是被导入为模块)
if __name__ == '__main__':
# 创建一个CustomDict对象d，并初始化时传入一个字典{'a': 1, 'b': 2}
d = CustomDict({'a': 1, 'b': 2})
# 删除d中键为'a'的键值对
# 这会触发CustomDict类中定义的__delitem__方法，打印出"Deleting key: a"
del d['a'] # 输出: Deleting key: a
# 2、带有额外检查的字典
# 定义一个名为CheckedDict的类，该类继承自内置的dict类
class CheckedDict(dict):
# 重写父类dict中的__delitem__方法，用于在删除字典项之前进行检查
def __delitem__(self, key):
# 检查键key是否存在于当前字典中
if key not in self:
# 如果键不存在，则抛出一个KeyError异常，并说明键不存在
raise KeyError(f"Key {key} does not exist.")
# 如果键存在，则打印出正在删除的键
print(f"Deleting key: {key}")
# 调用父类dict的__delitem__方法来实际删除指定的键值对
super().__delitem__(key)
# 判断当前模块是否作为主程序运行（而不是被导入为模块）
if __name__ == '__main__':
# 创建一个CheckedDict对象cd，并初始化时传入一个字典{'a': 1, 'b': 2}
cd = CheckedDict({'a': 1, 'b': 2})
# 删除cd中键为'a'的键值对
# 这会触发CheckedDict类中定义的__delitem__方法，打印出"Deleting key: a"
del cd['a'] # 输出: Deleting key: a
# 尝试删除cd中键为'c'的键值对
# 因为'c'不在cd中，所以会触发CheckedDict类中定义的__delitem__方法中的KeyError异常
del cd['c'] # 引发 KeyError: Key c does not exist.
# 3、自定义列表，删除元素时更新索引
class IndexedList:
# 初始化方法，创建一个空的列表用于存储元素，和一个空的字典用于存储元素和它们的索引
def __init__(self):
self.items = [] # 列表，用于存储元素
self.indices = {} # 字典，用于存储元素和它们的索引
# 添加元素到列表的末尾，并在indices字典中记录其索引
def append(self, item):
index = len(self.items) # 获取当前列表的长度，即新元素的索引
self.items.append(item) # 将元素添加到列表的末尾
self.indices[item] = index # 在indices字典中记录元素和它的索引
# 删除指定索引或元素的方法
def __delitem__(self, key):
# 如果key是整数，则认为它是索引
if isinstance(key, int):
index = key # 索引就是key
item = self.items[index] # 从列表中根据索引获取元素
# 如果key在indices字典中，则认为它是元素的值
elif key in self.indices:
index = self.indices[key] # 从indices字典中获取元素的索引
# 注意：这里item应该设置为列表中的元素，而不是key本身
# 但由于代码逻辑，我们保持item = key，这在key是元素值时是正确的
item = key
# 如果key既不是整数也不在indices字典中，则抛出KeyError
else:
raise KeyError(f"Key {key} does not exist.")
# 打印正在删除的元素和它的索引
print(f"Deleting item at index {index}: {item}")
# 从列表中删除元素
del self.items[index]
# 从indices字典中删除对应的条目
# 注意：这里应该使用item对应的值，而不是item本身（如果key是索引的话）
# 但由于之前的代码逻辑，这里直接使用item是可行的（如果key是元素值）
del self.indices[item]
if __name__ == '__main__':
il = IndexedList() # 创建一个IndexedList对象
il.append('apple') # 添加'apple'元素，其索引为0
il.append('banana') # 添加'banana'元素，其索引为1
del il[1] # 删除索引为1的元素（即'banana'），并输出：Deleting item at index 1: banana
# 4、带有删除日志的列表
class LoggedList(list):
# 重写list类的__delitem__方法，以便在删除元素时记录日志
def __delitem__(self, index):
# 使用pop方法删除指定索引的元素，并返回该元素
# 注意：pop方法会直接修改列表，删除指定索引的元素并返回它
item = self.pop(index) # 使用pop删除并返回元素
# 打印正在删除的元素
print(f"Deleting item: {item}")
if __name__ == '__main__':
# 创建一个LoggedList对象，并初始化列表为[1, 2, 3]
ll = LoggedList([1, 2, 3])
# 删除索引为1的元素（即值为2的元素）
# 由于LoggedList类重写了__delitem__方法，所以在删除时会调用该方法并记录日志
del ll[1] # 输出: Deleting item: 2
# 5、限制删除操作的列表
class RestrictedList(list):
# 重写父类list的__delitem__方法，增加索引检查
def __delitem__(self, index):
# 检查索引是否在有效范围内（包括0到len(self)-1）
if not 0 , 4)
