Python靜態代碼檢查工具Flake8

Flake8 是由Python官方發布的一款輔助檢測Python代碼是否規范的工具,相對于目前熱度比較高的Pylint來說,Flake8檢查規則靈活,支持集成額外插件,擴展性強。Flake8是對下面三個工具的封裝:

1)PyFlakes:靜態檢查Python代碼邏輯錯誤的工具。

2)Pep8: 靜態檢查PEP8編碼風格的工具。

3)NedBatchelder’s McCabe :靜態分析Python代碼復雜度的工具。

不光對以上三個工具的封裝,Flake8還提供了擴展的開發接口。

官方文檔:https://pypi.python.org/pypi/flake8/

安裝

這里介紹兩種安裝方法:

1.在Ubuntu 16.04安裝Flake8。

apt-get update

apt-get install python-flake8

2.在Windows安裝Python之后,打開cmd,通過命令:

python -m pip install flake8

其中,代表著Python的版本號,可通過python –v或者python –version進行查看。

當然也可以直接按默認配置安裝Flake8:

python -m pip install flake8

可通過flake8 –help查看是否安裝成功。

建議還是按照Python版本號來鏡像安裝,Windows下以默認安裝形式做靜態代碼檢查,會檢測到與Python3一些沖突的地方,如下:

使用方法

文件結構如下:

1.檢查指定文件:Flake8 + Python項目名,標紅框表示通過Flake8默認配置檢測出來的問題。

從紅色方框中可以看到 Flake8檢測到了四個errors,歸類為H101、H233、F821,H開頭的是安裝hacking插件后檢測出來的錯誤,Flake8基礎錯誤返回碼一共有三類:

E***/W***: PEP8中的error和warning。

F***: 通過PyFlakes檢測出的error,其實PyFlakes本身是不提供錯誤返回碼的,flake8對pyflakes返回的錯誤消息進行了分類。

C9**: 通過McCabe檢測出的代碼復雜度。Flake8提供一個擴展選項:--max-complexity,如果函數的McCabe復雜度比給定的值更高將發出一個告警。該功能對于發現代碼過度復雜非常有用,根據Thomas J. McCabe, Sr(Cyclomaticcomplexity的創造者)研究,代碼復雜度不宜超過10,而Flake8官網建議值為12。

2.展示特定錯誤

假如靜態代碼檢查中想展示項目下的H233特定錯誤怎么辦呢?可以通過flake8 --select命令來實現:

flake8 --select H233 shadowtest

如果需要選擇以特定類型開頭的錯誤碼,eg:以E開頭

flake8 --select E shadowtest

如果需要選擇多個特定錯誤碼用逗號隔開就可以了,eg:錯誤碼1,錯誤碼2。

3.忽略特定錯誤碼

靜態代碼檢查忽略H233類型錯誤,設定多個忽略方法同上

flake8 --ignore H233 shadowtest

4.忽略特定文件/文件夾

靜態代碼檢查忽略test2.py文件,設定多個忽略方法同上

flake8 --exclude shadowtest/path2/test2.py shadowtest

靜態代碼檢查忽略path2整個文件,設定多個忽略方法同上

flake8 --exclude shadowtest/path2/shadowtest

5.輸出修改格式

flake8 --format=%(path)s::%(row)d,%(col)d::%(code)s::%(text)s shadowtest

假如想把代碼復雜度設為其他值,只看幾種類型的錯誤,并且有幾個文件夾下的內容不需要檢查是不是每次檢查都要把上面的設置重新輸入一遍?解決如下:配置文件。

Flake8它是支持將個人設定保存在配置文件里面的,我們可以通過以setup.cfg, tox.ini, 或者.flake8以上三種文件形式保存配置。

以tox.ini為例:

輸出結果前后對比:

未加入配置前:

加入tox.ini配置后:

假如ignore里面包含H101,但是select也包含H101怎么辦?

經過試驗:select的優先級比ignore高,兩者都含有相同的錯誤類型下,ignore的這一錯誤類型的檢查會被忽略掉。

假如存在多個配置文件,怎么處理?

可以通過flake8 --config=配置文件項目名稱,這種方式解決。

6.通過setup.py檢查工程中所有的python文件

關于setup.py相關概念參考這篇文章:http://lingxiankong.github.io/blog/2013/12/23/python-setup/

7.配置其他

關于Flake8更多命令參考:flake8 –help

Flake8的小插件

Flake8相比其他Python靜態代碼檢查工具的優勢在于其良好的擴展性,以下是介紹Flake8幾款比較流行的插件:

1.hacking

由于Python是OpenStack的官方語言,hacking則是根據OpenStack Style Guidelines所產生,基于原有的Google Python Style Guide和OpenStack自有規則而形成的。hacking官方文檔:https://pypi.python.org/pypi/hacking

插件安裝也非常簡單,通過pip安裝hacking,Windows cmd窗口執行:

python –m pip install

hackinghacking插件安裝完成之后,會新增一類錯誤返回碼以H開頭:H***:hacking返回的錯誤類型。

在hacking中有些錯誤類型檢測是默認關閉的,可以通過命令行或者配置文件修改開關:enable-extensions= H106,H203

2.pep8-naming

針對目前pep8尚未支持命名規范的檢查,有人開發出了此款插件作為規則補充。

pep8-naming插件安裝完成之后,會新增一類錯誤返回碼以N開頭:

N***: pep8-naming返回的錯誤類型。

其他插件可以通過命令:pip search flake8來搜索,肯定有你需要的,安裝也非常簡單:pip install 插件名稱

有些坑先提示一下:

規則檢查插件與插件之間,可能會存在重復提示,假如要排除一類則你的配置文件會越來越復雜,并不是安裝越多越好,工具不在于過多,而在于會用。

插件與插件之間,尤其是兩個新的插件可能無法完美兼容。eg:為了可視化,本人在flake8上面安裝了flake8-chart 0.1.5這一插件,

通過這一插件將flake8的分析結果轉化為圖形(只支持餅圖和柱狀圖)。

執行以下命令:

flake8 --statistics shadowtest |flake8chart--chart-type=BAR --chart-output=shadow.svg

在Jenkins上分析flake8的報告

在Flake8上安裝插件,flake8-junit-report將flake8的報告轉換為junit format,可以通過構建后操作 Publish Junit testresult report能不能輸出文檔:

1.安裝flake8-junit-report

2. pip install flake8-junit-report

3.輸出Flake8測試報告

4.flake8 --output-file flake8.txt shadowtest

5.轉換成junit測試結果的xml

6.python -m junit_conversor flake8.txt flake8_junit.xml

7.轉換成junit.xml報告:

8.在Jenkins上面展示:

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,247評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,520評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,362評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,805評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,541評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,896評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,887評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,062評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,608評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,356評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,555評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,077評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,769評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,175評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,489評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,289評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,516評論 2 379

推薦閱讀更多精彩內容

  • # Python 資源大全中文版 我想很多程序員應該記得 GitHub 上有一個 Awesome - XXX 系列...
    aimaile閱讀 26,535評論 6 427
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,826評論 18 139
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,922評論 6 342
  • GitHub 上有一個 Awesome - XXX 系列的資源整理,資源非常豐富,涉及面非常廣。awesome-p...
    若與閱讀 18,695評論 4 418
  • “夢而心兮曉真假,人間繁華到誰家,無心卻道敗諸神,東山一只尋石花。” 猴子從夢中驚醒,忽然聽到不遠處傳來一曲調子。...
    達哥嘮嗑小屋閱讀 3,397評論 6 8