摘抄自：https://www.liaoxuefeng.com/wiki/0014316089557264a6b348958f449949df42a6d3a2e542c000/0014319170285543a4d04751f8846908770660de849f285000

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

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類：

# 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] 
 
= value

if __name__==‘__main__‘:         # 只有在命令行直接運行時，才執行doctest（在pycharm 裏也可以直接運行）
    import doctest
    doctest.testmod()

註意到最後3行代碼。當模塊正常導入時，doctest不會被執行。只有在命令行直接運行時，才執行doctest。所以，不必擔心doctest會在非測試環境下執行。

$ python3 mydict2.py

什麽輸出也沒有。這說明我們編寫的doctest運行都是正確的。如果程序有問題，比如把__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.

練習

對函數fact(n)編寫doctest並執行：

def fact(n):
    ‘‘‘
    >>> fact(1)
    1
    >>> fact(3)
    6
    >>> fact(-2)
    Traceback (most recent call last):
        ...
    ValueError
    ‘‘‘
    if n < 1:
        raise ValueError()
    if n == 1:
        return 1
    return n * fact(n - 1)

if __name__ == ‘__main__‘:
    import doctest
    doctest.testmod()

Python學習筆記（二十二）文檔測試