3. 定制类
    5. 阅读: 188166
    6. 看到类似__slots__这种形如__xxx__的变量或者函数名就要注意，这些在Python中是有特殊用途的。
    8. __slots__我们已经知道怎么用了，__len__()方法我们也知道是为了能让class作用于len()函数。
    10. 除此之外，Python的class中还有许多这样有特殊用途的函数，可以帮助我们定制类。
    12. __str__
    14. 我们先定义一个Student类，打印一个实例：
    16. >>> class Student(object):
    17. ...     def __init__(self, name):
    18. ...         self.name = name
    19. ...
    20. >>> print(Student('Michael'))
    21. <__main__.Student object at 0x109afb190>
    22. 打印出一堆<__main__.Student object at 0x109afb190>，不好看。
    24. 怎么才能打印得好看呢？只需要定义好__str__()方法，返回一个好看的字符串就可以了：
    26. >>> class Student(object):
    27. ...     def __init__(self, name):
    28. ...         self.name = name
    29. ...     def __str__(self):
    30. ...         return 'Student object (name: %s)' % self.name
    31. ...
    32. >>> print(Student('Michael'))
    33. Student object (name: Michael)
    34. 这样打印出来的实例，不但好看，而且容易看出实例内部重要的数据。
    36. 但是细心的朋友会发现直接敲变量不用print，打印出来的实例还是不好看：
    38. >>> s = Student('Michael')
    39. >>> s
    40. <__main__.Student object at 0x109afb310>
    41. 这是因为直接显示变量调用的不是__str__()，而是__repr__()，两者的区别是__str__()返回用户看到的字符串，而__repr__()返回程序开发者看到的字符串，也就是说，__repr__()是为调试服务的。
    43. 解决办法是再定义一个__repr__()。但是通常__str__()和__repr__()代码都是一样的，所以，有个偷懒的写法：
    45. class Student(object):
    46.    def __init__(self, name):
    47.        self.name = name
    48.    def __str__(self):
    49.        return 'Student object (name=%s)' % self.name
    50.    __repr__ = __str__
    51. __iter__
    53. 如果一个类想被用于for ... in循环，类似list或tuple那样，就必须实现一个__iter__()方法，该方法返回一个迭代对象，然后，Python的for循环就会不断调用该迭代对象的__next__()方法拿到循环的下一个值，直到遇到StopIteration错误时退出循环。
    55. 我们以斐波那契数列为例，写一个Fib类，可以作用于for循环：
    57. class Fib(object):
    58.    def __init__(self):
    59.        self.a, self.b = 0, 1 # 初始化两个计数器a，b
    61.    def __iter__(self):
    62.        return self # 实例本身就是迭代对象，故返回自己
    64.    def __next__(self):
    65.        self.a, self.b = self.b, self.a + self.b # 计算下一个值
    66.        if self.a > 100000: # 退出循环的条件
    67.            raise StopIteration()
    68.        return self.a # 返回下一个值
    69. 现在，试试把Fib实例作用于for循环：
    71. >>> for n in Fib():
    72. ...     print(n)
    73. ...
    74. 1
    75. 1
    76. 2
    77. 3
    78. 5
    79. ...
    80. 46368
    81. 75025
    82. __getitem__
    84. Fib实例虽然能作用于for循环，看起来和list有点像，但是，把它当成list来使用还是不行，比如，取第5个元素：
    86. >>> Fib()[5]
    87. Traceback (most recent call last):
    88.  File "<stdin>", line 1, in <module>
    89. TypeError: 'Fib' object does not support indexing
    90. 要表现得像list那样按照下标取出元素，需要实现__getitem__()方法：
    92. class Fib(object):
    93.    def __getitem__(self, n):
    94.        a, b = 1, 1
    95.        for x in range(n):
    96.            a, b = b, a + b
    97.        return a
    98. 现在，就可以按下标访问数列的任意一项了：
    100. >>> f = Fib()
    101. >>> f[0]
    102. 1
    103. >>> f[1]
    104. 1
    105. >>> f[2]
    106. 2
    107. >>> f[3]
    108. 3
    109. >>> f[10]
    110. 89
    111. >>> f[100]
    112. 573147844013817084101
    113. 但是list有个神奇的切片方法：
    115. >>> list(range(100))[5:10]
    116. [5, 6, 7, 8, 9]
    117. 对于Fib却报错。原因是__getitem__()传入的参数可能是一个int，也可能是一个切片对象slice，所以要做判断：
    119. class Fib(object):
    120.    def __getitem__(self, n):
    121.        if isinstance(n, int): # n是索引
    122.            a, b = 1, 1
    123.            for x in range(n):
    124.                a, b = b, a + b
    125.            return a
    126.        if isinstance(n, slice): # n是切片
    127.            start = n.start
    128.            stop = n.stop
    129.            if start is None:
    130.                start = 0
    131.            a, b = 1, 1
    132.            L = []
    133.            for x in range(stop):
    134.                if x >= start:
    135.                    L.append(a)
    136.                a, b = b, a + b
    137.            return L
    138. 现在试试Fib的切片：
    140. >>> f = Fib()
    141. >>> f[0:5]
    142. [1, 1, 2, 3, 5]
    143. >>> f[:10]
    144. [1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
    145. 但是没有对step参数作处理：
    147. >>> f[:10:2]
    148. [1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
    149. 也没有对负数作处理，所以，要正确实现一个__getitem__()还是有很多工作要做的。
    151. 此外，如果把对象看成dict，__getitem__()的参数也可能是一个可以作key的object，例如str。
    153. 与之对应的是__setitem__()方法，把对象视作list或dict来对集合赋值。最后，还有一个__delitem__()方法，用于删除某个元素。
    155. 总之，通过上面的方法，我们自己定义的类表现得和Python自带的list、tuple、dict没什么区别，这完全归功于动态语言的"鸭子类型"，不需要强制继承某个接口。
    157. __getattr__
    159. 正常情况下，当我们调用类的方法或属性时，如果不存在，就会报错。比如定义Student类：
    161. class Student(object):
    163.    def __init__(self):
    164.        self.name = 'Michael'
    165. 调用name属性，没问题，但是，调用不存在的score属性，就有问题了：
    167. >>> s = Student()
    168. >>> print(s.name)
    169. Michael
    170. >>> print(s.score)
    171. Traceback (most recent call last):
    172.  ...
    173. AttributeError: 'Student' object has no attribute 'score'
    174. 错误信息很清楚地告诉我们，没有找到score这个attribute。
    176. 要避免这个错误，除了可以加上一个score属性外，Python还有另一个机制，那就是写一个__getattr__()方法，动态返回一个属性。修改如下：
    178. class Student(object):
    180.    def __init__(self):
    181.        self.name = 'Michael'
    183.    def __getattr__(self, attr):
    184.        if attr=='score':
    185.            return 99
    186. 当调用不存在的属性时，比如score，Python解释器会试图调用__getattr__(self, 'score')来尝试获得属性，这样，我们就有机会返回score的值：
    188. >>> s = Student()
    189. >>> s.name
    190. 'Michael'
    191. >>> s.score
    192. 99
    193. 返回函数也是完全可以的：
    195. class Student(object):
    197.    def __getattr__(self, attr):
    198.        if attr=='age':
    199.            return lambda: 25
    200. 只是调用方式要变为：
    202. >>> s.age()
    203. 25
    204. 注意，只有在没有找到属性的情况下，才调用__getattr__，已有的属性，比如name，不会在__getattr__中查找。
    206. 此外，注意到任意调用如s.abc都会返回None，这是因为我们定义的__getattr__默认返回就是None。要让class只响应特定的几个属性，我们就要按照约定，抛出AttributeError的错误：
    208. class Student(object):
    210.    def __getattr__(self, attr):
    211.        if attr=='age':
    212.            return lambda: 25
    213.        raise AttributeError('\'Student\' object has no attribute \'%s\'' % attr)
    214. 这实际上可以把一个类的所有属性和方法调用全部动态化处理了，不需要任何特殊手段。
    216. 这种完全动态调用的特性有什么实际作用呢？作用就是，可以针对完全动态的情况作调用。
    218. 举个例子：
    220. 现在很多网站都搞REST API，比如新浪微博、豆瓣啥的，调用API的URL类似：
    222. http://api.server/user/friends
    223. http://api.server/user/timeline/list
    224. 如果要写SDK，给每个URL对应的API都写一个方法，那得累死，而且，API一旦改动，SDK也要改。
    226. 利用完全动态的__getattr__，我们可以写出一个链式调用：
    228. class Chain(object):
    230.    def __init__(self, path=''):
    231.        self._path = path
    233.    def __getattr__(self, path):
    234.        return Chain('%s/%s' % (self._path, path))
    236.    def __str__(self):
    237.        return self._path
    239.    __repr__ = __str__
    240. 试试：
    242. >>> Chain().status.user.timeline.list
    243. '/status/user/timeline/list'
    244. 这样，无论API怎么变，SDK都可以根据URL实现完全动态的调用，而且，不随API的增加而改变！
    246. 还有些REST API会把参数放到URL中，比如GitHub的API：
    248. GET /users/:user/repos
    249. 调用时，需要把:user替换为实际用户名。如果我们能写出这样的链式调用：
    251. Chain().users('michael').repos
    252. 就可以非常方便地调用API了。有兴趣的童鞋可以试试写出来。
    254. __call__
    256. 一个对象实例可以有自己的属性和方法，当我们调用实例方法时，我们用instance.method()来调用。能不能直接在实例本身上调用呢？在Python中，答案是肯定的。
    258. 任何类，只需要定义一个__call__()方法，就可以直接对实例进行调用。请看示例：
    260. class Student(object):
    261.    def __init__(self, name):
    262.        self.name = name
    264.    def __call__(self):
    265.        print('My name is %s.' % self.name)
    266. 调用方式如下：
    268. >>> s = Student('Michael')
    269. >>> s() # self参数不要传入
    270. My name is Michael.
    271. __call__()还可以定义参数。对实例进行直接调用就好比对一个函数进行调用一样，所以你完全可以把对象看成函数，把函数看成对象，因为这两者之间本来就没啥根本的区别。
    273. 如果你把对象看成函数，那么函数本身其实也可以在运行期动态创建出来，因为类的实例都是运行期创建出来的，这么一来，我们就模糊了对象和函数的界限。
    275. 那么，怎么判断一个变量是对象还是函数呢？其实，更多的时候，我们需要判断一个对象是否能被调用，能被调用的对象就是一个Callable对象，比如函数和我们上面定义的带有__call__()的类实例：
    277. >>> callable(Student())
    278. True
    279. >>> callable(max)
    280. True
    281. >>> callable([1, 2, 3])
    282. False
    283. >>> callable(None)
    284. False
    285. >>> callable('str')
    286. False
    287. 通过callable()函数，我们就可以判断一个对象是否是"可调用"对象。
    289. 小结
    291. Python的class允许定义许多定制方法，可以让我们非常方便地生成特定的类。
    293. 本节介绍的是最常用的几个定制方法，还有很多可定制的方法，请参考Python的官方文档。
    295. 参考源码
    297. special_str.py
    299. special_iter.py
    301. special_getitem.py
    303. special_getattr.py
    305. special_call.py