概述
人生苦短,我用Python
Python
用註釋寫單元測試:doctest
單元測試是代碼開發環節必不可少的壹環,對於Bug定位和代碼質量而言是非常重要的。
舉個例子:
這是壹個求N的階乘函數示例,在docstring 中通過>>>符號來開始壹個單元測試,然後換行輸入預期結果即可。就是復制粘貼壹下調試過程結果,超級簡單,想實現TDD也因此變得很容易。
用註釋寫API文檔:apidoc
完成機器學習模型後,提供對外服務的接口來貢獻我們的算力時就要用到完整的API文檔,通過API的調用才能為我們的模型源源不斷的提供校驗數據,對提升模型效果具有相當的意義。
而利用 apidoc 可以很好地解決這些API文檔中常見的諸多問題.相當於通過模板提升了我們的接口設計的能力。
l例如:
這是壹個API接口的定義方法,最核心的部分就是
路由
GET/POST方法
名稱/分組
參數與調用例子
咱可以直接擼個示例來學習怎麽使用apidoc,先下載示例源碼。
git clone /apidoc/apidoc
cd apidoc
再來安裝 apidoc 組件
sudo npm install apidoc -g
直接用官方代碼制作壹個例子,去訪問就可以了。
apidoc -i example/-o output/-t template/
open output/index.html
apidoc的官方文檔賊簡單賊清晰,我就不過多強調語法了。
apidoc 提供了接口調試功能,在實際使用時要註意:
我們需要壹個web server 才可以使用這個接口調試的功能。
要註意跨域的問題。
使用註釋寫命令行接口:docopt
例如:
在命令行中我們可以成功調用
fiannceR.py tcp 0.0.0.03838
arguments 會傳出壹個字典對象,以Key-Value的形式將命令行中的輸入值捕獲。
最後
真要從數據擼到模型、接口,那麽壹排註釋的畫面美的無法想象。
歡迎大家留言討論,也可以加下我的群給出更多應用案例,交流分享。