25 - 面向对象高级-魔术方法基础

1 魔术方法

在Python中以两个下划线开头和结尾的方法，比如：__init__、__str__、__doc__、__new__等，被称为"魔术方法"（Magic methods）。魔术方法在类或对象的某些事件出发后会自动执行，如果希望根据自己的程序定制自己特殊功能的类，那么就需要对这些方法进行重写。

Python 将所有以 __（两个下划线）开头和结尾的类方法保留为魔术方法。所以在定义类方法时，除了上述魔术方法，建议不要以 __ 为前缀。

2 类的魔术方法

我们将不同类型的魔术方法进行归类，那么会分为以下几类。

2.1 基本的魔法方法和常用属性

魔术方法	含义
__new__(cls[, …])	1. __new__ 是在一个对象实例化的时候所调用的第一个方法 2. 它的第一个参数是这个类，其他的参数是用来直接传递给 __init__ 方法 3. __new__ 决定是否要使用该 __init__ 方法，因为 __new__ 可以调用其他类的构造方法或者直接返回别的实例对象来作为本类的实例，如果 __new__ 没有返回实例对象，则 __init__ 不会被调用 4. __new__ 主要是用于继承一个不可变的类型比如一个 tuple 或者 string
__init__(self[, …])	构造器，当一个实例被创建的时候调用的初始化方法
__del__(self)	析构器，当一个实例被销毁的时候调用的方法
__call__(self[, args…])	允许一个类的实例像函数一样被调用：x(a, b) 调用 x.__call__(a, b)
__len__(self)	定义当被 len() 调用时的行为
__repr__(self)	定义当被 repr() 调用或者直接执行对象时的行为
__str__(self)	定义当被 str() 调用或者打印对象时的行为
__bytes__(self)	定义当被 bytes() 调用时的行为
__hash__(self)	定义当被 hash() 调用时的行为
__bool__(self)	定义当被 bool() 调用时的行为，应该返回 True 或 False
__format__(self, format_spec)	定义当被 format() 调用时的行为
__name__	类、函数、方法等的名字
__module__	类定义所在的模块名
__class__	对象或类所属的类
__bases__	类的基类元组，顺序为它们在基类列表中出现的顺序
__doc__	类、函数的文档字符串，如果没有定义则为None
__mro__	类的mro,class.mro()返回的结果保存在__mro__中
__dict__	类或实例的属性，可写的字典

2.2 有关属性

魔术方法	含义
__getattr__(self, name)	定义当用户试图获取一个不存在的属性时的行为
__getattribute__(self, name)	定义当该类的属性被访问时的行为
__setattr__(self, name, value)	定义当一个属性被设置时的行为
__delattr__(self, name)	定义当一个属性被删除时的行为
__dir__(self)	定义当 dir() 被调用时的行为
__get__(self, instance, owner)	定义当描述符的值被取得时的行为
__set__(self, instance, value)	定义当描述符的值被改变时的行为
__delete__(self, instance)	定义当描述符的值被删除时的行为

2.3 比较操作符

魔术方法	含义
__lt__(self, other)	定义小于号的行为：x < y 调用 x.__lt__(y)
__le__(self, other)	定义小于等于号的行为：x <= y 调用 x.__le__(y)
__eq__(self, other)	定义等于号的行为：x == y 调用 x.__eq__(y)
__ne__(self, other)	定义不等号的行为：x != y 调用 x.__ne__(y)
__gt__(self, other)	定义大于号的行为：x > y 调用 x.__gt__(y)
__ge__(self, other)	定义大于等于号的行为：x >= y 调用 x.__ge__(y)

2.4 算数运算符

魔术方法	含义
__add__(self, other)	定义加法的行为：+
__sub__(self, other)	定义减法的行为：-
__mul__(self, other)	定义乘法的行为：*
__truediv__(self, other)	定义真除法的行为：/
__floordiv__(self, other)	定义整数除法的行为：//
__mod__(self, other)	定义取模算法的行为：%
__divmod__(self, other)	定义当被 divmod() 调用时的行为
__pow__(self, other[, modulo])	定义当被 power() 调用或 ** 运算时的行为
__lshift__(self, other)	定义按位左移位的行为：<<
__rshift__(self, other)	定义按位右移位的行为：>>
__and__(self, other)	定义按位与操作的行为：&
__xor__(self, other)	定义按位异或操作的行为：^
__or__(self, other)	定义按位或操作的行为：

2.5 反运算

魔术方法	含义
__radd__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rsub__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rmul__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rtruediv__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rfloordiv__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rmod__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rdivmod__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rpow__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rlshift__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rrshift__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rand__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__rxor__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）
__ror__(self, other)	（与上方相同，当左操作数不支持相应的操作时被调用）

2.6 增量赋值运算

魔术方法	含义
__iadd__(self, other)	定义赋值加法的行为：+=
__isub__(self, other)	定义赋值减法的行为：-=
__imul__(self, other)	定义赋值乘法的行为：*=
__itruediv__(self, other)	定义赋值真除法的行为：/=
__ifloordiv__(self, other)	定义赋值整数除法的行为：//=
__imod__(self, other)	定义赋值取模算法的行为：%=
__ipow__(self, other[, modulo])	定义赋值幂运算的行为：**=
__ilshift__(self, other)	定义赋值按位左移位的行为：<<=
__irshift__(self, other)	定义赋值按位右移位的行为：>>=
__iand__(self, other)	定义赋值按位与操作的行为：&=
__ixor__(self, other)	定义赋值按位异或操作的行为：^=
__ior__(self, other)	定义赋值按位或操作的行为：

2.7 一元操作符

魔术方法	含义
__pos__(self)	定义正号的行为：+x
__neg__(self)	定义负号的行为：-x
__abs__(self)	定义当被 abs() 调用时的行为
__invert__(self)	定义按位求反的行为：~x

2.8 类型转换

魔术方法	含义
__complex__(self)	定义当被 complex() 调用时的行为（需要返回恰当的值）
__int__(self)	定义当被 int() 调用时的行为（需要返回恰当的值）
__float__(self)	定义当被 float() 调用时的行为（需要返回恰当的值）
__round__(self[, n])	定义当被 round() 调用时的行为（需要返回恰当的值）
__index__(self)	1. 当对象是被应用在切片表达式中时，实现整形强制转换 2. 如果你定义了一个可能在切片时用到的定制的数值型,你应该定义 __index__ 3. 如果 __index__ 被定义，则 __int__ 也需要被定义，且返回相同的值

2.9 上下文管理（with 语句）

魔术方法	含义
__enter__(self)	1. 定义当使用 with 语句时的初始化行为 2. __enter__ 的返回值被 with 语句的目标或者 as 后的名字绑定
__exit__(self, exc_type, exc_value, traceback)	1. 定义当一个代码块被执行或者终止后上下文管理器应该做什么 2. 一般被用来处理异常，清除工作或者做一些代码块执行完毕之后的日常工作

2.10 容器类型

魔术方法	含义
__len__(self)	定义当被 len() 调用时的行为（返回容器中元素的个数）
__getitem__(self, key)	定义获取容器中指定元素的行为，相当于 self[key]
__setitem__(self, key, value)	定义设置容器中指定元素的行为，相当于 self[key] = value
__delitem__(self, key)	定义删除容器中指定元素的行为，相当于 del self[key]
__iter__(self)	定义当迭代容器中的元素的行为
__reversed__(self)	定义当被 reversed() 调用时的行为
__contains__(self, item)	定义当使用成员测试运算符（in 或 not in）时的行为

3 常用方法

上面基本上是Python中类的所有魔术方法了，下面针对一些重要的常用的方法进行说明。

3.1 查看属性

方法	意义
__dir__()	返回类或者对象的所有成员的名称列表 dir()函数操作实例调用的就是__dir__()

        当dir(obj)时，obj的__dir__()方法被调用，如果当前实例不存在该方法，则按照mro开始查找，如果父类都没有定义，那么最终会找到object.__dir__()方法，该方法会最大程度的收集属性信息。

class A:
    def __dir__(self):
        return 'ab'

class B(A):
    pass

print(dir(A)) # ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__']

print(dir(B())) # ['a', 'b']

dir(obj)对于不同类型的对象obj具有不同的行为：

1. 如果对象是模块对象，返回的列表包含模块的属性和变量名
2. 如果对象是类型或者说是类对象，返回的列表包含类的属性名，及它的祖先类的属性名
3. 如果是类的实例
   • 有__dir__方法，则返回__dir__方法的返回值(必须可迭代)
   • 没有__dir__方法，则尽可能的收集实例的属性名、类的属性和祖先类的属性名，组成列表返回。
4. 如果dir没有参数，返回列表包含的内容也不同。
   • 在模块中，返回模块的属性和变量名(和globals()结果相同)
   • 在函数中，返回本地作用域的变量名(和locals()结果相同)
   • 在方法中，返回本地作用域的变量名(和locals()结果相同)

locals()运行在全局时，结果和globals()相同

3.2 实例化

方法	含义
__new__	实例化一个对象 该方法需要返回一个值，如果该值不是cls的实现，则不会调用__init__ 该方法永远都是静态方法

class A:
    def __new__(cls, *args, **kwargs):
        print(cls)  # <class '__main__.A'>
        print(args)  # ('daxin',)
        print(kwargs)  # {'age': 20}

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


daxin = A('daxin', age=20)
print(daxin.name)  # 'NoneType' object has no attribute 'name'

分析：

1. 实例化时执行__new__函数，进行实例化操作。
2. 前面学的__init__函数，我们知道它必须返回None，所以构建好的实例应该是在__new__函数中返回的。
3. 顺序：__new__构建实例，调用__init__函数进行初始化，然后由__new__函数返回实例。
4. 我们不知道实例到底是如何实例化的，所以这里可以使用super函数