Python学习笔记（二）——特殊方法

代码及内容源自《Fluent Python》——Luciano Ramalho 著

import collections

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

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

    def __init__(self):
        super(FrenchDeck, self).__init__()
        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可以建立一个表示一副牌的简单类。在Python2.6之后，namedtuple可以用来建立仅包含属性，不包含自定义方法的类，作用更像是数据表。在这个例子中，可以用它来很好的表示一张牌，比如：

>>> beer_card=Card('7','diamonds')
>>> beer_card

Card(rank='7', suit='diamonds')

不过，在这个例子中，最关键的是FrenchDeck类，短小却有力。
首先，与任何标准的Python collection类似，可以使用函数len()返回整付牌的数量：

>>> deck=FrenchDeck()
>>> len(deck)

52

利用__getitem__方法，方便地获取某一张具体的牌，如第一张或最后一张：

>>> deck[0]

Card(rank='2', suit='spades')

>>> deck[-1]

Card(rank='A', suit='hearts')

用Python自带的随机函数，随机获取一张牌：

>>> from random import choice
>>> choice(deck)

Card(rank='2', suit='spades')

>>> choice(deck)

Card(rank='7', suit='hearts')

>>> choice(deck)

Card(rank='9', suit='clubs')

至此，可以看出使用“特殊方法”来处理Python数据的两个优点：
- 类的使用者无需去为标准的操作而记忆各种各样的名字。比如，.size(), .length(),等等
- 有效利用Python丰富的标准库会使工作更容易

其实，好处还有更多

因为我们将__getitem__方法作用于操作符[]，因此deck实例就自动地支持slicing功能，如：

>>> 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')]

同样，利用__getitem__这个特殊方法，deck实例是可以迭代的。

>>> for card in reversed(deck): #doctest: +ELLIPSIS

...   print(card)
Card(rank='A', suit='hearts')
Card(rank='K', suit='hearts')
Card(rank='Q', suit='hearts')
... 

>>> Card('Q','hearts') in deck

True

>>> Card('7','beats') in deck

False

如何排序？扑克牌一般是等级（A最大）和花色（黑桃、红桃、方块、梅花依次降低）来排序，因此可以定义一个函数来实现排序功能，即梅花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, 可以将整付牌按照升序排列：

>>> 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')
...

通过采用特殊方法__getitem__和__len__，我们建立的FrenchDeck类能够像标准Python 序列一样，利用Python核心的语言特点（如iteration和slicing）以及标准库。

另外，特殊方法是由Python的解释器调用的。因此，不能写成 my_object.__len__()，而应该写成len(my_object)。如果my_object是用户定义类的一个实例，那么Python会调用__len__的实例方法。