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有個神奇的切片方法:
>>> 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()
函數,我們就可以判斷一個對象是否是“可調用”對象。
參考鏈接:https://www.liaoxuefeng.com/wiki/001374738125095c955c1e6d8bb493182103fac9270762a000/0013946328809098c1be08a2c7e4319bd60269f62be04fa000
python 的定制類