天天看點

Python代碼審閱工具Pylint

Pylint 是什麼

Pylint是一個Python靜态代碼分析工具,它查找程式設計錯誤、幫助執行編碼标準,查找不符合代碼風格标準(Pylint 預設使用的代碼風格是 PEP 8)和有潛在問題的代碼。除了平常代碼分析工具的作用之外,它提供了更多的功能:如檢查一行代碼的長度,變量名是否符合命名标準,一個聲明過的接口是否被真正實作;Pylint 的一個很大的好處是它的高可配置性,高可定制性,并且可以很容易寫小插件來添加功能;目前在 PyCharm 中也內建了 Pylint。

pip安裝

pip install pylint

Python代碼審閱工具Pylint

四、規範的代碼有助于代碼審閱(說白了别人看着舒服,也能看懂)

三、規範的代碼可以降低維護成本

二、規範的代碼可以減少人力資源投入

一、規範的代碼可以促進團隊開發

代碼規範的重要性

離線包安裝python setup.py install

更新 pip install pylint --upgrade幫助

-h,--help : 顯示所有幫助資訊

PyCharm 配置pylint過程

File > Settings> Tools > External Tools,點選 + 号添加,如下圖配置

Python代碼審閱工具Pylint
Python代碼審閱工具Pylint

AFTERNOON

一個夏日的午後

Python代碼審閱工具Pylint

Program設定為:指向 pylint 的實際目錄,此處以 windows10目錄為例

Parameters 設定為 (使用者可根據自己的情況,選擇 pylint 輸出資訊顯示格式和要 disable 的項目):

--output-format=parseable --disable=R --disable=C0102,C0103,C0111,C0301,C0302,C0303,C0304,C0305,W0120,W0123,W0401,W0603,W0612,W0614,W0621,W0622,W0703,E1003,E1101 $FilePath$      

注:為了防止 Pylint 列印找不到 配置檔案的 warning,可以在目前工程目錄下建立一個空的檔案,取名為 .pylintrc,再在上述參數中加入選項 --rcfile=path/to/.pylintrc 即可。

Working Direcroty 設定為:$FileDir$

Python代碼審閱工具Pylint
Python代碼審閱工具Pylint