python 定制类

时间 2019-11-29

标签 python 定制栏目 Python 繁體版

原文原文链接

看到相似__slots__这种形如__xxx__的变量或者函数名就要注意，这些在Python中是有特殊用途的。html

__slots__咱们已经知道怎么用了，__len__()方法咱们也知道是为了能让class做用于len()函数。python

除此以外，Python的class中还有许多这样有特殊用途的函数，能够帮助咱们定制类。api

str

咱们先定义一个Student类，打印一个实例：app

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

打印出一堆<__main__.Student object at 0x109afb190>，很差看。函数

怎么才能打印得好看呢？只须要定义好__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，打印出来的实例仍是很差看：code

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

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

解决办法是再定义一个__repr__()。可是一般__str__()和__repr__()代码都是同样的，因此，有个偷懒的写法：htm

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

iter

若是一个类想被用于for ... in循环，相似list或tuple那样，就必须实现一个__iter__()方法，该方法返回一个迭代对象，而后，Python的for循环就会不断调用该迭代对象的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 # 返回下一个值

如今，试试把Fib实例做用于for循环：

>>> for n in Fib():
...     print n
...
1
1
2
3
5
...
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]
573147844013817084101

可是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, 89]

也没有对负数做处理，因此，要正确实现一个__getitem__()仍是有不少工做要作的。

此外，若是把对象当作dict，__getitem__()的参数也多是一个能够做key的object，例如str。

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

总之，经过上面的方法，咱们本身定义的类表现得和Python自带的list、tuple、dict没什么区别，这彻底归功于动态语言的“鸭子类型”，不须要强制继承某个接口。

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

当调用不存在的属性时，好比score，Python解释器会试图调用__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.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)

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

这种彻底动态调用的特性有什么实际做用呢？做用就是，能够针对彻底动态的状况做调用。

举个例子：

如今不少网站都搞REST API，好比新浪微博、豆瓣啥的，调用API的URL相似：

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
'/status/user/timeline/list'

这样，不管API怎么变，SDK均可以根据URL实现彻底动态的调用，并且，不随API的增长而改变！

还有些REST API会把参数放到URL中，好比GitHub的API：

GET /users/:user/repos

调用时，须要把:user替换为实际用户名。若是咱们能写出这样的链式调用：

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

就能够很是方便地调用API了。有兴趣的童鞋能够试试写出来。

call

一个对象实例能够有本身的属性和方法，当咱们调用实例方法时，咱们用instance.method()来调用。能不能直接在实例自己上调用呢？相似instance()？在Python中，答案是确定的。

任何类，只须要定义一个__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())
True
>>> callable(max)
True
>>> callable([1, 2, 3])
False
>>> callable(None)
False
>>> callable('string')
False

经过callable()函数，咱们就能够判断一个对象是不是“可调用”对象。

小结

Python的class容许定义许多定制方法，可让咱们很是方便地生成特定的类。

本节介绍的是最经常使用的几个定制方法，还有不少可定制的方法，请参考Python的官方文档。