快捷導(dǎo)航

介紹Python中的文檔測(cè)試模塊

更新時(shí)間：2015年04月28日 11:33:17 作者：廖雪峰

這篇文章主要介紹了Python中的文檔測(cè)試模塊,代碼基于Python2.x版本,需要的朋友可以參考下

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

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

可以把這些示例代碼在Python的交互式環(huán)境下輸入并執(zhí)行，結(jié)果與文檔中的示例代碼顯示的一致。

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

答案是肯定的。

當(dāng)我們編寫注釋時(shí)，如果寫上這樣的注釋：

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)

無疑更明確地告訴函數(shù)的調(diào)用者該函數(shù)的期望輸入和輸出。

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

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

讓我們用doctest來測(cè)試上次編寫的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] = value

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

運(yùn)行python mydict.py：

$ python mydict.py

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

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

注意到最后兩行代碼。當(dāng)模塊正常導(dǎo)入時(shí)，doctest不會(huì)被執(zhí)行。只有在命令行運(yùn)行時(shí)，才執(zhí)行doctest。所以，不必?fù)?dān)心doctest會(huì)在非測(cè)試環(huán)境下執(zhí)行。
小結(jié)

doctest非常有用，不但可以用來測(cè)試，還可以直接作為示例代碼。通過某些文檔生成工具，就可以自動(dòng)把包含doctest的注釋提取出來。用戶看文檔的時(shí)候，同時(shí)也看到了doctest。

您可能感興趣的文章: