Python魔法之旅-魔法方法(22)

目录

一、概述

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、避免过度使用

四、魔法方法

68、__setattr__方法

68-1、语法

68-2、参数

68-3、功能

68-4、返回值

68-5、说明

68-6、用法

69、__setitem__方法

69-1、语法

69-2、参数

69-3、功能

69-4、返回值

69-5、说明

69-6、用法

70、__sizeof__方法

70-1、语法

70-2、参数

70-3、功能

70-4、返回值

70-5、说明

70-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的魔法方法需要不断地学习、实践和总结，只有通过不断地练习和积累经验，你才能更好地掌握这些强大的工具，并在实际项目中灵活运用它们。

四、魔法方法

68、__setattr__方法

68-1、语法
  1. __setattr__(self, name, value, /)
  2.     Implement setattr(self, name, value)
68-2、参数

68-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。

68-2-2、name(必须)：一个字符串，表示要设置的属性的名称。

68-2-3、value(必须)：要设置给属性的新值。

68-2-4、 /(可选)：这是从Python 3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-only parameters)之后的关键字参数(keyword arguments)。

68-3、功能

        用于在尝试为一个对象的属性赋值时被调用。

68-4、返回值

       没有特定的返回值要求，其主要目的是执行某些操作，而不是返回任何值。

68-5、说明

        由于__setattr__是在设置属性时被调用的，因此它本身并不“返回”被设置的属性值；相反，它执行必要的操作来确保属性值被正确地设置。

68-6、用法
  1. # 068、__setattr__方法：
  2. # 1、属性值范围限制
  3. class RangeLimited:
  4.     def __init__(self, min_value=0, max_value=100):
  5.         self._min_value = min_value
  6.         self._max_value = max_value
  7.         self._data = {}
  8.     def __setattr__(self, name, value):
  9.         if name.startswith('_'):
  10.             super().__setattr__(name, value)
  11.         else:
  12.             if self._min_value <= value <= self._max_value:
  13.                 self._data[name] = value
  14.             else:
  15.                 raise ValueError(
  16.                     f"Value {value} for attribute {name} is out of range ({self._min_value} to {self._max_value})")
  17.     def __getattr__(self, name):
  18.         return self._data.get(name)
  19. if __name__ == '__main__':
  20.     obj = RangeLimited(min_value=10, max_value=50)
  21.     obj.value = 25  # 正常赋值
  22.     print(obj.value)  # 输出：25
  23.     # obj.value = 75  # 抛出异常：ValueError: Value 75 for attribute value is out of range (10 to 50)
  24.  
  25. # 2、属性依赖检查
  26. class DependencyChecker:
  27.     def __init__(self):
  28.         self._data = {}
  29.     def __setattr__(self, name, value):
  30.         # 检查是否是_data字典的赋值，或者是否是_data字典之外的属性赋值
  31.         if name == '_data':
  32.             # 如果是_data字典的赋值，直接使用基类的__setattr__
  33.             super().__setattr__(name, value)
  34.         elif name == 'b' and 'a' not in self._data:
  35.             # 如果尝试设置b属性但a属性尚未设置，则抛出异常
  36.             raise AttributeError("Cannot set attribute 'b' before 'a' is set.")
  37.         else:
  38.             # 对于_data字典之外的其他属性，存储到_data字典中
  39.             self._data[name] = value
  40. if __name__ == '__main__':
  41.     obj = DependencyChecker()
  42.     obj.a = 10  # 正常赋值
  43.     obj.b = 20  # 如果在设置obj.b之前没有设置obj.a，则会抛出AttributeError（但在这个示例中不会）
  44.     # 尝试在没有设置a的情况下设置b，会抛出AttributeError
  45.     # obj = DependencyChecker()
  46.     # obj.b = 20  # 这会抛出AttributeError: Cannot set attribute 'b' before 'a' is set.

69、__setitem__方法

69-1、语法
  1. __setitem__(self, key, value, /)
  2.     Set self[key] to value
69-2、参数

69-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。

69-2-2、key(必须)：表示要设置的键，通常是一个可哈希(hashable)的对象，如整数、浮点数、字符串、元组等，在my_dict[key]=value这样的语句中，key就是你要设置的键。

69-2-3、value(必须)：表示要设置给键的新值，在my_dict[key]=value这样的语句中，value就是你要设置给键的值。

69-2-4、/(可选)：这是从Python 3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-only parameters)之后的关键字参数(keyword arguments)。

69-3、功能

        用于自定义字典(或类似字典的容器)在通过键(key)设置值(value)时的行为。

69-4、返回值

        没有返回值，即返回None。

69-5、说明

        无

69-6、用法
  1. # 069、__setitem__方法：
  2. # 1、简单的键值存储
  3. class SimpleDict:
  4.     def __init__(self):
  5.         self.data = {}
  6.     def __setitem__(self, key, value):
  7.         self.data[key] = value
  8. if __name__ == '__main__':
  9.     d = SimpleDict()
  10.     d['a'] = 1
  11.  
  12. # 2、限制键类型的字典
  13. class TypedDict:
  14.     def __init__(self, key_type):
  15.         self.key_type = key_type
  16.         self.data = {}
  17.     def __setitem__(self, key, value):
  18.         if not isinstance(key, self.key_type):
  19.             raise TypeError(f"Key must be of type {self.key_type}")
  20.         self.data[key] = value
  21. if __name__ == '__main__':
  22.     td = TypedDict(str)
  23.     td['hello'] = 'world'
  24.  
  25. # 3、自定义列表
  26. class CustomList:
  27.     def __init__(self):
  28.         self.data = []
  29.  
  30.     def __setitem__(self, index, value):
  31.         if index < 0 or index >= len(self.data):
  32.             raise IndexError("Index out of range")
  33.         self.data[index] = value
  34. if __name__ == '__main__':
  35.     cl = CustomList()
  36.     cl.data.extend([0, 0, 0])
  37.     cl[1] = 1
  38.  
  39. # 4、实现稀疏矩阵
  40. class SparseMatrix:
  41.     def __init__(self, rows, cols):
  42.         self.rows = rows
  43.         self.cols = cols
  44.         self.data = {}
  45.     def __setitem__(self, index, value):
  46.         if value == 0:
  47.             return  # 不存储零值
  48.         row, col = index
  49.         if 0 <= row < self.rows and 0 <= col < self.cols:
  50.             self.data[(row, col)] = value
  51.             # 还需要实现__getitem__等方法...
  52. if __name__ == '__main__':
  53.     sm = SparseMatrix(3, 3)
  54.     sm[(1, 1)] = 1
  55.  
  56. # 5、实现优先队列
  57. import heapq
  58. class PriorityQueue:
  59.     def __init__(self):
  60.         self._queue = []
  61.         self._index = 0
  62.     def __setitem__(self, priority, item):
  63.         heapq.heappush(self._queue, (-priority, self._index, item))
  64.         self._index += 1
  65.         # 还需要实现pop等方法...
  66. if __name__ == '__main__':
  67.     pq = PriorityQueue()
  68.     pq[3] = 'c'
  69.     pq[1] = 'a'
  70.     pq[2] = 'b'
  71.  
  72. # 6、实现一个带有历史记录的字典
  73. class HistoryDict:
  74.     def __init__(self):
  75.         self.data = {}
  76.         self.history = []
  77.     def __setitem__(self, key, value):
  78.         if key in self.data:
  79.             self.history.append((key, self.data[key]))  # 记录旧值
  80.         self.data[key] = value
  81.         self.history.append((key, value))  # 记录新值
  82. if __name__ == '__main__':
  83.     hd = HistoryDict()
  84.     hd['key'] = 'value1'
  85.     hd['key'] = 'value2'
  86.  
  87. # 7、实现一个只接受整数值的字典
  88. class IntegerValueDict:
  89.     def __init__(self):
  90.         self.data = {}
  91.     def __setitem__(self, key, value):
  92.         if not isinstance(value, int):
  93.             raise ValueError("Value must be an integer")
  94.         self.data[key] = value
  95. if __name__ == '__main__':
  96.     ivd = IntegerValueDict()
  97.     ivd['a'] = 10  # 正常设置
  98.     # ivd['b'] = 'ten'  # 这会抛出 ValueError
  99.  
  100. # 8、实现一个带有自动排序功能的列表
  101. class SortedList:
  102.     def __init__(self):
  103.         self.data = []
  104.     def __setitem__(self, index, value):
  105.         if index < 0 or index > len(self.data):
  106.             raise IndexError("Index out of range")
  107.         self.data.insert(index, value)
  108.         self.data.sort()
  109.     def __getitem__(self, index):
  110.         return self.data[index]
  111.     # 注意：这里插入元素后对整个列表进行排序可能不是最高效的，
  112.     # 实际中可能会使用更复杂的数据结构（如平衡二叉搜索树）来实现自动排序。
  113. if __name__ == '__main__':
  114.     sl = SortedList()
  115.     sl[0] = 3
  116.     sl[1] = 1
  117.     sl[2] = 2
  118.     print(sl[0], sl[1], sl[2])  # 输出: 1 2 3
  119.  
  120. # 9、实现一个具有默认值的字典
  121. class DefaultDict:
  122.     def __init__(self, default_value):
  123.         self.data = {}
  124.         self.default_value = default_value
  125.     def __setitem__(self, key, value):
  126.         self.data[key] = value
  127.     def __getitem__(self, key):
  128.         return self.data.get(key, self.default_value)
  129. if __name__ == '__main__':
  130.     dd = DefaultDict(0)
  131.     print(dd['a'])  # 输出: 0（因为'a'不在字典中，返回默认值0）
  132.     dd['a'] = 1
  133.     print(dd['a'])  # 输出: 1
  134.  
  135. # 10、实现一个二维数组(列表的列表)
  136. class TwoDArray:
  137.     def __init__(self, rows, cols):
  138.         self.data = [[0] * cols for _ in range(rows)]
  139.     def __setitem__(self, index, value):
  140.         if not isinstance(index, tuple) or len(index) != 2:
  141.             raise IndexError("Index must be a tuple of length 2")
  142.         row, col = index
  143.         if not (0 <= row < len(self.data) and 0 <= col < len(self.data[0])):
  144.             raise IndexError("Index out of range")
  145.         self.data[row][col] = value
  146. if __name__ == '__main__':
  147.     ta = TwoDArray(3, 3)
  148.     ta[(1, 1)] = 5
  149.  
  150. # 11、实现一个具有最大容量限制的列表
  151. class BoundedList:
  152.     def __init__(self, max_size):
  153.         self.data = []
  154.         self.max_size = max_size
  155.     def __setitem__(self, index, value):
  156.         if index < 0 or index >= self.max_size:
  157.             raise IndexError("Index out of range")
  158.         if len(self.data) == self.max_size:
  159.             self.data.pop(0)  # 移除第一个元素以保持最大容量
  160.         self.data.append(None)  # 先在末尾添加一个占位符
  161.         self.data[index] = value  # 设置值
  162.     def __getitem__(self, index):
  163.         if index < 0 or index >= len(self.data):
  164.             raise IndexError("Index out of range")
  165.         return self.data[index]
  166. if __name__ == '__main__':
  167.     bl = BoundedList(3)
  168.     bl[0] = 'a'
  169.     bl[1] = 'b'
  170.     bl[2] = 'c'
  171.     # bl[3] = 'd'  # 这会抛出异常：IndexError: Index out of range

70、__sizeof__方法

70-1、语法
  1. __sizeof__(self, /)
  2.     D.__sizeof__() -> size of D in memory, in bytes # 以字节数的方式
70-2、参数

70-2-1、self(必须)：一个对实例对象本身的引用，在类的所有方法中都会自动传递。

70-2-2、/(可选)：这是从Python 3.8开始引入的参数注解语法，它表示这个方法不接受任何位置参数(positional-only parameters)之后的关键字参数(keyword arguments)。

70-3、功能

        用于返回对象在内存中占用的字节数。

70-4、返回值

        返回一个整数，表示对象在内存中占用的字节数。

70-5、说明

        无

70-6、用法
  1. # 070、__sizeof__方法：
  2. # 1、自定义列表
  3. class CustomList(list):
  4.     def __sizeof__(self):
  5.         size = super().__sizeof__()
  6.         for item in self:
  7.             size += sys.getsizeof(item)
  8.         return size
  9.  
  10. # 2、自定义字典
  11. import sys
  12. class CustomDict(dict):
  13.     def __sizeof__(self):
  14.         size = super().__sizeof__()
  15.         for key, value in self.items():
  16.             size += sys.getsizeof(key) + sys.getsizeof(value)
  17.         return size
  18.  
  19. # 3、自定义字符串类
  20. class CustomString:
  21.     def __init__(self, string):
  22.         self.string = string
  23.     def __sizeof__(self):
  24.         return sys.getsizeof(self.string) + sys.getsizeof(self)
  25.  
  26. # 4、自定义整数类
  27. class CustomInteger:
  28.     def __init__(self, value):
  29.         self.value = value
  30.     def __sizeof__(self):
  31.         return sys.getsizeof(self.value) + sys.getsizeof(self)
  32.  
  33. # 5、自定义浮点数类
  34. class CustomFloat:
  35.     def __init__(self, value):
  36.         self.value = value
  37.     def __sizeof__(self):
  38.         return sys.getsizeof(self.value) + sys.getsizeof(self)
  39.  
  40. # 6、二维点类
  41. class Point2D:
  42.     def __init__(self, x, y):
  43.         self.x = x
  44.         self.y = y
  45.     def __sizeof__(self):
  46.         return sys.getsizeof(self.x) + sys.getsizeof(self.y) + sys.getsizeof(self)
  47.  
  48. # 7、三维点类
  49. class Point3D:
  50.     def __init__(self, x, y, z):
  51.         self.x = x
  52.         self.y = y
  53.         self.z = z
  54.     def __sizeof__(self):
  55.         return sys.getsizeof(self.x) + sys.getsizeof(self.y) + sys.getsizeof(self.z) + sys.getsizeof(self)
  56.  
  57. # 8、自定义矩阵类
  58. class Matrix:
  59.     def __init__(self, rows, cols, values=None):
  60.         self.rows = rows
  61.         self.cols = cols
  62.         self.data = [[0 for _ in range(cols)] for _ in range(rows)]
  63.         if values:
  64.             for i, row in enumerate(values):
  65.                 for j, val in enumerate(row):
  66.                     self.data[i][j] = val
  67.     def __sizeof__(self):
  68.         size = sys.getsizeof(self) + sys.getsizeof(self.rows) + sys.getsizeof(self.cols)
  69.         for row in self.data:
  70.             for val in row:
  71.                 size += sys.getsizeof(val)
  72.         return size
  73.  
  74. # 9、自定义二叉树节点类
  75. class TreeNode:
  76.     def __init__(self, value):
  77.         self.value = value
  78.         self.left = None
  79.         self.right = None
  80.     def __sizeof__(self):
  81.         size = sys.getsizeof(self) + sys.getsizeof(self.value)
  82.         if self.left:
  83.             size += self.left.__sizeof__()
  84.         if self.right:
  85.             size += self.right.__sizeof__()
  86.         return size
  87.  
  88. # 10、自定义图像类
  89. class Image:
  90.     def __init__(self, width, height, data):
  91.         self.width = width
  92.         self.height = height
  93.         self.data = data  # Assume data is a list of pixel values
  94.     def __sizeof__(self):
  95.         size = sys.getsizeof(self) + sys.getsizeof(self.width) + sys.getsizeof(self.height)
  96.         for pixel in self.data:
  97.             size += sys.getsizeof(pixel)
  98.         return size
  99.  
  100. # 11、自定义文件缓存类
  101. import os
  102. class FileCache:
  103.     def __init__(self, path):
  104.         self.path = path
  105.         self.cache = {}
  106.     def __sizeof__(self):
  107.         size = sys.getsizeof(self) + sys.getsizeof(self.path)
  108.         for key, value in self.cache.items():
  109.             size += sys.getsizeof(key) + os.path.getsize(value) if isinstance(value, str) and os.path.exists(
  110.                 value) else sys.getsizeof(value)
  111.         return size
  112.         # 注意：这里os.path.getsize()用于计算文件大小，但这可能不准确，因为self.cache中的值可能不是文件路径
  113.  
  114. # 12、自定义图形类(例如矩形)
  115. class Rectangle:
  116.     def __init__(self, width, height):
  117.         self.width = width
  118.         self.height = height
  119.     def __sizeof__(self):
  120.         return sys.getsizeof(self) + sys.getsizeof(self.width) + sys.getsizeof(self.height)
  121.         # 注意：这里我们只计算了Rectangle对象本身和其属性占用的内存，没有考虑可能与之关联的图形缓冲区或渲染资源
  122.  
  123. # 13、自定义集合类
  124. class CustomSet(set):
  125.     def __sizeof__(self):
  126.         size = super().__sizeof__()
  127.         for item in self:
  128.             size += sys.getsizeof(item)
  129.         # 可能需要加上额外的哈希表开销，但这里为了简化我们忽略它
  130.         return size
  131.  
  132. # 14、自定义日期范围类
  133. from datetime import date
  134. class DateRange:
  135.     def __init__(self, start_date, end_date):
  136.         self.start_date = start_date
  137.         self.end_date = end_date
  138.     def __sizeof__(self):
  139.         return sys.getsizeof(self) + sys.getsizeof(self.start_date) + sys.getsizeof(self.end_date)
  140.  
  141. # 15、自定义栈类
  142. class Stack:
  143.     def __init__(self):
  144.         self.items = []
  145.     def push(self, item):
  146.         self.items.append(item)
  147.     def pop(self):
  148.         if not self.is_empty():
  149.             return self.items.pop()
  150.         else:
  151.             raise IndexError("Pop from an empty stack")
  152.     def is_empty(self):
  153.         return not bool(self.items)
  154.     def __sizeof__(self):
  155.         size = sys.getsizeof(self) + sys.getsizeof(self.items)
  156.         for item in self.items:
  157.             size += sys.getsizeof(item)
  158.         return size

五、推荐阅读

1、Python筑基之旅

2、Python函数之旅

3、Python算法之旅

4、博客个人主页

文章知识点与官方知识档案匹配，可进一步学习相关知识
Python入门技能树首页概览425874 人正在系统学习中
遨游码海，我心飞扬
微信名片
注：本文转载自blog.csdn.net的神奇夜光杯的文章"https://myelsa1024.blog.csdn.net/article/details/139509106"。版权归原作者所有，此博客不拥有其著作权，亦不承担相应法律责任。如有侵权，请联系我们删除。
复制链接
相关推荐
发表评论

评论记录：

未查询到任何数据！