Python学习--定制类

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

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

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

str

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

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,打印出来的实例还是不好看

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

这是因为直接显示变量调用的不是__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__

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有个神奇得切片方法:

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

对于Fib却报错。原因是__getitem__()传入得参数可能是一个int,也可能是一个切片对象slice,所以要做判断
[:]这玩意居然是一个slice类型的对象,不愧是万物皆对象

class Fib(object):
	def __getitem__(self, n):
		if isinstance(n, int): # n是索引
			a, b = 1, 1
			for x in range(n)
				a, b = b, a + b
			return a
		if isinstance(n, slice): # n是切片
			start = n.start
			stop = n.stop
			if start is None:
				start = 0
			a, b = 1, 1
			L = []
			for x in range(stop):
				if x >= start: # 这里注意,必须要这个判断,因为range是从0开始的,但是切片确实从任意开始的
					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__(selt, path):
		return Chain('%s/%s' % (self._path, path))

	def __str__(self):
		return self._path
	
	__repr__ = __str__

试试:

>>> 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__
**这里分析一下,__call__的作用,就是实现类可以像函数一样调用。**这里很关键。

一开始想用@property和@属性名.setter
这里写一下,这两个均是把方法变成属性,然后直接赋值,不要搞混了

class Chain(object):
	def __init__(self, path=''):
		self._path = path
	
	def __getattr__(self, path):
		return Chain('%s/%s' % (self._path, path))
	
	def __call__(self, path):
		return Chain('%s/%s' % (self._path, path))
	
	def __str__(self):
		return self.path
	
	__repr__ = __str__

所以Chain().users这是返回一个类实例,比如说是A
然后才是A(‘michael’),调用__call__函数,又是返回一个类实例,比如说是B
然后B.repos就是调用__getattr__返回另一个类实例C
那为啥print会出现字符串呢?那是因为__str__函数。

这段完全没懂
回头看了一下,当调用不存在的属性时,比如score,Python解释器会试图调用__getattr__(self, ‘score’)来尝试获得属性,看这句话。
明确说了,当属性不存在的时候,就会调用__getattr__,然后再看看__getattr__如何调用的?
对,就是实例.属性(实例名 .点 属性名)
那么Chain().status.user.timeline.list 这串调用就理解了
就是一连串的调用,对吧。
如何看__getattr__这个函数如何定义的?
返回一个 Chain(字符串),这个是一个类实例。
其中字符串按照’%s/%s’ % (self._path, path),这个样子格式化,就这样理解。
那么Chain().status.user.timeline.list,是如何操作的呢?

 首先
 调用 Chain().status
 那它一调用,就先找类中有定义这个属性嘛?没有,那就找__getattr__函数
 好,找到,这个函数是返回一个Chain(字符串),
 那么,就把_path,就是这个类实例的属性变成了/status

这里关键,然后返回一个类实例Chain,且类属性_path被初始化为了
/status 

 继续Chain().status.user
 一样的,因为本身self._path变成了/status,加上传进来的usr
 根据'%s/%s' % (self._path, path)
 那么_path就变成了/status/usr

这里关键,然后返回一个类实例Chain,且类属性_path被初始化为了
/status/usr

 一直到list

所以,巧妙地链式调用,就是不断地返回类实例,用__init__方法,让类的属性更新

call

一个对象实例可以有自己地属性和方法,当我们调用实例方法时,我们用instance.method()来调用。能不能直接在实例本身上调用呢?在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('str')
False

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

小结

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

1__str__ :像简介一样的作用?返回字符串
2__iter__: 使得类可以迭代,要写__next__方法
3__getitem__:使类可以像list一样,用index索引直接查值
4__getattr__:调用不存在的属性时调用这个函数
5__call__:让类像函数一样调用

猜你喜欢

转载自blog.csdn.net/qq_44787943/article/details/112541383