Python中的魔法函数和魔法属性用法示例

黑色的晚风

前言

Python 中的魔法函数，也被称为特殊方法或双下划线方法，是 Python 中一些特殊命名的函数，它们以双下划线开头和结尾。这些函数定义了对象在特定情况下的行为，例如创建、比较、运算、迭代等。
魔法函数主要是为某些特殊需求而设计的。例如__str__() 和__repr__() 函数用于打印输出对象的信息，__add__() 函数用于定义两个对象相加的行为，__len__() 函数定义当被 len() 调用时的行为等。Python 魔法函数是实现 Python 语法糖的一种方式，提高代码的可读性和可维护性，比如对象相加，大家更习惯 c = a + b 的形式，如果用户使用 a + b 能自动调用 a.__add__(b) 的话，自然要方便很多了，而魔法函数正好有这种功能。

魔法函数


__init__

__init__ 对象初始化函数，在创建实例化对象时自动调用。这个最熟悉的就不多说了。

1. class TestClass:
   
2.     def __init__(self, name):
   
3.         self.name = name
   
4. 
   
5. obj = TestClass("Alice")

复制代码

__str__

以用户友好的方式返回对象的字符串表示，使用 str() 时自动调用。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __str__(self):
   
7.         return f"({self.x}, {self.y})"
   
8. 
   
9. p = PointClass(3, 4)
   
10. print(p)  # (3, 4)

复制代码

__repr__

以开发者友好的方式返回对象的字符串表示，使用 repr() 时自动调用。当使用 print() 函数打印对象时，首先调用的是 __str__ 方法，如果对象没有定义 __str__ 方法，才会调用 __repr__ 方法。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __str__(self):
   
7.         return f"({self.x}, {self.y})"
   
8. 
   
9.     def __repr__(self):
   
10.         return f"Point({self.x}, {self.y})"
    
11. 
    
12. p = PointClass(3, 4)
    
13. print(p)  # (3, 4)
    
14. print(str(p))  # (3, 4)
    
15. print(repr(p))  # Point(3, 4)

复制代码

__len__

返回对象的长度，使用 len() 自动调用。

1. class ListClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __len__(self):
   
6.         return len(self.items)
   
7. 
   
8. my_list = ListClass([1, 2, 3, 4, 5])
   
9. print(len(my_list))  # 5

复制代码

__missing__

当尝试访问字典中不存在的键时，如果定义了

1. __missing__

复制代码

方法，它将被调用，而不是抛出

1. KeyError

复制代码

。

1. class DictClass(dict):
   
2. 
   
3.     def __missing__(self, key):
   
4.         self[key] = "default"
   
5.         return "default"
   
6. 
   
7. my_dict = DictClass({'a': 1, 'b': 2})
   
8. print(my_dict['c'])  # default
   
9. print(my_dict.keys())  # dict_keys(['a', 'b', 'c'])
   
10. 
    
11. my_dict = dict({'a': 1, 'b': 2})
    
12. print(my_dict['c'])  # KeyError: 'c'

复制代码

__getitem__

获取对象的指定元素，当使用索引操作符

1. []

复制代码

来访问对象的元素时自动调用。

1. class DictClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __getitem__(self, key):
   
6.         return self.items.get(key)
   
7. 
   
8. my_dict = DictClass({'a': 1, 'b': 2})
   
9. print(my_dict['a'])  # 1

复制代码

__setitem__

给对象的指定元素设置值，给对象设定值时自动调用。

1. class DictClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __setitem__(self, key, value):
   
6.         self.items[key] = value
   
7. 
   
8. my_dict = DictClass({'a': 1, 'b': 2})
   
9. my_dict['c'] = 3
   
10. print(my_dict.items)  # {'a': 1, 'b': 2, 'c': 3}

复制代码

__delitem__

删除对象指定元素，使用 del 删除对象元素时自动调用。

1. class DictClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __delitem__(self, key):
   
6.         del self.items[key]
   
7. 
   
8. my_dict = DictClass({'a': 1, 'b': 2})
   
9. del my_dict['a']
   
10. print(my_dict.items)  # {'b': 2}

复制代码

__contains__

判断对象是否包含指定元素，使用 in 判断时自动调用。

1. class ListClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __contains__(self, item):
   
6.         return item in self.items
   
7. 
   
8. my_list = ListClass([1, 2, 3, 4, 5])
   
9. print(3 in my_list)  # True

复制代码

__iter__

返回迭代器对象。

1. class ListClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4. 
   
5.     def __iter__(self):
   
6.         return iter(self.items)
   
7. 
   
8. my_list = ListClass([1, 2, 3, 4, 5])
   
9. for item in my_list:
   
10.     print(item)  # 依次输出: 1, 2, 3, 4, 5

复制代码

__next__

返回迭代器的下一个元素，循环遍历获取对象元素时自动调用。

1. class ListClass:
   
2.     def __init__(self, items):
   
3.         self.items = items
   
4.         self.index = 0
   
5. 
   
6.     def __iter__(self):
   
7.         return self
   
8. 
   
9.     def __next__(self):
   
10.         if self.index >= len(self.items):
    
11.             raise StopIteration
    
12.         value = self.items[self.index]
    
13.         self.index += 1
    
14.         return value
    
15. 
    
16. my_list = ListClass([1, 2, 3, 4, 5])
    
17. for item in my_list:
    
18.     print(item)  # 依次输出: 1, 2, 3, 4, 5

复制代码

__eq__

判断两个对象是否相等，两个对象使用 == 判断时自动调用。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __eq__(self, other):
   
7.         return self.x == other.x and self.y == other.y
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. p2 = PointClass(3, 4)
    
11. p3 = PointClass(5, 6)
    
12. print(p1 == p2)  # True
    
13. print(p1 == p3)  # False

复制代码

__abs__

输出对象的绝对值。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __abs__(self):
   
7.         return (self.x * self.x + self.y * self.y) ** 0.5
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. print(abs(p1))  # 5.0

复制代码

__lt__

判断一个对象是否小于另一个对象。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __lt__(self, other):
   
7.         return self.x < other.x and self.y < other.y
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. p2 = PointClass(3, 4)
    
11. p3 = PointClass(5, 6)
    
12. print(p1 < p2)  # False
    
13. print(p1 < p3)  # True

复制代码

__le__

判断一个对象是否小于或等于另一个对象。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __le__(self, other):
   
7.         return self.x <= other.x and self.y <= other.y
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. p2 = PointClass(3, 4)
    
11. p3 = PointClass(5, 6)
    
12. print(p1 <= p2)  # True
    
13. print(p1 <= p3)  # True

复制代码

__gt__

判断一个对象是否大于另一个对象。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __gt__(self, other):
   
7.         return self.x > other.x and self.y > other.y
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. p2 = PointClass(3, 4)
    
11. p3 = PointClass(1, 2)
    
12. print(p1 > p2)  # False
    
13. print(p1 > p3)  # True

复制代码

__ge__

判断一个对象是否大于或等于另一个对象。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __ge__(self, other):
   
7.         return self.x >= other.x and self.y >= other.y
   
8. 
   
9. p1 = PointClass(3, 4)
   
10. p2 = PointClass(3, 4)
    
11. p3 = PointClass(1, 2)
    
12. print(p1 >= p2)  # True
    
13. print(p1 >= p3)  # True

复制代码

__add__

定义对象的加法操作，对象之间使用 + 自动调用。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __add__(self, other):
   
7.         return PointClass(self.x + other.x, self.y + other.y)
   
8. 
   
9.     def __str__(self):
   
10.         return f"({self.x}, {self.y})"
    
11. 
    
12. p1 = PointClass(1, 2)
    
13. p2 = PointClass(3, 4)
    
14. print(p1 + p2)  # (4, 6)

复制代码

__sub__

定义对象的减法操作，对象之间使用 - 自动调用。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __sub__(self, other):
   
7.         return PointClass(self.x - other.x, self.y - other.y)
   
8. 
   
9.     def __str__(self):
   
10.         return f"({self.x}, {self.y})"
    
11. 
    
12. p1 = PointClass(1, 2)
    
13. p2 = PointClass(3, 4)
    
14. print(p1 - p2)  # (-2, -2)

复制代码

__mul__

定义对象的乘法操作，对象之间使用 * 自动调用，可以根据操作数类型进行对象乘法和数乘。

1. class PointClass:
   
2.     def __init__(self, x, y):
   
3.         self.x = x
   
4.         self.y = y
   
5. 
   
6.     def __mul__(self, other):
   
7.         if isinstance(other, PointClass):
   
8.             return PointClass(self.x * other.x, self.y * other.y)
   
9.         elif isinstance(other, int) or isinstance(other, float):
   
10.             return PointClass(self.x * other, self.y * other)
    
11.         else:
    
12.             raise TypeError(f"Unsupported operand type: {type(other)}")
    
13. 
    
14.     def __str__(self):
    
15.         return f"({self.x}, {self.y})"
    
16. 
    
17. p1 = PointClass(1, 2)
    
18. p2 = PointClass(3, 4)
    
19. print(p1 * p2)  # (3, 8)
    
20. print(p1 * 3)  # (3, 6)
    
21. print(p1 * "t")  # TypeError: Unsupported operand type: <class 'str'>

复制代码

__call__

使对象可调用。

1. class Calculator:
   
2. 
   
3.     def __init__(self, x, y):
   
4.         self.x = x
   
5.         self.y = y
   
6. 
   
7.     def __call__(self):
   
8.         return self.x + self.y
   
9. 
   
10. calc = Calculator(3, 4)
    
11. result = calc()
    
12. print(result)  # 7

复制代码

1. class Calculator:
   
2.     def __call__(self, a, b):
   
3.         return a + b
   
4. 
   
5. calc = Calculator()
   
6. result = calc(3, 4)
   
7. print(result)  # 7

复制代码

__getattr__

在访问对象不存在的属性时调用。

1. class Person:
   
2.     def __getattr__(self, name):
   
3.         return f"Attribute '{name}' does not exist."
   
4. 
   
5. p = Person()
   
6. print(p.age)  # Attribute 'age' does not exist.

复制代码

__setattr__

当设置类实例属性时自动调用。

1. class Person:
   
2.     def __setattr__(self, name, value):
   
3.         print(f"Setting attribute '{name}' to '{value}'")
   
4.         super().__setattr__(name, value)
   
5. 
   
6. p = Person()
   
7. p.name = "Alice"  # Setting attribute 'name' to 'Alice'
   
8. print(p.name)  # Alice

复制代码

__delattr__

删除对象属性时自动调用。

1. class Person:
   
2.     def __delattr__(self, name):
   
3.         print(f"Deleting attribute '{name}'")
   
4.         super().__delattr__(name)
   
5. 
   
6. p = Person()
   
7. p.name = "Alice"
   
8. print(p.name)  # Alice
   
9. del p.name  # Deleting attribute 'name'
   
10. print(p.name)  # AttributeError: 'Person' object has no attribute 'name

复制代码

__enter__

__enter__() 方法用于进入上下文管理器所定义的代码块之前执行的操作。

__exit__

上下文管理器的 __exit__() 方法还有三个参数，即异常类型、异常值和追踪信息。如果在 with 语句块中发生了异常，这些参数会传递给 __exit__() 方法，可以在该方法中进行相关的处理。

__del__

当对象不再被引用时，Python的垃圾回收机制会调用这个方法。

1. class FileHandler:
   
2.     def __init__(self, filename):
   
3.         self.filename = filename
   
4. 
   
5.     def __enter__(self):
   
6.         print("goto __enter__ open file")
   
7.         self.file = open(self.filename, 'w', encoding='utf-8')
   
8.         return self.file
   
9. 
   
10.     def __exit__(self, exc_type, exc_val, exc_tb):
    
11.         print("goto __exit__ close file")
    
12.         self.file.close()
    
13. 
    
14.     def __del__(self):
    
15.         print("goto __del__ release resource")
    
16. 
    
17. print("process start")
    
18. with FileHandler("./test.txt") as f:
    
19.     f.write("hello world!\n")
    
20. print("process end")
    
21. # process start
    
22. # goto __enter__ open file
    
23. # goto __exit__ close file
    
24. # goto __del__ release resource
    
25. # process end

复制代码

魔法属性


__dict__

1. __dict__ 

复制代码

包含通过

1. __init__

复制代码

方法初始化的属性和值。

1. class TestClass:
   
2.     def __init__(self, name):
   
3.         self.name = name
   
4. 
   
5.     def test(self):
   
6.         self.age = 25
   
7. 
   
8. obj = TestClass("Alice")
   
9. print(obj.__dict__)  # {'name': 'Alice'}
   
10. # print(TestClass.__dict__)

复制代码

__slots__

内置类属性

1. __slots__

复制代码

是一个特殊的内置类属性，它可以用于定义类的属性名称的集合。一旦在类中定义了

1. __slots__

复制代码

属性，Python 将限制该类的实例只能拥有

1. __slots__

复制代码

中定义的属性。

1. class Person:
   
2.     __slots__ = ('name', 'age')
   
3. 
   
4.     def __init__(self, name, age):
   
5.         self.name = name
   
6.         self.age = age
   
7.         self.address = ""  # AttributeError: 'Person' object has no attribute 'address'
   
8. 
   
9. person = Person("Alice", 30)
   
10. print(person.name)  # 输出 "Alice"
    
11. print(person.age)  # 输出 30
    
12. print(person.__slots__)  # ('name', 'age')

复制代码

总结

到此这篇关于Python中的魔法函数和魔法属性的文章就介绍到这了,更多相关Python魔法函数和魔法属性内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

来源:https://www.jb51.net/python/331135fgh.htm
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！