[[386201]]

【51CTO.com快譯】雖然Python語言可謂目前最為靈活的開發(fā)語言之一，但是開發(fā)人員往往會(huì)濫用其靈活性，甚至?xí)`反相關(guān)的標(biāo)準(zhǔn)。因此，Python代碼也經(jīng)常會(huì)出現(xiàn)如下常見質(zhì)量問題：

• 導(dǎo)入了一些未曾用到的模塊
• 函數(shù)在各種調(diào)用中缺少參數(shù)
• 缺少適當(dāng)?shù)母袷娇s進(jìn)
• 在圓括號(hào)、方括號(hào)或大括號(hào)的前后缺少恰當(dāng)?shù)目崭?/li>

顯然，上述問題不但會(huì)影響代碼的可讀性，而且會(huì)使得代碼的審查工作變得更為復(fù)雜。為此，我們需要通過諸如PyLint或Flake8之類的靜態(tài)分析工具來解決此問題，并減少各種可能出現(xiàn)的誤報(bào)現(xiàn)象。

與此同時(shí)，隨著軟件開發(fā)團(tuán)隊(duì)規(guī)模的擴(kuò)大，許多開發(fā)人員經(jīng)常需要使用靜態(tài)代碼分析工具(Static Code Analysis Tool)，在開發(fā)的早期階段，協(xié)助團(tuán)隊(duì)盡早地識(shí)別出各種代碼級(jí)別的錯(cuò)誤，以及反模式(anti-patterns)上的漏洞。

總體而言，靜態(tài)代碼分析工具會(huì)在每次提交或提取請(qǐng)求時(shí)，分析目標(biāo)程序代碼，并在軟件產(chǎn)品的實(shí)際部署與發(fā)布之前，發(fā)現(xiàn)程序代碼在質(zhì)量、安全性、以及樣式等各類問題。在本文中，我將向您介紹適合開發(fā)者的七種最佳Python代碼審查工具，以方便您根據(jù)實(shí)際開發(fā)項(xiàng)目做出選擇。

1. DeepSource

DeepSource針對(duì)各種通用編程語言(例如Python、Javascript、Golang等)，提供了靜態(tài)代碼分析。在實(shí)際使用中，DeepSource會(huì)生成一個(gè)能夠被嵌入在存儲(chǔ)庫中的配置文件，以便對(duì)代碼進(jìn)行持續(xù)分析。由于提供了自定義的功能，因此我們可以使用DeepSource來輕松地開展，針對(duì)Python代碼的靜態(tài)分析。

DeepSource的主要功能包括：

• 可以通過單個(gè)文件配置，來進(jìn)行持續(xù)分析
• 支持諸如Black和AutoPep8之類的風(fēng)格代碼排版工具
• 能夠?qū)γ總€(gè)拉取請(qǐng)求進(jìn)行質(zhì)量檢查
• 提供對(duì)于常見問題的自動(dòng)修復(fù)
• 可嵌入到Travis CI之類的CI/CD管道中，以提高測(cè)試覆蓋率

與其他各種靜態(tài)代碼分析工具相比，DeepSource提供了較低的誤報(bào)率和解決用時(shí)。由于提供了與對(duì)應(yīng)框架的訪問權(quán)限，因此維護(hù)人員可以輕松地使用DeepSource進(jìn)行應(yīng)用審查。

此外，為了方便對(duì)私有存儲(chǔ)庫執(zhí)行各項(xiàng)操作，DeepSource能夠?qū)τ诿總€(gè)拉取請(qǐng)求或提交，使用專用的令牌來獲取代碼，并且在隔離的環(huán)境中進(jìn)行分析。而在分析完成后，它會(huì)主動(dòng)清除代碼庫，以減少安全風(fēng)險(xiǎn)的暴露。

2. Codacy

Codacy可以為各種通用編程語言(如Python)提供代碼審查，提交有關(guān)代碼覆蓋率、重復(fù)率和復(fù)雜性等方面的報(bào)告。同時(shí)，它可以幫助開發(fā)人員在保持代碼完整性的基礎(chǔ)上，開展“純凈”的代碼審查。

Codacy的主要功能包括：

• 提供代碼審查的自動(dòng)化
• 可以持續(xù)分析代碼的質(zhì)量
• 通過提供各種自動(dòng)化的資源建議，來提醒開發(fā)人員
• 可以通過屏蔽“噪聲”，讓用戶專注于新出現(xiàn)的問題
• 能夠單獨(dú)地分析各個(gè)拉取請(qǐng)求與提交

主要缺點(diǎn)是：

• 無法讓開發(fā)人員對(duì)發(fā)現(xiàn)的問題進(jìn)行優(yōu)先級(jí)排序
• 缺少可導(dǎo)出代碼模式的功能
• 設(shè)置與配置頁面較為復(fù)雜
• 誤報(bào)率較高

3. SonarQube

SonarQube以執(zhí)行自動(dòng)檢查的方式，提供了對(duì)于代碼質(zhì)量的持續(xù)分析。作為一種靜態(tài)代碼分析工具，它可以發(fā)現(xiàn)Python中的代碼錯(cuò)誤、反模式、以及安全漏洞。當(dāng)然，SonarQube也很容易與CI/CD管道相匹配，進(jìn)行有效的代碼質(zhì)量管理。

SonarQube自帶了兩個(gè)子工具，其中Sonar Scanner負(fù)責(zé)執(zhí)行分析，SonarQube Server則負(fù)責(zé)對(duì)結(jié)果進(jìn)行管理和保存。

SonarQube的主要功能包括：

• 可識(shí)別諸如安全漏洞，以及執(zhí)行路徑錯(cuò)誤等棘手的問題
• 通過提供對(duì)Webhooks(微服務(wù)API使用的一種范式)和API的訪問，來自動(dòng)執(zhí)行代碼的審查過程
• 可根據(jù)不同的要求和實(shí)踐，來加強(qiáng)質(zhì)量關(guān)(quality gate)
• 通過提供各種流行IDE的插件，從而減輕了對(duì)整體軟件包的需求

主要缺點(diǎn)是：

• 缺乏設(shè)置自動(dòng)分析和警報(bào)能力
• 缺乏對(duì)某些問題的選擇性忽略或不予修復(fù)功能
• 由于需要通過安裝軟件包和插件，來設(shè)置客戶端分析和服務(wù)器端存儲(chǔ)，因此為Python項(xiàng)目設(shè)置SonarQube較為復(fù)雜，您可以查看其官方文檔，以了解更多有關(guān)如何為Python項(xiàng)目配置SonarQube的信息

4. Veracode

Veracode是另一款流行的Python代碼審查工具。它不僅提供了針對(duì)常見漏洞和安全暴露的掃描，而且能夠通過靜態(tài)分析，來識(shí)別并報(bào)告反模式等問題。此外，Veracode還可以提供包括交互式分析和動(dòng)態(tài)分析在內(nèi)的其他企業(yè)級(jí)產(chǎn)品。

Veracode的主要功能包括：

• 通過提供開發(fā)者工具、API和工作流的集成，以簡(jiǎn)化代碼質(zhì)量的檢查
• 可與DevOps管道無縫集成
• 其基于SCA代理的掃描，可用于發(fā)現(xiàn)各種問題與漏洞
• 其代碼庫和許可證可與PyPi(Python Package Index)保持同步
• 在每次掃描后，都能轉(zhuǎn)發(fā)有關(guān)風(fēng)險(xiǎn)的評(píng)級(jí)

主要缺點(diǎn)是：

• 缺乏一勞永逸的持續(xù)集成設(shè)置
• 缺乏直觀的用戶體驗(yàn)

總的說來，安裝和設(shè)置基于Veracode代理的掃描代理相對(duì)比較容易。您可以使用Python的標(biāo)準(zhǔn)軟件包管理器—pip，來安裝該工具，并執(zhí)行代碼分析。不過，Veracode既缺乏優(yōu)化掃描的功能，又缺乏針對(duì)特定語言的建議。

5. Checkmarx

Checkmarx是一款應(yīng)用安全性測(cè)試和靜態(tài)代碼分析的工具。它提供了靜態(tài)應(yīng)用測(cè)試、運(yùn)行時(shí)(runtime)、交互式測(cè)試、依賴項(xiàng)掃描等功能，可輕松地通過掃描源代碼，來消除各種漏洞。

Checkmarx的主要功能包括：

• 用戶可使用Checkmarx SAST，來進(jìn)行靜態(tài)分析，并查找各種安全漏洞
• 提供與CI/CD管道的集成
• 具有直觀易用的用戶界面
• 提供各種流行的IDE插件

主要缺點(diǎn)是：

• 誤報(bào)率較高
• 在持續(xù)集成的過程中，需要花費(fèi)大量時(shí)間進(jìn)行掃描

客觀來說，Checkmarx的優(yōu)勢(shì)在于，無需配置即可為大多數(shù)通用編程語言，提供原生的支持。其劣勢(shì)集中在誤報(bào)率較高，且缺乏對(duì)大型代碼庫的支持。

6. Coverity

作為一個(gè)靜態(tài)分析工具，Coverity旨在查找和修復(fù)各種通用編程語言(如Python、Javascript、Ruby、Java等)中的缺陷。波音和洛克希德·馬丁等明星公司都會(huì)使用Coverity，來進(jìn)行軟件代碼的測(cè)試和掃描。

Coverity的主要功能包括：

• 通過測(cè)試各種可能執(zhí)行到的路徑，來減少誤報(bào)率
• 易于設(shè)置和自定義，可靈活地滿足開發(fā)需求
• 提供設(shè)置向?qū)?，以方便指定Python的路徑
• 能夠輕松地與GitHub、Jenkins和Travis CI等工作流程相集成

主要缺點(diǎn)是：

• 其許可程度取決于需要分析的代碼行數(shù)
• 與市場(chǎng)上的同類產(chǎn)品相比，其價(jià)格過高
• 當(dāng)被測(cè)代碼庫龐大且復(fù)雜時(shí)，為了滿足覆蓋范圍，其運(yùn)行時(shí)間較長。

7. CodeScene

CodeScene不僅是一款靜態(tài)代碼分析工具，而且能夠提供行為分析，以方便開發(fā)人員根據(jù)代碼庫的演化，以識(shí)別不同的模式。用戶既可以通過Git服務(wù)提供商(如Github或Bitbucket)去調(diào)用CodeScene，也可以在本地直接使用。

CodeScene的主要功能包括：

• 可以分析版本控制的歷史記錄，并產(chǎn)生可視化的效果
• 能夠方便開發(fā)者發(fā)現(xiàn)各種錯(cuò)誤和問題
• 可以使用機(jī)器學(xué)習(xí)算法，來查找不同的模式
• 可以根據(jù)業(yè)務(wù)需求來調(diào)整代碼質(zhì)量
• 不但能夠確保團(tuán)隊(duì)遠(yuǎn)離技術(shù)風(fēng)險(xiǎn)，還能夠協(xié)助識(shí)別生產(chǎn)環(huán)境中的各種瓶頸

主要缺點(diǎn)是：

• 缺乏直觀的用戶界面
• 用戶難以跟進(jìn)錯(cuò)誤并改進(jìn)代碼

小結(jié)

綜上所述，代碼審查工具可以協(xié)助開發(fā)人員識(shí)別到現(xiàn)有代碼的復(fù)雜性，查找出各種反模式之類的問題、以及安全缺陷，并能夠讓代碼審查與修復(fù)的過程更加高效。因此，您可以根據(jù)手頭項(xiàng)目的特征，酌情進(jìn)行選擇與試用。

【原標(biāo)題】7 Best Python Code Review Tools Recommended by Developers，作者：Saif Sadiq

【51CTO譯稿，合作站點(diǎn)轉(zhuǎn)載請(qǐng)注明原文譯者和出處為51CTO.com】