定制类

看到类似slots这种形如xxx的变量或者函数名就要注意,这些在Python中是有特殊用途的。

slots我们已经知道怎么用了,len()方法我们也知道是为了能让class作用于len()函数。

除此之外,Python的class中还有许多这样有特殊用途的函数,可以帮助我们定制类。

str

我们先定义一个Student类,打印一个实例:

  1. >>> class Student(object):
  2. ... def __init__(self, name):
  3. ... self.name = name
  4. ...
  5. >>> print Student('Michael')
  6. <__main__.Student object at 0x109afb190>

打印出一堆&lt;main.Student object at 0x109afb190&gt;,不好看。

怎么才能打印得好看呢?只需要定义好str()方法,返回一个好看的字符串就可以了:

  1. >>> class Student(object):
  2. ... def __init__(self, name):
  3. ... self.name = name
  4. ... def __str__(self):
  5. ... return 'Student object (name: %s)' % self.name
  6. ...
  7. >>> print Student('Michael')
  8. Student object (name: Michael)

这样打印出来的实例,不但好看,而且容易看出实例内部重要的数据。

但是细心的朋友会发现直接敲变量不用print,打印出来的实例还是不好看:

  1. >>> s = Student('Michael')
  2. >>> s
  3. <__main__.Student object at 0x109afb310>

这是因为直接显示变量调用的不是str(),而是repr(),两者的区别是str()返回用户看到的字符串,而repr()返回程序开发者看到的字符串,也就是说,repr()是为调试服务的。

解决办法是再定义一个repr()。但是通常str()repr()代码都是一样的,所以,有个偷懒的写法:

  1. class Student(object):
  2. def __init__(self, name):
  3. self.name = name
  4. def __str__(self):
  5. return 'Student object (name=%s)' % self.name
  6. __repr__ = __str__

iter

如果一个类想被用于for … in循环,类似list或tuple那样,就必须实现一个iter()方法,该方法返回一个迭代对象,然后,Python的for循环就会不断调用该迭代对象的next()方法拿到循环的下一个值,直到遇到StopIteration错误时退出循环。

我们以斐波那契数列为例,写一个Fib类,可以作用于for循环:

  1. class Fib(object):
  2. def __init__(self):
  3. self.a, self.b = 0, 1 # 初始化两个计数器a,b
  4. def __iter__(self):
  5. return self # 实例本身就是迭代对象,故返回自己
  6. def next(self):
  7. self.a, self.b = self.b, self.a + self.b # 计算下一个值
  8. if self.a > 100000: # 退出循环的条件
  9. raise StopIteration();
  10. return self.a # 返回下一个值

现在,试试把Fib实例作用于for循环:

  1. >>> for n in Fib():
  2. ... print n
  3. ...
  4. 1
  5. 1
  6. 2
  7. 3
  8. 5
  9. ...
  10. 46368
  11. 75025

getitem

Fib实例虽然能作用于for循环,看起来和list有点像,但是,把它当成list来使用还是不行,比如,取第5个元素:

  1. >>> Fib()[5]
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. TypeError: 'Fib' object does not support indexing

要表现得像list那样按照下标取出元素,需要实现getitem()方法:

  1. class Fib(object):
  2. def __getitem__(self, n):
  3. a, b = 1, 1
  4. for x in range(n):
  5. a, b = b, a + b
  6. return a

现在,就可以按下标访问数列的任意一项了:

  1. >>> f = Fib()
  2. >>> f[0]
  3. 1
  4. >>> f[1]
  5. 1
  6. >>> f[2]
  7. 2
  8. >>> f[3]
  9. 3
  10. >>> f[10]
  11. 89
  12. >>> f[100]
  13. 573147844013817084101

但是list有个神奇的切片方法:

  1. >>> range(100)[5:10]
  2. [5, 6, 7, 8, 9]

对于Fib却报错。原因是getitem()传入的参数可能是一个int,也可能是一个切片对象slice,所以要做判断:

  1. class Fib(object):
  2. def __getitem__(self, n):
  3. if isinstance(n, int):
  4. a, b = 1, 1
  5. for x in range(n):
  6. a, b = b, a + b
  7. return a
  8. if isinstance(n, slice):
  9. start = n.start
  10. stop = n.stop
  11. a, b = 1, 1
  12. L = []
  13. for x in range(stop):
  14. if x >= start:
  15. L.append(a)
  16. a, b = b, a + b
  17. return L

现在试试Fib的切片:

  1. >>> f = Fib()
  2. >>> f[0:5]
  3. [1, 1, 2, 3, 5]
  4. >>> f[:10]
  5. [1, 1, 2, 3, 5, 8, 13, 21, 34, 55]

但是没有对step参数作处理:

  1. >>> f[:10:2]
  2. [1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

也没有对负数作处理,所以,要正确实现一个getitem()还是有很多工作要做的。

此外,如果把对象看成dictgetitem()的参数也可能是一个可以作key的object,例如str

与之对应的是setitem()方法,把对象视作list或dict来对集合赋值。最后,还有一个delitem()方法,用于删除某个元素。

总之,通过上面的方法,我们自己定义的类表现得和Python自带的list、tuple、dict没什么区别,这完全归功于动态语言的“鸭子类型”,不需要强制继承某个接口。

getattr

正常情况下,当我们调用类的方法或属性时,如果不存在,就会报错。比如定义Student类:

  1. class Student(object):
  2. def __init__(self):
  3. self.name = 'Michael'

调用name属性,没问题,但是,调用不存在的score属性,就有问题了:

  1. >>> s = Student()
  2. >>> print s.name
  3. Michael
  4. >>> print s.score
  5. Traceback (most recent call last):
  6. ...
  7. AttributeError: 'Student' object has no attribute 'score'

错误信息很清楚地告诉我们,没有找到score这个attribute。

要避免这个错误,除了可以加上一个score属性外,Python还有另一个机制,那就是写一个getattr()方法,动态返回一个属性。修改如下:

  1. class Student(object):
  2. def __init__(self):
  3. self.name = 'Michael'
  4. def __getattr__(self, attr):
  5. if attr=='score':
  6. return 99

当调用不存在的属性时,比如score,Python解释器会试图调用getattr(self, 'score')来尝试获得属性,这样,我们就有机会返回score的值:

  1. >>> s = Student()
  2. >>> s.name
  3. 'Michael'
  4. >>> s.score
  5. 99

返回函数也是完全可以的:

  1. class Student(object):
  2. def __getattr__(self, attr):
  3. if attr=='age':
  4. return lambda: 25

只是调用方式要变为:

  1. >>> s.age()
  2. 25

注意,只有在没有找到属性的情况下,才调用getattr,已有的属性,比如name,不会在getattr中查找。

此外,注意到任意调用如s.abc都会返回None,这是因为我们定义的getattr默认返回就是None。要让class只响应特定的几个属性,我们就要按照约定,抛出AttributeError的错误:

  1. class Student(object):
  2. def __getattr__(self, attr):
  3. if attr=='age':
  4. return lambda: 25
  5. raise AttributeError('\'Student\' object has no attribute \'%s\'' % attr)

这实际上可以把一个类的所有属性和方法调用全部动态化处理了,不需要任何特殊手段。

这种完全动态调用的特性有什么实际作用呢?作用就是,可以针对完全动态的情况作调用。

举个例子:

现在很多网站都搞REST API,比如新浪微博、豆瓣啥的,调用API的URL类似:

  1. http://api.server/user/friends
  2. http://api.server/user/timeline/list

如果要写SDK,给每个URL对应的API都写一个方法,那得累死,而且,API一旦改动,SDK也要改。

利用完全动态的getattr,我们可以写出一个链式调用:

  1. class Chain(object):
  2. def __init__(self, path=''):
  3. self._path = path
  4. def __getattr__(self, path):
  5. return Chain('%s/%s' % (self._path, path))
  6. def __str__(self):
  7. return self._path

试试:

  1. >>> Chain().status.user.timeline.list
  2. '/status/user/timeline/list'

这样,无论API怎么变,SDK都可以根据URL实现完全动态的调用,而且,不随API的增加而改变!

还有些REST API会把参数放到URL中,比如GitHub的API:

  1. GET /users/:user/repos

调用时,需要把:user替换为实际用户名。如果我们能写出这样的链式调用:

  1. Chain().users('michael').repos

就可以非常方便地调用API了。有兴趣的童鞋可以试试写出来。

call

一个对象实例可以有自己的属性和方法,当我们调用实例方法时,我们用instance.method()来调用。能不能直接在实例本身上调用呢?类似instance()?在Python中,答案是肯定的。

任何类,只需要定义一个call()方法,就可以直接对实例进行调用。请看示例:

  1. class Student(object):
  2. def __init__(self, name):
  3. self.name = name
  4. def __call__(self):
  5. print('My name is %s.' % self.name)

调用方式如下:

  1. >>> s = Student('Michael')
  2. >>> s()
  3. My name is Michael.

call()还可以定义参数。对实例进行直接调用就好比对一个函数进行调用一样,所以你完全可以把对象看成函数,把函数看成对象,因为这两者之间本来就没啥根本的区别。

如果你把对象看成函数,那么函数本身其实也可以在运行期动态创建出来,因为类的实例都是运行期创建出来的,这么一来,我们就模糊了对象和函数的界限。

那么,怎么判断一个变量是对象还是函数呢?其实,更多的时候,我们需要判断一个对象是否能被调用,能被调用的对象就是一个Callable对象,比如函数和我们上面定义的带有call()的类实例:

  1. >>> callable(Student())
  2. True
  3. >>> callable(max)
  4. True
  5. >>> callable([1, 2, 3])
  6. False
  7. >>> callable(None)
  8. False
  9. >>> callable('string')
  10. False

通过callable()函数,我们就可以判断一个对象是否是“可调用”对象。

小结

Python的class允许定义许多定制方法,可以让我们非常方便地生成特定的类。

本节介绍的是最常用的几个定制方法,还有很多可定制的方法,请参考Python的官方文档

原文: https://wizardforcel.gitbooks.io/liaoxuefeng/content/py2/46.html