本文记录Python类中的魔法函数(前后双下划线的函数)的用法。

下划线与类函数、变量 {#下划线与类函数、变量}

Python用下划线作为变量前缀和后缀指定特殊变量、函数

单下划线开头 {#单下划线开头}

• 保护变量，只有类对象和子类对象自己能访问到这些变量
• 不能用 'from module import *' 导入
• 不能直接访问的类属性，需通过类提供的接口进行访问

双下划线开头 {#双下划线开头}

• 私有成员，只有类对象自己能访问，连子类对象也不能访问到这个数据

前后双下划线 {#前后双下划线}

• python里特殊方法专用的标识，也称为保留属性、魔法函数

保留属性、方法 {#保留属性、方法}

| 属性名称 | 含义 | |--------------------------|----------------------------------------------------| | class.__doc__ | 类型帮助信息 | | class.__name__ | 类型名称 | | class.__module__ | 类型所在模块 | | class.__base__ | 类型所继承的基类 | | class.__dict__ | 类型字典，存储所有类型成员信息 | | class.__class__ | 类型 | | class.__bases__ | 返回类的直接父类（实例没有该属性） | | class.__basicsize__ | 类的字节数 | | obj.__sizeof__() | 对象在内存中的字节数 | | class.__mro__ | 类的继承调用顺序 | | class.__subclasses__() | 返回子类列表 | | class.__dictoffset__ | 指向 __dict__ 对象的指针的位置的偏移量，以字节为单位。 | | class.__flags__ | 返回一串数字，用来判断该类型能否被序列化 | | class.__itemsize__ | 这些字段允许计算类型实例的大小（以字节为单位），0是可变长度， 非0则是固定长度 | | x.__slots__() | 只定义特定集合的某些属性，使用之后类变成静态一样，没有了__dict__, 实例也不可新添加属性 |

类相关魔法函数 {#类相关魔法函数}

| 目的 | 所编写代码 | Python 实际调用 | |----------------------------|--------------------------|-------------------------------------------------------| | 初始化一个实例 | x = MyClass() | x.__init__() | | 字符串的"官方"表现形式 | repr(x) | x.__repr__() | | 字符串的"非正式"值 | str(x) | x.__str__() | | 字节数组的"非正式"值 | bytes(x) | x.__bytes__() | | 格式化字符串的值 | format(x, format_spec) | x.__format__(format_spec) | | 类构造器 | x = MyClass() | x.__new__() | | 类析构器 | del x | x.__del__() | | 自定义散列值 | hash(x) | x.__hash__() | | 获取某个属性的值 | x.color | type(x).__dict__['color'\].__get__(x, type(x)) | | 设置某个属性的值 | x.color = 'PapayaWhip' | type(x).__dict__['color'\].__set__(x, 'PapayaWhip') | | 删除某个属性 | del x.color | type(x).__dict__['color'\].__del__(x) | | 控制某个对象是否是该对象的实例 your class | isinstance(x, MyClass) | MyClass.__instancecheck__(x) | | 控制某个类是否是该类的子类 | issubclass(C, MyClass) | MyClass.__subclasscheck__(C) | | 控制某个类是否是该抽象基类的子类 | issubclass(C, MyABC) | MyABC.__subclasshook__(C) | | 不指名调用函数 | x(*args, **kwargs) | x.__call__(*args, **kwargs) |

1. 对 __init__() 方法的调用发生在实例被创建 之后 。如果要控制实际创建进程，请使用 __new__() 方法。
2. 按照约定， __repr__() 方法所返回的字符串为合法的 Python 表达式。
3. 在调用 print(x) 的同时也调用了 __str__() 方法。
4. 由于 bytes 类型的引入而从 Python 3 开始出现。

迭代器相关 {#迭代器相关}

| 目的 | 所编写代码 | Python 实际调用 | |-------------|-----------------|----------------------| | 遍历某个序列 | iter(seq) | seq.__iter__() | | 从迭代器中获取下一个值 | next(seq) | seq.__next__() | | 按逆序创建一个迭代器 | reversed(seq) | seq.__reversed__() |

1. 无论何时创建迭代器都将调用 __iter__() 方法。这是用初始值对迭代器进行初始化的绝佳之处。
2. 无论何时从迭代器中获取下一个值都将调用 __next__() 方法。
3. __reversed__() 方法并不常用。它以一个现有序列为参数，并将该序列中所有元素从尾到头以逆序排列生成一个新的迭代器。

属性相关 {#属性相关}

| 目的 | 所编写代码 | Python 实际调用 | |----------------|--------------------------------------------|--------------------------------------| | 获取一个计算属性（无条件的） | x.my_property/ getattr(x, my_property) | x.__getattribute__('my_property') | | 获取一个计算属性（后备） | x.my_property/ getattr(x, my_property) | x.__getattr__('my_property') | | 设置某属性 | x.my_property = value | x.__setattr__('my_property',value) | | 删除某属性 | del x.my_property | x.__delattr__('my_property') | | 列出所有属性和方法 | dir(x) | x.__dir__() |

1. 如果某个类定义了 __getattribute__() 方法，在 每次引用属性或方法名称时 Python 都调用它（特殊方法名称除外，因为那样将会导致讨厌的无限循环）。
2. 如果某个类定义了 __getattr__() 方法，Python 将只在正常的位置查询属性时才会调用它。如果实例 x 定义了属性color， x.color 将 不会 调用x.__getattr__('color')；而只会返回x.color 已定义好的值。
3. 无论何时给属性赋值，都会调用 __setattr__() 方法。
4. 无论何时删除一个属性，都将调用 __delattr__() 方法。
5. 如果定义了 __getattr__() 或 __getattribute__() 方法， __dir__() 方法将非常有用。通常，调用 dir(x) 将只显示正常的属性和方法。如果__getattr()__方法动态处理color 属性， dir(x) 将不会将 color 列为可用属性。可通过覆盖 __dir__() 方法允许将 color 列为可用属性，对于想使用你的类但却不想深入其内部的人来说，该方法非常有益。

索引相关 {#索引相关}

| 目的 | 所编写代码 | Python 实际调用 | |---------------|----------------------|----------------------------------| | 序列的长度 | len(seq) | seq.__len__() | | 了解某序列是否包含特定的值 | x in seq | seq.__contains__(x) | | 通过键来获取值 | x[key] | x.__getitem__(key) | | 通过键来设置值 | x[key] = value | x.__setitem__(key,value) | | 删除一个键值对 | del x[key] | x.__delitem__(key) | | 为缺失键提供默认值 | x[nonexistent_key] | x.__missing__(nonexistent_key) | | 切片 | x[i:j] | x.__getslice__(i, j) | | 包含 | y in x | x.__contains__(y) |

比较相关 {#比较相关}

我将此内容从前一节中拿出来使其单独成节，是因为"比较"操作并不局限于数字。许多数据类型都可以进行比较------字符串、列表，甚至字典。如果要创建自己的类，且对象之间的比较有意义，可以使用下面的特殊方法来实现比较。

| 目的 | 所编写代码 | Python 实际调用 | |-------------|-------------|----------------| | 相等 | x == y | x.__eq__(y) | | 不相等 | x != y | x.__ne__(y) | | 小于 | x < y | x.__lt__(y) | | 小于或等于 | x <= y | x.__le__(y) | | 大于 | x > y | x.__gt__(y) | | 大于或等于 | x >= y | x.__ge__(y) | | 布尔上下文环境中的真值 | if x: | x.__bool__() | | sort 函数中的比较 | list.sort | x.__cmp__(y) |

序列化相关 {#序列化相关}

Python 支持任意对象的序列化和反序列化。（多数 Python 参考资料称该过程为 "pickling" 和 "unpickling"）。该技术对与将状态保存为文件并在稍后恢复它非常有意义。所有的内置数据类型 均已支持 pickling 。如果创建了自定义类，且希望它能够 pickle，阅读 pickle 协议了解下列特殊方法何时以及如何被调用。

| 目的 | 所编写代码 | Python 实际调用 | |--------------------------|------------------------------------------|-------------------------------------| | 自定义对象的复制 | copy.copy(x) | x.__copy__() | | 自定义对象的深度复制 | copy.deepcopy(x) | x.__deepcopy__() | | 在 pickling 之前获取对象的状态 | pickle.dump(x, file) | x.__getstate__() | | 序列化某对象 | pickle.dump(x, file) | x.__reduce__() | | 序列化某对象（新 pickling 协议） | pickle.dump(x, file, protocol_version) | x.__reduce_ex__(protocol_version) | | 控制 unpickling 过程中对象的创建方式 | x = pickle.load(file) | x.__getnewargs__() | | 在 unpickling 之后还原对象的状态 | x = pickle.load(file) | x.__setstate__() | | 返回一串数字，用来判断该类型能否被序列化 | class.__flags__ | class.__flags__ |

要重建序列化对象，Python 需要创建一个和被序列化的对象看起来一样的新对象，然后设置新对象的所有属性。__getnewargs__() 方法控制新对象的创建过程，而 __setstate__() 方法控制属性值的还原方式。

with 语块相关 {#with-语块相关}

with 语块定义了运行时刻上下文环境；在执行 with 语句时将"进入"该上下文环境，而执行该语块中的最后一条语句将"退出"该上下文环境。

| 目的 | 所编写代码 | Python 实际调用 | |------------------------|-----------|-----------------| | 在进入 with 语块时进行一些特别操作 | with x: | x.__enter__() | | 在退出 with 语块时进行一些特别操作 | with x: | x.__exit__() |

以下是 with file 习惯用法 的运作方式：

1. 该文件对象同时定义了一个 __enter__() 和一个 __exit__() 方法。该 __enter__() 方法检查文件是否处于打开状态；如果没有， _checkClosed()方法引发一个例外。
2. __enter__() 方法将始终返回 self ------ 这是 with 语块将用于调用属性和方法的对象
3. 在 with 语块结束后，文件对象将自动关闭。怎么做到的？在 __exit__() 方法中调用了 self.close() .

该 __exit__() 方法将总是被调用，哪怕是在 with 语块中引发了例外。实际上，如果引发了例外，该例外信息将会被传递给 __exit__() 方法。查阅 With 状态上下文环境管理器了解更多细节。

计算相关 {#计算相关}

| 目的 | 所编写代码 | Python 实际调用 | |----------------------------------|----------|------------------| | 重载 + 运算符 | x + y | x.__add__(y) | | 重载 - 运算符 | x - y | x.__sub__(y) | | 重载 % 运算符 | x % y | x.__mod__(y) | | 重载 * 乘法运算符 | x * y | x.__mul__(y) | | 重载 * 乘法运算符（y.__mul__(x)失败时调用） | y * x | x.__rmul__(y) |

参考资料 {#参考资料}

• https://www.cnblogs.com/nkwy2012/p/6264031.html
• https://www.liaoxuefeng.com/wiki/897692888725344/923030542875328

文章链接：
https://www.zywvvd.com/notes/coding/python/python-magic-func/python-magic-func/