什么是魔术方法？

在Python中，所有以双下划线__包起来的方法，统称为Magic Method（魔术方法），它是一种的特殊方法，普通方法需要调用，而魔术方法不需要调用就可以自动执行。或许在之前，你不知道这个概念，但我保证，只要你用过Python，那你一定在不经意间用过魔术方法。例如：对于两个字符串，你可能会用“+”号把他们连起来，得到一个合起来之后的字符串：

a = 'Hello, '
b = 'World!'
c = a + b
print(c)

>>>
Hello, World!

但是，按理说，“+”只能对于数使用，字符串之间是不能相加的，那为什么上面那段程序还能够运行呢？这就是魔术方法的功劳了。事实上，因为str类实现了__add__魔术方法，进而实现了运算符重载，所以我们可以通过“+”来实现字符串的拼接。

魔术方法在类或对象的某些事件触发后会自动执行，让类具有神奇的“魔力”。如果希望根据自己的程序定制自己特殊功能的类，那么就需要对这些方法进行重写。例如，如果我们想要实现一个自己的字符串类，在两个长度相等的全是字母的字符串相加时，返回一个结果字符串，它的每个字符是两个字符串相应位置字母表排序更大的那个字母，那么我们就可以重写__add__魔术方法：

class Mystr(str):
    def __init__(self, s):
        self.s = s

    def __add__(self, other):
        res = []
        if len(self.s) != len(other):
            raise ValueError
        else:
            for i in range(len(self.s)):
                if self.s[i] > other[i]:
                    res.append(self.s[i])
                else:
                    res.append(other[i])
            # 此处可简化为
            # res = [self.s[i] if self.s[i] > other[i] 
            #        else other[i] for i in range(len(self.s))]
            return ''.join(res)

a = Mystr('jasndkcaww')
b = Mystr('lopergvmei')
print(a + b)

>>>
losnrkvmww

常用的魔术方法

1. 初始化方法init

触发机制：实例化对象之后立即触发
参数：至少有一个self，接收当前对象，其他参数根据需要进行定义
返回值：无
作用：初始化对象的成员

2. 获取对象长度len

触发时机：使用len(对象) 的时候触发
参数：一个参数self
返回值：必须是一个整型
作用：可以设置为检测对象成员个数，但是也可以进行其他任意操作
注意：返回值必须必须是整数，否则语法报错，另外该要求是格式要求。

3. 构造对象的字符串表示str与repr

触发时机:__str__：使用print(对象)或者str(对象)，__repr__：repr(对象)的时候触发
参数：一个self接收对象
返回值：必须是字符串类型
作用：print（对象时）进行操作，得到字符串，通常用于快捷操作
注意：__repr__更严谨，是主要给机器用的格式，而__str__主要是给用户看的格式

未完待续……

魔术方法大全

方法名	参数列表	调用时机	返回值类型	备注
`__repr__`	`self`	当调用`repr()`函数时	`str`	返回值应为重建该对象的Python表达式（如果可能），或包含其他信息的字符串`<...>`
`__str__`	`self`	当调用`str()`函数时	`str`	调用`print()`等其他函数时会隐式调用`__str__()`，当不存在`__str__()`时会自动调用`__repr__()`
`__format__`	`self, format_spec`	当调用`format()`函数时	`str`	`object.__format__(x, '')`等价于`str(x)`
`__bytes__`	`self`	当调用`bytes()`函数时	`bytes`	返回值是对象的字节表示
`__bool__`	`self`	调用`bool()`函数时	`bool`	当`__bool__`函数没有定义时，会隐式调用`__len__`，如果`__len__`也没有定义，则返回`True`
`__complex__`	`self`	调用`commplex()`函数时	`complex`
`__int__`	`self`	调用`int()`函数时	`int`
`__float__`	`self`	调用`float()`函数时	`float`
`__hash__`	`self`	调用`hash()`	函数时	`hash()`函数将`__hash__()`的返回值截断到`Py_ssize_t`的范围内，64位系统下`Py_ssize_t`为8字节；`set`等类型的操作也会调用对象的`__hash__`函数
`__index__`	`self`	调用`operator.index()`或Python需要整数值时	`int`	当`__int__`、`__float__`、 `__complex__`没有实现时，这些函数隐式地调用`__index__`
`__len__`	`self`	调用`len()`函数时	`int`	返回值必须为非负整数，在CPython中返回值不能超过`sys.maxsize`中定义的值，否则`len()`等函数会抛出`OverflowError`等异常
`__getitemm__`	`self, key`	使用`[]`运算符时（右值）		`key`可以为合法的数组下标，也可以是反向的下标，也可以是序列的切片，该函数应在`key`类型不对应时抛出`TypeError`，`key`超出范围时抛出`IndexError`或`KeyError`（对于映射类型）
`__setitem__`	`self, key, value`	使用`[]`运算符时（左值）	`None`	`key`参数的取值及异常处理与`__getitem__`函数相同
`__delitem__`	`self, key`	使用`del`删除序列中的元素时	`None`	对于不可删除的序列或映射，无需实现该函数，其他同`__getitem__`
`__contains__`	`self, item`	使用`in`作为运算符时	`bool`	对于映射类型，`__contains__`接收的`item`参数对应映射的`key`部分而不是`value`部分。若没有定义该函数，Python首先通过`__iter__`进行查找，其次使用`__getitem__`进行查找
`__iter__`	`self`	调用`iter()`函数或使用循环时		返回值应为可迭代对象，对于可迭代对象，`__iter__`函数返回自身
`__reversed__`	`self`	调用`reversed()`函数时		返回值应为可迭代对象，且是原序列的逆序
`__next__`	`self`	调用`next()`函数时		返回可迭代对象中的下一个元素，当到达最后一个元素时抛出`StopIteration`
`__call__`	`self, args, *kwargs`	当对象以函数的方式被调用时		定义了`__call__`方法的对象属于`typing.Callable`类型
`__enter__`	`self`	使用`with`关键词声明上下文时	`Any`	返回值分配给`as`关键词指明的对象
`__exit__`	`self, exc_type, exc_value, traceback`	离开`with`块时	`Any`	若`with`块执行过程中没有出现异常，则`exc_type, exc_value, traceback`参数均为`None`，否则`exit`块可以对异常进行处理
`__new__`	`cls[, ...]`	创建类实例时	`Any`	`__new__`为静态方法且先于`__init__`执行，`__new__`的其余参数会传递给`__init__`。若`__new__`返回的类型与创建的类型不对应，则不会执行`__init__`
`__init__`	`self, ...`	初始化类实例时	`None`	若基类定义了`__init__`，则在子类的`__init__`中必须有`super().__init()`的显式调用
`__del__`	`self`	对象销毁时	`None`	当对象的引用计数减为0时，对象才可能被删除
`__getattribute__`	`self, name`	使用`self.name`访问对象的属性时	`Any`	为避免无限递归，子类的`__getattribute__`方法的实现中必须包含父类的`__getattribute__`方法调用
`__getattr__`	`self, name`	使用`self.name`访问对象的不存在属性或`__getattribute__`函数抛出`AttributeError`异常	`Any`	当`__getattribute__`正常执行时`__getattr__`不会执行
`__setattr__`	`self, name, value`	使用`self.name`设置属性的值时	`None`	当试图通过`__setattr__`向对象设置属性值时必须通过类型的`__setattr__`方法进行设置
`__delattr__`	`self, name`	执行`del self.name`时	`None`	仅当`del self.name`语句有意义时，才需要实现该方法
`__dir__`	`self`	执行`dir()`函数时	`Sequence`	`dir()`会自动进行排序处理

运算符重载相关的魔术方法：

描述	方法名	运算符
取负	`__neg__`	`-`
取正	`__pos__`	`+`
绝对值	`__abs__`	`abs()`
小于	`__lt__`	`<`
小于等于	`__le__`	`<=`
等于	`__eq__`	`==`
不等于	`__ne__`	`!=`
大于	`__gt__`	`>`
大于等于	`__ge__`	`>=`
相加	`__add__`	`+`
相减	`__sub__`	`-`
相乘	`__mul__`	`*`
实数除	`__truediv__`	`/`
整数除	`__floordiv__`	`//`
取余	`__mod__`	`%`
整数除+取余	`__divmod__`	`divmod()`
乘方	`__pow__`	`**`
取整	`__round__`	`round()`
按位取反	`__invert__`	`~`
左移	`__lshift__`	`<<`
右移	`__rshift__`	`>>`
按位与	`__and__`	`&`
按位或	`__or__`	`
按位异或	`__xor__`	`^`