前言
通常我們的python代碼都是遵循PEP8的規范化格式,目的是為了保持代碼的一致性、可讀性。,這里給大家推薦幾個常用的靜態代碼檢查工具,大家可以酌情選擇使用
1. pylint
Pylint是一個Python靜態代碼分析工具,它可以查找編程錯誤,幫助強制執行編碼標準,嗅探代碼異味并提供簡單的重構建議。
它具有高度可配置性,具有特殊的編譯指示來控制代碼中的錯誤和警告,以及廣泛的配置文件。也可以編寫自己的插件來添加自己的檢查或以某種方式擴展pylint。
缺省情況下,PyLint 啟用許多規則。它具有高度可配置性,從代碼內部處理程序控制它。另外,編寫插件添加到自己的檢查中是可能的。
安裝
pip install pylint #如果您使用的是Python 3.6+,請升級以獲得對您的版本的完全支持: pip install pylint --upgrade #如果要從源分發版安裝,請解壓縮tarball并運行以下命令 python setup.py install
文檔
Pylint附帶以下附加命令:
- pyreverse:一個UML圖生成器
- symilar:一個獨立的相似性檢查器
- epylint:Emacs和Flymake兼容的Pylint
使用
?pylint的各種引用以及使用方式都可以去文檔查找,這里僅介紹一下比較基礎簡單的示例
pylint [options] modules_or_packages
命令行選項
參數 | 含義 |
---|---|
--version | 顯示程序的版本號并退出 |
-h, --help | 顯示有關命令行選項的幫助 |
--ignore=
|
將文件或目錄添加到黑名單。它們應該是基本名稱,而不是路徑。 |
--output-format=
|
選擇輸出格式(文本,json,自定義)。 |
--list-msgs | 生成pylint的消息。 |
錯誤代碼含義
- C:慣例,違反了編碼風格標準
- R:重構,代碼非常糟糕
- W:警告,某些 Python 特定的問題
- E:錯誤,很可能是代碼中的錯誤
- F:致命錯誤,阻止 Pylint 進一步運行的錯誤
更多pylint相關可參考文檔
2. yapf:
Python的大多數當前格式化程序 - 例如,autopep8和pep8ify ---用于從代碼中刪除lint錯誤。這有一些明顯的局限性。例如,符合PEP 8指南的代碼可能無法重新格式化。但這并不意味著代碼看起來很好。
YAPF采用不同的方法。它基于由Daniel Jasper開發的'clang-format'。從本質上講,算法會獲取代碼并將其重新格式化為符合樣式指南的最佳格式,即使原始代碼沒有違反樣式指南。這個想法也類似于Go編程語言的'gofmt'工具:結束所有關于格式化的神圣戰爭
如果項目的整個代碼庫只是通過YAPF進行修改,只要進行修改,樣式在整個項目中保持一致,并且沒有必要在每次代碼審查中爭論風格。
最終目標是YAPF生成的代碼與程序員在遵循樣式指南時編寫的代碼一樣好。它消除了維護代碼的一些苦差事。
安裝
pip install yapf
使用
yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN] [--style STYLE] [--style-help] [--no-local-style] [-p] [-vv] [files [files ...]]
同上,一樣也可以直接跟文件進行操作
參數 | 參數說明 |
---|---|
-h, --help | 顯示此幫助消息并退出 |
-v, --version | 顯示版本號并退出 |
-d, --diff | 比較差異 |
-i, --in-place | 對文件進行更改 |
-r, --recursive | 以遞歸方式運行目錄 |
示例
#直接跟文件名(并不修改文件) yapf#格式化前后對比 yapf -d #直接修改源文件 yapf -i #導出配置文件 yapf --style-help > style.cfg #并發格式化多個文件,需要futures模塊支持 yapf -pi *.py
更多yapf相關可參考yapf
其他的此類工具還有Pyflakes,flake8等等,小編直接出到這兩個常用的,更多內容大家在項目實戰中應該會有更多接觸
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
更多文章、技術交流、商務合作、聯系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
