全网最适合入门的面向对象编程教程：44 Python 内置函数与魔法方法-重写内置类型的魔法方法

本文档主要介绍如何使用 Python 进行面向对象编程，需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言，本文档更加详细、侧重于嵌入式上位机应用，以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例，同时使用 Sourcetrail 代码软件对代码进行可视化阅读便于读者理解。

相关示例代码获取链接如下：https://github.com/leezisheng/Python-OOP-Demo

正文

Python 内置函数与魔法方法

Python 中有许多函数可以针对特定类型的对象执行某些任务或计算结果，这些函数不需要是某些底层类的方法。它们通常是抽象出来的一些常用计算，可以应用于多种类型的类。这些函数统称内置函数，我们往往使用内置函数调用对象的魔法方法，所谓魔法方法(Magic Method)是 python 内置方法，以两个下划线开头、两个下划线结尾，它不需要主动调用，存在的目的是为了给 python 的解释器进行调用。常见内置函数有以下这些：

最简单的例子就是 len()内置函数，它可以数出某种容器对象中的项目数，例如字典或列表。实际上，列表对象并没有 len 长度属性，你可能不相信，那就让我们查看一下列表 List 的属性值。输入如下代码：

print(list.__dict__)

我们来看一下输出：

{'__new__': <built-in method __new__ of type object at 0x00007FF9D4D5B6D0>,

 '__repr__': <slot wrapper '__repr__' of 'list' objects>, '__hash__': None,

'__getattribute__': <slot wrapper '__getattribute__' of 'list' objects>,

'__lt__': <slot wrapper '__lt__' of 'list' objects>, '__le__': <slot wrapper

'__le__' of 'list' objects>, '__eq__': <slot wrapper '__eq__' of 'list' objects>,

'__ne__': <slot wrapper '__ne__' of 'list' objects>,

'__gt__': <slot wrapper '__gt__' of 'list' objects>, '__ge__': <slot wrapper '__ge__' of 'list' objects>, '__iter__': <slot wrapper '__iter__' of 'list' objects>,

'__init__': <slot wrapper '__init__' of 'list' objects>, '__len__': <slot wrapper '__len__' of 'list' objects>,

 '__getitem__': <method '__getitem__' of 'list' objects>, '__setitem__': <slot wrapper '__setitem__' of 'list' objects>,

 '__delitem__': <slot wrapper '__delitem__' of 'list' objects>, '__add__': <slot wrapper '__add__' of 'list' objects>,

 '__mul__': <slot wrapper '__mul__' of 'list' objects>, '__rmul__': <slot wrapper '__rmul__' of 'list' objects>,

'__contains__': <slot wrapper '__contains__' of 'list' objects>, '__iadd__': <slot wrapper '__iadd__' of 'list' objects>, '__imul__': <slot wrapper '__imul__' of 'list' objects>,

 '__reversed__': <method '__reversed__' of 'list' objects>, '__sizeof__': <method '__sizeof__' of 'list' objects>,

 'clear': <method 'clear' of 'list' objects>, 'copy': <method 'copy' of 'list' objects>, 'append': <method 'append' of 'list' objects>,

 'insert': <method 'insert' of 'list' objects>, 'extend': <method 'extend' of 'list' objects>, 'pop': <method 'pop' of 'list' objects>,

'remove': <method 'remove' of 'list' objects>, 'index': <method 'index' of 'list' objects>, 'count': <method 'count' of 'list' objects>,

 'reverse': <method 'reverse' of 'list' objects>, 'sort': <method 'sort' of 'list' objects>, '__class_getitem__': <method '__class_getitem__' of 'list' objects>,

'__doc__': 'Built-in mutable sequence.\n\nIf no argument is given, the constructor creates a new empty list.\nThe argument m

我丢，还真没有，这是怎么回事？那为什么我们用 len()函数居然能得到列表的长度？从理论上来说，列表是有长度属性的。len()应用到的大部分对象都有一个被称为 len()的方法，其返回同样的值。因此 len(list)就是调用 list.len()（len()为内置函数、len 为魔法方法） 。

那么为什么不用__len__方法而要用 len()函数？

很明显 len 是一个特殊的双下画线方法，这意味着我们不应该直接调用它，主要的原因是效率，利用内置函数调用魔法方法不仅提供额外的服务，而且解释器做了优化，会比调用方法更快。通过调用 len()函数，我们可以直接访问 Python 可变长度容器的底层 C 语言中 PyVarObject 结构体的 ob_size 字段，该字段保存着容器中的项数。 len(my_object)直接读取 ob_size 字段的值，这比调用 len 方法快很多。

另一个原因是可维护性。Python 开发者可能会在未来修改 len()来计算没有 len 方法的对象的长度，例如，通过计数迭代器返回的项目。那么他们只需要修改一个函数而不是所有的 len 方法。

除了__len__的例子外，最常见的例子就是要拿到一个列表的某个元素，可以使用对应的引索进行取值，比如 list[key]，这背后利用的是__getitem__方法，为了拿到 my_list[key]的值，解释器实际上会调用 my_list.getitem(key)。

那么如何得到 Python 内置数据类型的这些特殊方法呢？非常简单，只需要应用 dir([object])函数即可，dir()函数可以返回对象的属性、方法列表。以 List 列表类为例，我们只需要输入以下语句即可：

print(dir(list))

输出如下：

['__add__', '__class__', '__class_getitem__', '__contains__', '__delattr__',

'__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__',

'__getattribute__', '__getitem__', '__getstate__', '__gt__', '__hash__',

'__iadd__', '__imul__', '__init__', '__init_subclass__', '__iter__', '__le__',

'__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__',

'__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__',

'__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear',

'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

此外，如果想要知道如何使用这些方法，可以用 help 函数：

print(help(list.__le__))

输出如下：

实际上，python 中常见的魔法方法大致可分为以下几类：构造与初始化、类的表示、操作符、访问控制、容器类操作、可调用对象、序列化操作等。我们在下图中对常用魔法方法进行了总结：

重写内置类型的魔法方法

重写是子类对父类的允许访问的方法的实现过程进行重新编写, 返回值和形参都不能改变。重写的好处在于子类可以根据需要，定义特定于自己的行为。

这里以魔法方法中的__repr__方法和__ str__方法讲解如何重写内置类型的魔法方法。

所谓 repr 是 Python 类中的一个特殊方法，由 object 对象提供，由于所有类都是 object 类的子类，所以都会继承该方。它是一个”自我描述“的方法，此方法通常实现这样的功能：当直接打印类的实例化对象时，系统将会输出对象的自我描述信息，用来告诉外界对象具有的状态信息。通常情况下，直接输出某个实例化对象，本意往往是想了解该对象的基本信息，例如该对象有哪些属性，它们的值各是多少等等。但是由于 object 提供的这个 repr 方法总是返回一个对象，（类名 + obejct at + 内存地址），这个值并不能真正实现自我描述的功能。因此，如果你想在自定义类中实现“自我描述” 的功能，那么必须重写 repr 方法。

与 repr 类似的是__ str__方法，repr 和 str 这两个方法都是用于显示的，str 是面向用户的，而 repr 面向程序员:

打印操作会首先尝试 str 和 str 内置函数(print 运行的内部等价形式)，它通常应该返回一个友好的显示；
repr 用于所有其他的环境中：用于交互模式下提示回应以及 repr 函数，如果没有使用 str，会使用 print 和 str。它通常应该返回一个编码字符串，可以用来重新创建对象，或者给开发者详细的显示。

同时，我们也可以对算数操作符进行重写，在上述列表实现集合的例子中，如下代码就是对算数操作符进行重写：

_# 运算符&重载，求交集_

    def __and__(self, other):

        return self.intersect(other)

    _# 运算符|重载，求合集_

    def __or__(self, other):

        return self.union(other)

    _# 当直接打印类的实例化对象时，系统将会输出对象的自我描述信息_

    def __repr__(self):

        return 'Set:' + repr(self.data)

再列举一个有趣的例子，对算数操作符方法重写进行说明，以下代码创建一个特殊的整数，每当将两个这种整数相加时都会返回 0：

class SillyInt(int):

    _# 重写__add__方法_

    def __add__(self, num):

        return 0

a = SillyInt(1)

b = SillyInt(2)

print(a+b)

如下为运行结果，尽管这个例子没有什么实际应用的例子，但还是能很好的讲述如何对算数操作符方法进行重写：

重写后的__add__方法可以添加到任何我们自己写的类中，如果我对这个类的实例使用 + 操作符，将会调用__add__。例如，字符串、元组以及列表的连接就是这么实现的。所有的特殊方法都是这样的。如果想要对自定义的对象使用 x in myobj 语法，可以实现__contains__方法。如果想要用 myobj[i] = value 语法，只需要提供__setitem__方法。如果想用 something = myobj[i]，需要实现__getitem__。