文檔測試
如果你經常閱讀Python的官方文檔，可以看到很多文檔都有示例代碼。比如re子產品就帶了很多示例代碼:
>>>import re
>>>m = re.search('(?<=abc)def','abcdef')
>>>m.group(0)
'def'
這些文檔和其他說明可以寫在注釋中，然後，由一些工具來自動生成文檔。既然這些代碼本身可以粘貼出來直接運作，那麼可不可以自動執行這些寫在注釋中的代碼呢？
答案是肯定的。
當我們如果編寫注釋時，寫上這樣的注釋：
def abs(n):
'''
Function to get absolute value of number.
Example:
>>>abs(1)
1
>>>abs(-1)
1
>>>abs(0)
'''
return n if n >=0 else(-n)
無疑更明确的告訴函數調用者該函數期望的輸入和輸出。
并且，Python内置的‘文檔測試(doctest)’子產品會直接提取注釋中的代碼并執行測試。
doctest嚴格按照Python互動式指令行的輸入和輸出判斷測試結果是否正确。隻有測試異常的時候，可以用...一大段煩人的輸出。
讓我們用doctest來測試我們上次編寫的Dict類:
# mydict2.py
class Dict(dict):
'''
Simple dict but also support access as x.y style.
>>> d1 = Dict()
>>> d1['x'] = 100
>>> d1.x
100
>>> d1.y = 200
>>> d1['y']
200
>>> d2 = Dict(a=1, b=2, c='3')
>>> d2.c
'3'
>>> d2['empty']
Traceback (most recent call last):
...
KeyError: 'empty'
>>> d2.empty
Traceback (most recent call last):
...
AttributeError: 'Dict' object has no attribute 'empty'
'''
def __init__(self, **kw):
super(Dict, self).__init__(**kw) def __getattr__(self, key):
try: return self[key] except KeyError: raise AttributeError(r"'Dict' object has no attribute '%s'" % key) def __setattr__(self, key, value):
self[key] = valueif __name__=='__main__': import doctest
doctest.testmod() 複制
運作Python mydict2.py
什麼輸出也沒有，說明我們編寫的docttest都是正确的。如果程式有問題，比如，将__getattr__()方法注釋掉，在運作就會報錯:
$ python3 mydict2.py
**********************************************************************
File "/Users/michael/Github/learn-python3/samples/debug/mydict2.py", line 10, in __main__.Dict
Failed example:
d1.x
Exception raised:
Traceback (most recent call last):
...
AttributeError: 'Dict' object has no attribute 'x'
**********************************************************************
File "/Users/michael/Github/learn-python3/samples/debug/mydict2.py", line 16, in __main__.Dict
Failed example:
d2.c
Exception raised:
Traceback (most recent call last):
...
AttributeError: 'Dict' object has no attribute 'c'
**********************************************************************
1 items had failures:
2 of 9 in __main__.Dict
***Test Failed*** 2 failures. 複制
關注最後3行代碼，當子產品正常導入時，doctest不會被執行。隻有在指令直接運作時，才執行doctest。是以，不必擔心doctest會在非測試環境下被運作。
小結：
doctest非常有用，不但可以用來測試，還可以直接作為示例代碼。通過某些文檔生成工具，就可以自動把包含doctest的注釋提取出來。同時也看到了doctest。