1. 程式人生 > 實用技巧 >22. 定製類

22. 定製類

__slots__

正常情況下,當我們定義了一個class,建立了一個class的例項後,我們可以給該例項繫結任何屬性和方法,這就是動態語言的靈活性。但是,如果我們想要限制例項的屬性怎麼辦?

  • 為了達到限制的目的,Python允許在定義class的時候,定義一個特殊的__slots__變數,來限制該class例項能新增的屬性:
class Student(object):
	__slots__ = ('name', 'age') # 用tuple定義允許繫結的屬性名稱

@property

  • 為了實現既能檢查引數,又可以用類似屬性這樣簡單的方式來訪問類的變數;Python內建的@property裝飾器就是負責把一個方法變成屬性呼叫的:

__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)

__repr__

但直接敲變數不用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錯誤時退出迴圈。

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 # 返回下一個值

__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

但是list有個神奇的切片方法,對於Fib卻報錯。原因是__getitem__()傳入的引數可能是一個int,也可能是一個切片物件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:
					L.append(a)
			a, b = b, a + b
			return L

此外,如果把物件看成dict,__getitem__()的引數也可能是一個可以作key的object,例如str。
與之對應的是__setitem__()方法,把物件視作list或dict來對集合賦值。最後,還有一個__delitem__()方法,用於刪除某個元素。

總之,通過上面的方法,我們自己定義的類表現得和Python自帶的list、tuple、dict沒什麼區別,這完全歸功於動態語言的“鴨子型別”,不需要強制繼承某個介面。

__getattr__

正常情況下,當我們呼叫類的方法或屬性時,如果不存在,就會報錯。

要避免這個錯誤,除了可以加上一個score屬性外,Python還有另一個機制,那就是寫一個__getattr__()方法,動態返回一個屬性。

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

當呼叫不存在的屬性時,比如score,Python直譯器會試圖呼叫__getattr__(self, 'score')來嘗試獲得屬性,這樣,我們就有機會返回score的值。

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

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

只是呼叫方式要變為:

>>> s.age()
25

注意,只有在沒有找到屬性的情況下,才呼叫__getattr__,已有的屬性,比如name,不會在__getattr__中查詢。此外,注意到任意呼叫如s.abc都會返回None,這是因為我們定義的__getattr__預設返回就是None。

__call__

一個物件例項可以有自己的屬性和方法,能不能直接在例項本身上呼叫呢?

任何類,只需要定義一個__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() # self引數不要傳入
My name is Michael.

__call__()還可以定義引數。對例項進行直接呼叫就好比對一個函式進行呼叫一樣,所以你完全可以把物件看成函式,把函式看成物件,因為這兩者之間本來就沒啥根本的區別。

那麼,怎麼判斷一個變數是物件還是函式呢?其實,更多的時候,我們需要判斷一個物件是否能被呼叫,能被呼叫的物件就是一個Callable物件,比如函式和我們上面定義的帶有__call__()的類例項:

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