《Fluent Python》笔记 数据模型

本章主要围绕Python的特殊方法进行介绍,通过实现特殊方法利用Python数据模型。

首先看两个例子:

  • 一个表示一副扑克牌的类。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import collections

Card = collections.namedtuple('Card', ['rank', 'suit'])


class FrenchDeck:
ranks = [str(n) for n in range(2, 11)] + list('JQKA')
suits = 'spades diamonds clubs hearts'.split()

def __init__(self):
self._cards = [Card(rank, suit) for suit in self.suits
for rank in self.ranks]

def __len__(self):
return len(self._cards)

def __getitem__(self, position):
return self._cards[position]
  • 一个表示二维向量的类。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from math import hypot

class Vector:

def __init__(self, x=0, y=0):
self.x = x
self.y = y

def __repr__(self):
return 'Vector(%r, %r)' % (self.x, self.y)

def __abs__(self):
return hypot(self.x, self.y)

def __bool__(self):
return bool(abs(self))

def __add__(self, other):
x = self.x + other.x
y = self.y + other.y
return Vector(x, y)

def __mul__(self, scalar):
return Vector(self.x * scalar, self.y * scalar)

上面两个类中,实现的形如__xxx__的方法都叫做特殊方法。在自定义的数据类型中实现这些特殊方法的用处在于,可以使其变得和Python中的内置类型(比如list)一样,能够具有内置类型的一些性质(如list的切片索引)和使用标准库中的一些算法(如random.choice())。举个例子,如果在自定义类A中实现了__len__特殊方法,那么可以通过Python内置方法len(A)得到A对象的大小,而不是在A中写一个size()普通方法,然后通过A.size()进行调用,为此我们需要记住每个数据类中返回其元素总数的方法名称,没有前者实用和便捷。

我们要明确,特殊方法的存在是为了被Python解释器调用,在代码中我们一般并不需要对其进行形如A.__getitem__()的调用。很多情况下,特殊方法的调用时隐式的,如当我们使用内置函数(例如len、str等)时,解释器就会调用对应的特殊方法(例如__len__、__str__等)。

示例代码中的一些特殊方法作用如下:

  • __repr__:把一个对象用字符串形式进行表达,即返回一个对象的字符串表示形式。

  • __str__:返回一个对象的字符串表示形式,相较于__repr__其返回的字符串更适合打印到终端。

    如果一个对象没有__str__函数,Python解释器会调用__repr__作为替代。

  • __add__:能够实现自定义数据类型的+运算。

  • __mul__:能够实现自定义数据类型的*运算。

  • __bool__:定义自定义数据类型什么时候为True或False。

关于更多特殊方法的信息详见:3. Data model — Python 3.11.1 documentation