一摞Python風格的紙牌
接下來我會用一個非常簡單的例子來展示如何實現(xiàn) __getitme__ 和
__len__ 這兩個特殊方法，通過這個例子我們也能見識到特殊方法的強
大。
示例 1-1 里的代碼建立了一個紙牌類
示例 1-1 一摞有序的紙牌
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]
首先，我們用 collections.namedtuple 構(gòu)建了一個簡單的類來表示
一張紙牌。自 Python 2.6 開始，namedtuple 就加入到 Python 里，用以
構(gòu)建只有少數(shù)屬性但是沒有方法的對象，比如數(shù)據(jù)庫條目。如下面這個
控制臺會話所示，利用 namedtuple，我們可以很輕松地得到一個紙牌
對象：
>>> beer_card = Card('7', 'diamonds')
>>> beer_card
Card(rank='7', suit='diamonds')
當然，我們這個例子主要還是關(guān)注 FrenchDeck 這個類，它既短小又精
悍。首先，它跟任何標準 Python 集合類型一樣，可以用 len() 函數(shù)來
查看一疊牌有多少張：
>>> deck = FrenchDeck()
>>> len(deck)
52
從一疊牌中抽取特定的一張紙牌，比如說第一張或最后一張，是很容易
的：deck[0] 或 deck[-1]。這都是由 __getitem__ 方法提供的：
>>> deck[0]
Card(rank='2', suit='spades')
>>> deck[-1]
Card(rank='A', suit='hearts')
我們需要單獨寫一個方法用來隨機抽取一張紙牌嗎？沒必要，Python 已
經(jīng)內(nèi)置了從一個序列中隨機選出一個元素的函數(shù) random.choice，我
們直接把它用在這一摞紙牌實例上就好：
>>> from random import choice
>>> choice(deck)
Card(rank='3', suit='hearts')
>>> choice(deck)
Card(rank='K', suit='spades')
>>> choice(deck)
Card(rank='2', suit='clubs')
現(xiàn)在已經(jīng)可以體會到通過實現(xiàn)特殊方法來利用 Python 數(shù)據(jù)模型的兩個好
處。
作為你的類的用戶，他們不必去記住標準操作的各式名稱（“怎么
得到元素的總數(shù)？是 .size() 還是 .length() 還是別的什
么？”）。
可以更加方便地利用 Python 的標準庫，比如 random.choice 函
數(shù)，從而不用重新發(fā)明輪子。
而且好戲還在后面。
因為 __getitem__ 方法把 [] 操作交給了 self._cards 列表，所以我
們的 deck 類自動支持切片（slicing）操作。下面列出了查看一摞牌最
上面 3 張和只看牌面是 A 的牌的操作。其中第二種操作的具體方法是，
先抽出索引是 12 的那張牌，然后每隔 13 張牌拿 1 張：
>>> deck[:3]
[Card(rank='2', suit='spades'), Card(rank='3', suit='spades'),
Card(rank='4', suit='spades')]
>>> deck[12::13]
[Card(rank='A', suit='spades'), Card(rank='A', suit='diamonds'),
Card(rank='A', suit='clubs'), Card(rank='A', suit='hearts')]
另外，僅僅實現(xiàn)了 __getitem__ 方法，這一摞牌就變成可迭代的了：
>>> for card in deck: # doctest: +ELLIPSIS
... print(card)
Card(rank='2', suit='spades')
Card(rank='3', suit='spades')
Card(rank='4', suit='spades')
...
反向迭代也沒關(guān)系：
>>> for card in reversed(deck): # doctest: +ELLIPSIS
... print(card)
Card(rank='A', suit='hearts')
Card(rank='K', suit='hearts')
Card(rank='Q', suit='hearts')
doctest 中的省略
為了盡可能保證書中的 Python 控制臺會話內(nèi)容的正確性，這些內(nèi)容
都是直接從 doctest 里摘錄的。在測試中，如果可能的輸出過長的
話，那么過長的內(nèi)容就會被如上面例子的最后一行的省略號
（...）所替代。此時就需要 #doctest: +ELLIPSIS 這個指令來
保證 doctest 能夠通過。要是你自己照著書中例子在控制臺中敲代
碼，可以略過這一指令。
迭代通常是隱式的，譬如說一個集合類型沒有實現(xiàn) __contains__ 方
法，那么 in 運算符就會按順序做一次迭代搜索。于是，in 運算符可以
用在我們的 FrenchDeck 類上，因為它是可迭代的：
>>> Card('Q', 'hearts') in deck
True
>>> Card('7', 'beasts') in deck
False
那么排序呢？我們按照常規(guī)，用點數(shù)來判定撲克牌的大小，2 最小、A
最大；同時還要加上對花色的判定，黑桃最大、紅桃次之、方塊再次、
梅花最小。下面就是按照這個規(guī)則來給撲克牌排序的函數(shù)，梅花 2 的大
小是 0，黑桃 A 是 51：
suit_values = dict(spades=3, hearts=2, diamonds=1, clubs=0)
def spades_high(card):
rank_value = FrenchDeck.ranks.index(card.rank)
return rank_value * len(suit_values) + suit_values[card.suit]
有了 spades_high 函數(shù)，就能對這摞牌進行升序排序了：
>>> for card in sorted(deck, key=spades_high): # doctest: +ELLIPSIS
... print(card)
Card(rank='2', suit='clubs')
Card(rank='2', suit='diamonds')
Card(rank='2', suit='hearts')
... (46 cards ommitted)
Card(rank='A', suit='diamonds')
Card(rank='A', suit='hearts')
Card(rank='A', suit='spades')
雖然 FrenchDeck 隱式地繼承了 object 類， 但功能卻不是繼承而來
的。我們通過數(shù)據(jù)模型和一些合成來實現(xiàn)這些功能。通過實現(xiàn) __len__
和 __getitem__ 這兩個特殊方法，F(xiàn)renchDeck 就跟一個 Python 自有
的序列數(shù)據(jù)類型一樣，可以體現(xiàn)出 Python 的核心語言特性（例如迭代和
切片）。同時這個類還可以用于標準庫中諸如
random.choice、reversed 和 sorted 這些函數(shù)。另外，對合成的運
用使得 __len__ 和 __getitem__ 的具體實現(xiàn)可以代理給 self._cards
這個 Python 列表（即 list 對象）。
5
5
在 Python 2 中，對 object 的繼承需要顯式地寫為 FrenchDeck(object)；而在 Python 3 中，
這個繼承關(guān)系是默認的。
如何洗牌
按照目前的設(shè)計，F(xiàn)renchDeck 是不能洗牌的，因為這摞牌是不可
變的（immutable）：卡牌和它們的位置都是固定的，除非我們破壞
這個類的封裝性，直接對 _cards 進行操作。第 11 章會講到，其
實只需要一行代碼來實現(xiàn) __setitem__ 方法，洗牌功能就不是問
題了。
