(windows) Python 2.7 学习笔记 四十 面向对象高级编程 — 定制类

2019032622211

定制类

看到类似 __slots__ 这种形如 __xxx__ 的变量或者函数名就要注意,这些在 Python 中是有特殊用途的。__slots__ 我们已经知道怎么用了,__len__() 方法我们也知道是为了能让 class 作用于 len() 函数。除此之外,Pythonclass 中还有许多这样有特殊用途的函数,可以帮助我们定制类。

__str__

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

>>> class Student(object):
...     def __init__(self, name):
...         self.name = name
...
>>> print Student('Michael')
<__main__.Student object at 0x000000000232EE48>
>>>

打印出一堆 <__main__.Student object at 0x000000000232EE48>,不好看。

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

>>> class Student(object):
...     def __init__(self, name):
...         self.name = name
...     def __str__(self):
...         return 'Student object (name: %s)' % self.name
...
>>> print Student('Michael')
Student object (name: Michael)
>>>

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

但是直接敲变量不用 print,打印出来的实例还是不好看:

>>> s = Student('Michael')
>>> s
<__main__.Student object at 0x00000000023379E8>
>>>

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

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

>>> class Student(object):
...     def __init__(self, name):
...         self.name = name
...     def __str__(self):
...         return 'Student object (name=%s)' % self.name
...     __repr__ = __str__
...
>>> s = Student('Michael')
>>> s
Student object (name=Michael)
>>>

__iter__

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

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

>>> class Fib(object):
...     def __init__(self):
...         self.a, self.b = 0, 1 # 初始化两个计数器a,b
...
...     def __iter__(self):
...         return self # 实例本身就是迭代对象,故返回自己
...
...     def next(self):
...         self.a, self.b = self.b, self.a + self.b # 计算下一个值
...         if self.a > 100000: # 退出循环的条件
...             raise StopIteration();
...         return self.a # 返回下一个值
...
>>> for n in Fib():
...     print n
...
1
1
2
3
5
8
13
21
34
55
89
144
233
377
610
987
1597
2584
4181
6765
10946
17711
28657
46368
75025
>>>

__getitem__

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

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

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

>>> class Fib(object):
...     def __getitem__(self, n):
...         a, b = 1, 1
...         for x in range(n):
...             a, b = b, a + b
...         return a
...
>>>

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

>>> f = Fib()
>>> f[0]
1
>>> f[1]
1
>>> f[2]
2
>>> f[3]
3
>>> f[10]
89
>>> f[100]
573147844013817084101L
>>>

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

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

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

>>> class Fib(object):
...     def __getitem__(self, n):
...         if isinstance(n, int):
...             a, b = 1, 1
...             for x in range(n):
...                 a, b = b, a + b
...             return a
...         if isinstance(n, slice):
...             start = n.start
...             stop = n.stop
...             a, b = 1, 1
...             L = []
...             for x in range(stop):
...                 if x >= start:
...                     L.append(a)
...                 a, b = b, a + b
...             return L
...

现在试试 Fib 的切片:

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

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

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

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

此外,如果要把对象看成 dict__getitem__() 的参数也可能是一个可以作为 keyobject,例如 str

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

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

__getattr__

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

>>> class Student(object):
...
...     def __init__(self):
...         self.name = 'Michael'
...

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

>>> s = Student()
>>> print s.name
Michael
>>> print s.score
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'Student' object has no attribute 'score'
>>>

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

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

>>> class Student(object):
...
...     def __init__(self):
...         self.name = 'Michael'
...
...     def __getattr__(self, attr):
...         if attr == 'score':
...             return 99
...

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

>>> s = Student()
>>> s.name
'Michael'
>>> s.score
99

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

>>> class Student(object):
...
...     def __getattr__(self, attr):
...         if attr == 'age':
...             return lambda: 25
...

只是调用方式要变为:

>>> s = Student()
>>> s.age()
25

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

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

>>> class Student(object):
...
...     def __getattr__(self, attr):
...         if attr == 'age':
...             return lambda: 25
...         raise AttributeError('\'Student\' object has no attribute \'%s\'' %
attr)
...
>>> s = Student()
>>> s.abc
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 6, in __getattr__
AttributeError: 'Student' object has no attribute 'abc'
>>>

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

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

比如:

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

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

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

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

>>> class Chain(object):
...
...     def __init__(self, path=''):
...         self._path = path
...
...     def __getattr__(self, path):
...         return Chain('%s/%s' % (self._path, path))
...
...     def __str__(self):
...         return self._path
...
>>> Chain().status.user.timeline.list
<__main__.Chain object at 0x0000000002558358>
>>> print Chain().status.user.timeline.list
/status/user/timeline/list
>>>

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

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

GET /users/:user/repos

调用时,需要把 :user 替换为实际用户名。如果我们能写出这样的链式调用,就可以非常方便的调用 API原文

Chain().users('Michael').repos
>>> class Chain(object):
...     def __init__(self, path=''):
...         self._path = path
...     def __getattr__(self, path):
...         return Chain('%s/%s' % (self._path, path))
...
...     def __str__(self):
...         return self._path
...
...     def __getitem__(self, path):
...         return Chain('%s/%s' % (self._path, path))
...
...     def __call__(self,name):
...         return Chain('%s/:%s' % (self._path, name))
...
...     __repr__ = __str__
...
>>> Chain().users('michael').repos
/users/michael/repos

__call__

一个对象实例可以有自己的属性和方法,当我们调用实例方法时,我们用 instance.method() 来调用。可以直接在实例本身上调用。

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

>>> class Student(object):
...     def __init__(self, name):
...         self.name = name
...
...     def __call__(self):
...         print('My name is %s.' % self.name)
...

调用方式如下:

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

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

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

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

>>> callable(Student('a'))
True
>>> callable(max)
True
>>> callable([1, 2, 3])
False
>>> callable(None)
False
>>> callable('string')
False
>>>

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

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

发表评论

zh_CNChinese
zh_CNChinese