介紹Python中的文檔測試模塊
如果你經(jīng)常閱讀Python的官方文檔,可以看到很多文檔都有示例代碼。比如re模塊就帶了很多示例代碼:
>>> import re >>> m = re.search('(?<=abc)def', 'abcdef') >>> m.group(0) 'def'
可以把這些示例代碼在Python的交互式環(huán)境下輸入并執(zhí)行,結(jié)果與文檔中的示例代碼顯示的一致。
這些代碼與其他說明可以寫在注釋中,然后,由一些工具來自動生成文檔。既然這些代碼本身就可以粘貼出來直接運(yùn)行,那么,可不可以自動執(zhí)行寫在注釋中的這些代碼呢?
答案是肯定的。
當(dāng)我們編寫注釋時,如果寫上這樣的注釋:
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)置的“文檔測試”(doctest)模塊可以直接提取注釋中的代碼并執(zhí)行測試。
doctest嚴(yán)格按照Python交互式命令行的輸入和輸出來判斷測試結(jié)果是否正確。只有測試異常的時候,可以用...表示中間一大段煩人的輸出。
讓我們用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] = value if __name__=='__main__': import doctest doctest.testmod()
運(yùn)行python mydict.py:
$ python mydict.py
什么輸出也沒有。這說明我們編寫的doctest運(yùn)行都是正確的。如果程序有問題,比如把__getattr__()方法注釋掉,再運(yùn)行就會報錯:
$ 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)入時,doctest不會被執(zhí)行。只有在命令行運(yùn)行時,才執(zhí)行doctest。所以,不必?fù)?dān)心doctest會在非測試環(huán)境下執(zhí)行。
小結(jié)
doctest非常有用,不但可以用來測試,還可以直接作為示例代碼。通過某些文檔生成工具,就可以自動把包含doctest的注釋提取出來。用戶看文檔的時候,同時也看到了doctest。
- PyCharm-錯誤-找不到指定文件python.exe的解決方法
- 解決python寫入帶有中文的字符到文件錯誤的問題
- Python中出現(xiàn)IndentationError:unindent does not match any outer indentation level錯誤的解決方法
- 淺談Python在pycharm中的調(diào)試(debug)
- VSCode下配置python調(diào)試運(yùn)行環(huán)境的方法
- 如何使用VSCode愉快的寫Python于調(diào)試配置步驟
- Python單元和文檔測試實(shí)例詳解
- python錯誤調(diào)試及單元文檔測試過程解析
相關(guān)文章
詳解python數(shù)據(jù)結(jié)構(gòu)之棧stack
這篇文章主要介紹了詳解python數(shù)據(jù)結(jié)構(gòu)之棧stack,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)python的小伙伴們有很好的幫助,需要的朋友可以參考下2021-05-05opencv-python 開發(fā)環(huán)境的安裝、配置教程詳解
這篇文章主要介紹了opencv-python 開發(fā)環(huán)境的安裝、配置,本文分步驟通過圖文并茂的形式給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-09-09python django 原生sql 獲取數(shù)據(jù)的例子
今天小編就為大家分享一篇python django 原生sql 獲取數(shù)據(jù)的例子,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-08-08使用 prometheus python 庫編寫自定義指標(biāo)的方法(完整代碼)
這篇文章主要介紹了使用 prometheus python 庫編寫自定義指標(biāo)的方法,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-06-06如何使用draw.io插件在vscode中一體化導(dǎo)出高質(zhì)量圖片
這篇文章主要介紹了draw.io插件在vscode中一體化導(dǎo)出高質(zhì)量圖片需要的工具是vscode,?draw.io擴(kuò)展,draw.io桌面版?、python,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒,需要的朋友可以參考下2022-08-083分鐘看懂Python后端必須知道的Django的信號機(jī)制
這篇文章主要介紹了3分鐘看懂Python后端必須知道的Django的信號機(jī)制,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07