如果你經常閱讀Python的官方文檔，可以看到很多文檔都有示例代碼。比如re模塊就帶了很多示例代碼：

>>> import re>>> m = re.search('(?<=abc)def', 'abcdef')>>> m.group(0)'def'

可以把這些示例代碼在Python的交互式環境下輸入并執行，結果與文檔中的示例代碼顯示的一致。

這些代碼與其他說明可以寫在注釋中，然后，由一些工具來自動生成文檔。既然這些代碼本身就可以粘貼出來直接運行，那么，可不可以自動執行寫在注釋中的這些代碼呢？

答案是肯定的。

當我們編寫注釋時，如果寫上這樣的注釋：

def abs(n):  '''  Function to get absolute value of number.  Example:  >>> abs(1)  1  >>> abs(-1)  1  >>> abs(0)  0  '''  return n if n >= 0 else (-n)

無疑更明確地告訴函數的調用者該函數的期望輸入和輸出。

并且，Python內置的“文檔測試”（doctest）模塊可以直接提取注釋中的代碼并執行測試。

doctest嚴格按照Python交互式命令行的輸入和輸出來判斷測試結果是否正確。只有測試異常的時候，可以用...表示中間一大段煩人的輸出。

讓我們用doctest來測試上次編寫的Dict類：

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 mydict.py：

$ python mydict.py

什么輸出也沒有。這說明我們編寫的doctest運行都是正確的。如果程序有問題，比如把__getattr__()方法注釋掉，再運行就會報錯：

$ python mydict.py**********************************************************************File "mydict.py", line 7, in __main__.DictFailed example:  d1.xException raised:  Traceback (most recent call last):   ...  AttributeError: 'Dict' object has no attribute 'x'**********************************************************************File "mydict.py", line 13, in __main__.DictFailed example:  d2.cException raised:  Traceback (most recent call last):   ...   AttributeError: 'Dict' object has no attribute 'c'**********************************************************************