配置 PyCharm 的自動(dòng)代碼檢查

為了管控代碼與提高代碼質(zhì)量，需要對(duì)代碼進(jìn)行代碼檢查。通常我們會(huì)通過IDE自帶功能或者第三方工具。本節(jié)的主要內(nèi)容是講解 PyCharm 自帶的代碼檢查如何配置，如何使用與運(yùn)行，也會(huì)簡(jiǎn)單介紹第三方工具 Pylint 在 PyCharm 如何配置與使用。

1. 代碼檢查主要功能

PyCharm 的代碼檢查功能也是相較于其它Python IDE 表現(xiàn)更為突出的功能，主要功能如下：

• PyCharm 具有強(qiáng)大、快速和靈活的靜態(tài)代碼分析功能， IDE可以查找和突出顯示各種問題，查找死代碼，查找可能的錯(cuò)誤，拼寫問題，并改進(jìn)整個(gè)代碼結(jié)構(gòu)。

• 檢查不僅檢測(cè)編譯錯(cuò)誤，還檢測(cè)不同的代碼效率低下。每當(dāng)有一些無法訪問的代碼、未使用的代碼、非本地化的字符串、未解析的方法、內(nèi)存泄漏時(shí)，都會(huì)很快找到它。

• PyCharm的代碼分析可靈活配置。您可以啟用/禁用每個(gè)代碼檢查并更改其嚴(yán)重性、使用自定義檢查集創(chuàng)建配置文件、在不同的范圍內(nèi)以不同的方式應(yīng)用檢查、禁止特定代碼片段中的檢查等。

• 每次檢查都有一個(gè)嚴(yán)重級(jí)別 -問題會(huì)影響代碼的程度。在編輯器中以不同的方式突出顯示嚴(yán)重性，以便快速區(qū)分關(guān)鍵問題和不太重要的事情。

2. 代碼檢查配置

2.1 基本配置

在主菜單上， PyCharm/File -> Preferences/Settings -> Editor -> Inspections， 在這可以進(jìn)行檢查項(xiàng)的啟用與禁用，以及每個(gè)檢查項(xiàng)的嚴(yán)重級(jí)別、檢查范圍，也可指定自己的配置文件。

2.2 定制自己的配置文件

PyCharm 允許你為代碼驗(yàn)證分析配置設(shè)置，并將其保存為檢查配置文件。你可以自定義現(xiàn)有檢查配置文件（包括默認(rèn)配置文件）并創(chuàng)建新的檢查配置文件。你還可以共享、導(dǎo)入和導(dǎo)出檢查配置文件。

PyCharm 區(qū)分 IDE 和項(xiàng)目配置文件。

存儲(chǔ)在 IDE 中
這些配置文件保存在應(yīng)用程序配置目錄中（例如Mac，~/Application Support/JetBrains/PyCharm2020.1/inspection），可用于任何項(xiàng)目。Default 配置是存在IDE中的。

存儲(chǔ)在項(xiàng)目中
這些配置文件保存在特定項(xiàng)目的 .idea 目錄中（例如，$PROJECT_DIR/.idea/ 檢查配置文件）。

Tips：通常在實(shí)際工作中，會(huì)把配置文件存在項(xiàng)目中，并通過 VCS 共享。在配置新項(xiàng)目配置文件并與團(tuán)隊(duì)的其他成員共享后，此配置文件將在VCS 簽出項(xiàng)目后自動(dòng)共享到我們的項(xiàng)目。

點(diǎn)擊齒輪設(shè)置按鈕，通過拷貝默認(rèn)的配置，在項(xiàng)目下或者 IDE 創(chuàng)建新的配置文件。

拷貝的附本是與默認(rèn)配置一致的，我們可以在附本中對(duì)檢查項(xiàng)啟用或者禁用，也可重新規(guī)定嚴(yán)重級(jí)別與檢查范圍等，最后點(diǎn)擊 Apply，就創(chuàng)建了自己的配置文件。

3. 運(yùn)行代碼檢查

3.1 自動(dòng)檢查打開的文件

PyCharm 自動(dòng)分析編輯器中打開的文件中的代碼，并在鍵入時(shí)突出顯示異常代碼。

將鼠標(biāo)懸停在條帶上的標(biāo)記上，以查看工具提示中檢測(cè)到的問題。單擊標(biāo)記可跳轉(zhuǎn)到相應(yīng)的代碼字符串。對(duì)于大多數(shù)代碼問題，PyCharm 提供了快速修復(fù)，可以按 ??(Alt +Enter) 顯示所有建議。

Tips ：通過按 F2 可以在編輯器中從一個(gè)突出顯示的字符串導(dǎo)航到另一個(gè)字符串。

3.2 指定范圍運(yùn)行代碼檢查

step1：在編輯器中打開所需的文件。或者，在"Project"工具窗口中選擇文件或目錄( 按住 Ctrl/?)。初始檢查范圍將限于打開的文件或選擇；
step2：在主菜單上，選擇 code -> inspection code；
step3：將打開 “Specify Inspection Scope” 對(duì)話框, 指定應(yīng)檢查哪些文件。

step4：?jiǎn)螕?ok"以運(yùn)行代碼分析。 并在 Inspection Results 工具欄查看結(jié)果。

step5：嘗試修復(fù)問題。在檢查結(jié)果工具窗口中，選擇代碼問題，擊右鍵，會(huì)顯示修復(fù)建議，如果沒有修復(fù)建議，只能跳轉(zhuǎn)到源代碼手工修改。(雖然警告信息可能不影響程序運(yùn)行，從代碼規(guī)范來講，也應(yīng)該盡量減少警告信息的數(shù)量）。

Tips：PyCharm 允許禁止對(duì)特定語句、函數(shù)/方法、標(biāo)記進(jìn)行某些檢查?？梢酝ㄟ^ Suppress for Function 或者 Suppress for Class實(shí)現(xiàn)。

3.3 按名字進(jìn)行代碼檢查

step1：在編輯器中打開所需的文件?；蛘?，在"Project"工具窗口中選擇文件或目錄( 按住 Ctrl/?)。初始檢查范圍將限于打開的文件或選擇。

step2： 在主菜單上，選擇 code -> Run inspection by name。在打開的彈出框中，鍵入檢查名稱，鍵入時(shí)，建議列表將收縮，僅顯示匹配的檢查。

Tips：后面的操作與指定范圍操作是一致的。

3.4 通過命令行進(jìn)行代碼檢查

對(duì)于大型項(xiàng)目，執(zhí)行定期的代碼檢查，這是尤其重要的。在持續(xù)集成、持續(xù)交付、持續(xù)部署（CI/CD）中執(zhí)行代碼檢查也是重要的環(huán)節(jié)。我們可以從命令行啟動(dòng)檢查器，而無需實(shí)際運(yùn)行 PyCharm。

命令行參數(shù)：

1. 啟動(dòng)器路徑(Path to the launcher)：指定到啟動(dòng)器完整路徑（位于 PyCharm 安裝的 bin 目錄下，必須指定完整的路徑）：

   Windows:： inspect.bat
   UNIX 和 macOS：inspect.sh
   

2. 項(xiàng)目文件路徑(Project file path): 是包含要檢查的項(xiàng)目的目錄的完整路徑。
3. 檢查配置文件路徑(Inspection profile path ): 是配置文件的完整路徑。
4. 輸出路徑(Output path): 是要存儲(chǔ)報(bào)告的完整路徑。
5. 可選參數(shù)： 要檢查的目錄 -d [到子目錄的完整路徑]
   輸出日志的詳細(xì)級(jí)別 -vX ，其中 X 為 0 表示簡(jiǎn)單，1 表示較細(xì)，2 表示詳細(xì)。

MAC 例子：

Applications/PyCharm.app/Contents/bin/inspect.sh ~/PycharmProjects/untitled2 ~/PycharmProjects/untitled2/.idea/inspectionProfiles/default_copy.xml  ~/PycharmProjects/untitled2/results-dir -v2

Tips：執(zhí)行命令時(shí)，請(qǐng)關(guān)閉PyCharm。

查看結(jié)果：

1. 在主菜單上，選擇 Code -> View Offline Inspection Results。
2. 在打開的"Select Path "對(duì)話框中，導(dǎo)航到包含 XML 格式的檢查結(jié)果的目錄。
3. 單擊"OK"。檢查結(jié)果顯示在"Inspection results"工具窗口中的"Offline View "選項(xiàng)卡中。

4. Pylint

Pylint 是一個(gè) Python 代碼分析工具，它分析 Python 代碼中的錯(cuò)誤，查找不符合代碼風(fēng)格標(biāo)準(zhǔn)和有潛在問題的代碼。如檢查一行代碼的長度，變量名是否符合命名標(biāo)準(zhǔn)，一個(gè)聲明過的接口是否被真正實(shí)現(xiàn)等等。Pylint 還有一個(gè)好處是它的高可配置性，高可定制性。

Tips: PyCharm 本身提供的代碼檢查已經(jīng)非常豐富了，如果不是特別要求，筆者不建議在PyCharm里使用Pylint。但畢竟Pylint 是著名的代碼分析工具，PyCharm也是支持的。所以，本節(jié)只簡(jiǎn)單介紹如何在PyCharm 配置 pylint。

4.1 安裝 pylint

想要使用 pylint 需要先安裝：

pip install pyint

4.2 配置 Pyint 在 PyCharm

1. 在主菜單上依次點(diǎn)擊： PyCharm/File -> Preferences/Settings -> Tools -> External Tools

Tips：如想加更多參數(shù)，請(qǐng)參考 Pylint運(yùn)行參數(shù)。

2. 點(diǎn)擊 “OK”, 添加外部工具成功。
   

3. 重啟PyCharm, 主菜單 Tools -> External Tools -> pylint。

4. 查看輸出。

5. 小結(jié)

代碼檢查是保證代碼質(zhì)量的有效手段，很多公司都要求程序員在提交代碼時(shí)根據(jù)定制的檢查配置進(jìn)行代碼檢查，達(dá)不到要求，可能導(dǎo)致提交失敗。在持續(xù)集成過程中，在最新代碼被構(gòu)建后也會(huì)先運(yùn)行代碼靜態(tài)走查，只有輸出結(jié)果符合公司的代碼規(guī)范，才會(huì)進(jìn)行單元測(cè)試等后續(xù)過程。所以，掌握如何進(jìn)行代碼檢查，并且根據(jù)提示做出修正是作為開發(fā)人員必要技能。