Chapter B 特殊方法名称

" My specialty is being right when other people are wrong. " — George Bernard Shaw

深入

在本书其它几处，我们已经见识过一些特殊方法——即在使用某些语法时 Python 所调用的“神奇”方法。使用特殊方法，类用起来如同序列、字典、函数、迭代器，或甚至像个数字！本附录为我们已经见过特殊方法提供了参考，并对一些更加深奥的特殊方法进行了简要介绍。

基础知识

如果曾阅读 《类的简介》一章，你可能已经见识过了最常见的特殊方法： __init__() 方法。盖章结束时，我写的类多数需要进行一些初始化工作。还有一些其它的基础特殊方法对调试自定义类也特别有用。

1. 对 __init__() 方法的调用发生在实例被创建 之后 。如果要控制实际创建进程，请使用 __new__() 方法。
2. 按照约定， __repr__() 方法所返回的字符串为合法的 Python 表达式。
3. 在调用 print(x) 的同时也调用了 __str__() 方法。
4. 由于 bytes 类型的引入而从 Python 3 开始出现。
5. 按照约定，format_spec 应当遵循 迷你语言格式规范【Format Specification Mini-Language】。Python 标准类库中的 decimal.py 提供了自己的 __format__() 方法。

行为方式与迭代器类似的类

在 《迭代器》一章中，我们已经学习了如何使用 __iter__() 和 __next__() 方法从零开始创建迭代器。

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

正如我们在 《迭代器》一章中看到的，for 循环也可用作迭代器。在下面的循环中：

for x in seq:
    print(x)

Python 3 将会调用 seq.__iter__() 以创建一个迭代器，然后对迭代器调用 __next__() 方法以获取 x 的每个值。当 __next__() 方法引发 StopIteration 例外时， for 循环正常结束。

计算属性

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 列为可用属性，对于想使用你的类但却不想深入其内部的人来说，该方法非常有益。

__getattr__() 和 __getattribute__() 方法的区别非常细微，但非常重要。可以用两个例子来解释一下：

class Dynamo:
    def __getattr__(self, key):

            return 'PapayaWhip'
        else:

>>> dyn = Dynamo()

'PapayaWhip'
>>> dyn.color = 'LemonChiffon'

'LemonChiffon'

1. 属性名称以字符串的形式传入 __getattr()__ 方法。如果名称为 'color'，该方法返回一个值。（在此情况下，它只是一个硬编码的字符串，但可以正常地进行某些计算并返回结果。）
2. 如果属性名称未知， __getattr()__ 方法必须引发一个 AttributeError 例外，否则在访问未定义属性时，代码将只会默默地失败。（从技术角度而言，如果方法不引发例外或显式地返回一个值，它将返回 None ——Python 的空值。这意味着 所有 未显式定义的属性将为 None，几乎可以肯定这不是你想看到的。）
3. dyn 实例没有名为 color 的属性，因此在提供计算值时将调用 __getattr__() 。
4. 在显式地设置 dyn.color 之后，将不再为提供 dyn.color 的值而调用 __getattr__() 方法，因为 dyn.color 已在该实例中定义。

另一方面，__getattribute__() 方法是绝对的、无条件的。

class SuperDynamo:
    def __getattribute__(self, key):
        if key == 'color':
            return 'PapayaWhip'
        else:
            raise AttributeError

>>> dyn = SuperDynamo()

'PapayaWhip'
>>> dyn.color = 'LemonChiffon'

'PapayaWhip'

1. 在获取 dyn.color 的值时将调用 __getattribute__() 方法。
2. 即便已经显式地设置 dyn.color，在获取 dyn.color 的值时, 仍将调用 __getattribute__() 方法。如果存在 __getattribute__() 方法，将在每次查找属性和方法时 无条件地调用 它，哪怕在创建实例之后已经显式地设置了属性。

☞ 如果定义了类的 __getattribute__() 方法，你可能还想定义一个 __setattr__() 方法，并在两者之间进行协同，以跟踪属性的值。否则，在创建实例之后所设置的值将会消失在黑洞中。

必须特别小心 __getattribute__() 方法，因为 Python 在查找类的方法名称时也将对其进行调用。

class Rastan:
    def __getattribute__(self, key):

    def swim(self):
        pass

>>> hero = Rastan()

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in __getattribute__
AttributeError

1. 该类定义了一个总是引发 AttributeError 例外的 __getattribute__() 方法。没有属性或方法的查询会成功。
2. 调用 hero.swim() 时，Python 将在 Rastan 类中查找 swim() 方法。该查找将执行整个 __getattribute__() 方法，因为所有的属性和方法查找都通过 __getattribute__() 方法。在此例中， __getattribute__() 方法引发 AttributeError 例外，因此该方法查找过程将会失败，而方法调用也将失败。

行为方式与函数类似的类

可以让类的实例变得可调用——就像函数可以调用一样——通过定义 __call__() 方法。

zipfile 模块 通过该方式定义了一个可以使用给定密码解密 经加密 zip 文件的类。该 zip 解密 算法需要在解密的过程中保存状态。通过将解密器定义为类，使我们得以在 decryptor 类的单个实例中对该状态进行维护。状态在 __init__() 方法中进行初始化，如果文件 经加密 则进行更新。但由于该类像函数一样“可调用”，因此可以将实例作为 map() 函数的第一个参数传入，代码如下：

# excerpt from zipfile.py
class _ZipDecrypter:
.
.
.
    def __init__(self, pwd):

        self.key1 = 591751049
        self.key2 = 878082192
        for p in pwd:
            self._UpdateKeys(p)

        assert isinstance(c, int)
        k = self.key2 | 2
        c = c ^ (((k * (k^1)) >> 8) & 255)
        self._UpdateKeys(c)
        return c
.
.
.

bytes = zef_file.read(12)

1. _ZipDecryptor 类维护了以三个旋转密钥形式出现的状态，该状态稍后将在 _UpdateKeys() 方法中更新（此处未展示）。
2. 该类定义了一个 __call__() 方法，使得该类可像函数一样调用。在此例中，__call__() 对 zip 文件的单个字节进行解密，然后基于经解密的字节对旋转密码进行更新。
3. zd 是 _ZipDecryptor 类的一个实例。变量 pwd 被传入 __init__() 方法，并在其中被存储和用于首次旋转密码更新。
4. 给出 zip 文件的头 12 个字节，将这些字节映射给 zd 进行解密，实际上这将导致调用 __call__() 方法 12 次，也就是 更新内部状态并返回结果字节 12 次。

行为方式与序列类似的类

如果类作为一系列值的容器出现——也就是说如果对某个类来说，是否“包含”某值是件有意义的事情——那么它也许应该定义下面的特殊方法已，让它的行为方式与序列类似。

cgi 模块 在其 FieldStorage 类中使用了这些方法，该类用于表示提交给动态网页的所有表单字段或查询参数。

# A script which responds to http://example.com/search?q=cgi
import cgi
fs = cgi.FieldStorage()

  do_search()

# An excerpt from cgi.py that explains how that works
class FieldStorage:
.
.
.

        if self.list is None:
            raise TypeError('not indexable')

1. 一旦创建了 cgi.FieldStorage 类的实例，就可以使用 “in” 运算符来检查查询字符串中是否包含了某个特定参数。
2. 而 __contains__() 方法是令该魔法生效的主角。
3. 如果代码为 if 'q' in fs，Python 将在 fs 对象中查找 __contains__() 方法，而该方法在 cgi.py 中已经定义。'q' 的值被当作 key 参数传入 __contains__() 方法。
4. 同样的 FieldStorage 类还支持返回其长度，因此可以编写代码 len(fs) 而其将调用 FieldStorage 的 __len__() 方法，并返回其识别的查询参数个数。
5. self.keys() 方法检查 self.list is None 是否为真值，因此 __len__ 方法无需重复该错误检查。

行为方式与字典类似的类

在前一节的基础上稍作拓展，就不仅可以对 “in” 运算符和 len() 函数进行响应，还可像全功能字典一样根据键来返回值。

cgi 模块 的 FieldStorage 类 同样定义了这些特殊方法，也就是说可以像下面这样编码：

# A script which responds to http://example.com/search?q=cgi
import cgi
fs = cgi.FieldStorage()
if 'q' in fs:

# An excerpt from cgi.py that shows how it works
class FieldStorage:
.
.
.

        if self.list is None:
            raise TypeError('not indexable')
        found = []
        for item in self.list:
            if item.name == key: found.append(item)
        if not found:
            raise KeyError(key)
        if len(found) == 1:
            return found[0]
        else:
            return found

1. fs 对象是 cgi.FieldStorage 类的一个实例，但仍然可以像 fs['q'] 这样估算表达式。
2. fs['q'] 将 key 参数设置为 'q' 来调用 __getitem__() 方法。然后它将在其内部维护的查询参数列表 (self.list) 中查找一个 .name 与给定键相符的字典项。

行为方式与数值类似的类

使用适当的特殊方法，可以将类的行为方式定义为与数字相仿。也就是说，可以进行相加、相减，并进行其它数学运算。这就是 分数 的实现方式—— Fraction 类实现了这些特殊方法，然后就可以进行下列运算了：

>>> from fractions import Fraction
>>> x = Fraction(1, 3)
>>> x / 3
Fraction(1, 9)

以下是实现“类数字”类的完整特殊方法清单：

如果 x 是某个实现了所有这些方法的类的实例，那么万事大吉。但如果未实现其中之一呢？或者更糟，如果实现了，但却无法处理某几类参数会怎么样？例如：

>>> from fractions import Fraction
>>> x = Fraction(1, 3)
>>> 1 / x
Fraction(3, 1)

这并 不是 传入一个 分数 并将其除以一个整数（如前例那样）的情况。前例中的情况非常直观： x / 3 调用 x.__truediv__(3)，而Fraction 的 __truediv__() 方法处理所有的数学运算。但整数并不“知道”如何对分数进行数学计算。因此本例该如何运作呢？

和 反映操作 相关的还有第二部分算数特殊方法。给定一个二元算术运算 （例如： x / y），有两种方法来实现它：

1. 告诉 x 将自己除以 y，或者
2. 告诉 y 去除 x

之前提到的特殊方法集合采用了第一种方式：对于给定 x / y，它们为 x 提供了一种途径来表述“我知道如何将自己除以 y。”下面的特殊方法集合采用了第二种方法：它们向 y 提供了一种途径来表述“我知道如何成为分母，并用自己去除 x。”

但是等一下！还有更多特殊方法！如果在进行“原地”操作，如： x /= 3，还可定义更多的特殊方法。

注意：多数情况下，并不需要原地操作方法。如果未对特定运算定义“就地”方法，Python 将会试着使用（普通）方法。例如，为执行表达式 x /= y，Python 将会：

1. 试着调用 x.__itruediv__(y)。如果该方法已经定义，并返回了 NotImplemented 之外的值，那已经大功告成了。
2. 试图调用 x.__truediv__(y)。如果该方法已定义并返回一个 NotImplemented 之外的值， x 的旧值将被丢弃，并将所返回的值替代它，就像是进行了 x = x / y 运算。
3. 试图调用 y.__rtruediv__(x)。如果该方法已定义并返回了一个 NotImplemented 之外的值，x 的旧值将被丢弃，并用所返回值进行替换。

因此如果想对原地运算进行优化，仅需像 __itruediv__() 方法一样定义“原地”方法。否则，基本上 Python 将会重新生成原地运算公式，以使用常规的运算及变量赋值。

还有一些“一元”数学运算，可以对“类-数字”对象自己执行。

可比较的类

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

☞如果定义了 __lt__() 方法但没有定义 __gt__() 方法，Python 将通过经交换的算子调用 __lt__() 方法。然而，Python 并不会组合方法。例如，如果定义了 __lt__() 方法和 __eq()__ 方法，并试图测试是否 x <= y，Python 不会按顺序调用 __lt__() 和 __eq()__ 。它将只调用 __le__() 方法。

可序列化的类

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

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

可在 with 语块中使用的类

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

以下是 withfile`` 习惯用法 的运作方式：

# excerpt from io.py:
def _checkClosed(self, msg=None):
    '''Internal: raise an ValueError if file is closed
    '''
    if self.closed:
        raise ValueError('I/O operation on closed file.'
                         if msg is None else msg)

def __enter__(self):
    '''Context management protocol.  Returns self.'''

def __exit__(self, *args):
    '''Context management protocol.  Calls close()'''

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

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

要了解关于上下文管理器的更多内容，请查阅 《自动关闭文件》 和 《重定向标准输出》。

真正神奇的东西

如果知道自己在干什么，你几乎可以完全控制类是如何比较的、属性如何定义，以及类的子类是何种类型。

* 确切掌握 Python 何时调用 __del__() 特别方法 是件难以置信的复杂事情。要想完全理解它，必须清楚 Python 如何在内存中跟踪对象。以下有一篇好文章介绍 Python 垃圾收集和类析构器。还可以阅读 《弱引用》、《weakref 模块》，还可以将 《gc 模块》 当作补充阅读材料。

深入阅读

本附录中提到的模块：

• zipfile 模块
• cgi 模块
• collections 模块
• math［数学］ 模块
• pickle 模块
• copy 模块
• abc (“抽象基类”) 模块

其它启发式阅读：

• 迷你语言格式规范
• Python 数据模型
• 内建类型
• PEP 357: 使任何对象可以使用切片
• PEP 3119: 抽象基类简介