讓 Python 代碼更易維護的七種武器——代碼風格（pylint、Flake8、Isort、Autopep8、Yapf、Black）測試覆寫率（Coverage）CI（JK）

讓 Python 代碼更易維護的七種武器

2018/09/29 · ​​基礎知識​​ · ​​武器​​

 Jeff Triplett   linux中國-Hank Chow   

檢查你的代碼的品質，通過這些外部庫使其更易維護。

可讀性很重要。

— ​​Python 之禅​​The Zen of Python，Tim Peters

随着軟體項目進入“維護模式”，對可讀性和編碼标準的要求很容易落空（甚至從一開始就沒有建立過那些标準）。然而，在代碼庫中保持一緻的代碼風格和測試标準能夠顯著減輕維護的壓力，也能確定新的開發者能夠快速了解項目的情況，同時能更好地全程保持應用程式的品質。

使用外部庫來檢查代碼的品質不失為保護項目未來可維護性的一個好方法。以下會推薦一些我們最喜愛的​​檢查代碼​​（包括檢查 PEP 8 和其它代碼風格錯誤）的庫，用它們來強制保持代碼風格一緻，并確定在項目成熟時有一個可接受的測試覆寫率。

檢查你的代碼風格

​​PEP 8​​ 是 Python 代碼風格規範，它規定了類似行長度、縮進、多行表達式、變量命名約定等内容。盡管你的團隊自身可能也會有稍微不同于 PEP 8 的代碼風格規範，但任何代碼風格規範的目标都是在代碼庫中強制實施一緻的标準，使代碼的可讀性更強、更易于維護。下面三個庫就可以用來幫助你美化代碼。

1、 Pylint

​​Pylint​​ 是一個檢查違反 PEP 8 規範和常見錯誤的庫。它在一些流行的​​編輯器和 IDE​​ 中都有內建，也可以單獨從指令行運作。

執行 ​

​pip install pylint​

​ 安裝 Pylint 。然後運作 ​

​pylint [options] path/to/dir​

​ 或者 ​

​pylint [options] path/to/module.py​

​ 就可以在指令行中使用 Pylint，它會向控制台輸出代碼中違反規範和出現錯誤的地方。

你還可以使用 ​

​pylintrc​

​ ​​配置檔案​​來自定義 Pylint 對哪些代碼錯誤進行檢查。

2、 Flake8

​​Flake8​​ 是“将 PEP 8、Pyflakes（類似 Pylint）、McCabe（代碼複雜性檢查器）和第三方插件整合到一起，以檢查 Python 代碼風格和品質的一個 Python 工具”。

​pip install flake8​

​ 安裝 flake8 ，然後執行 ​

​flake8 [options] path/to/dir​

​flake8 [options] path/to/module.py​

​ 可以檢視報出的錯誤和警告。

和 Pylint 類似，Flake8 允許通過​​配置檔案​​來自定義檢查的内容。它有非常清晰的文檔，包括一些有用的​​送出鈎子​​，可以将自動檢查代碼納入到開發工作流程之中。

Flake8 也可以內建到一些流行的編輯器和 IDE 當中，但在文檔中并沒有詳細說明。要将 Flake8 內建到喜歡的編輯器或 IDE 中，可以搜尋插件（例如 ​​Sublime Text 的 Flake8 插件​​）。

3、 Isort

​​Isort​​ 這個庫能将你在項目中導入的庫按字母順序排序，并将其​​正确劃分為不同部分​​（例如标準庫、第三方庫、自建的庫等）。這樣提高了代碼的可讀性，并且可以在導入的庫較多的時候輕松找到各個庫。

​pip install isort​

​ 安裝 isort，然後執行 ​

​isort path/to/module.py​

​ 就可以運作了。​​文檔​​中還提供了更多的配置項，例如通過​​配置​​ ​

​.isort.cfg​

​ 檔案來決定 isort 如何處理一個庫的多行導入。

和 Flake8、Pylint 一樣，isort 也提供了将其與流行的​​編輯器和 IDE​​ 內建的插件。

分享你的代碼風格

每次檔案發生變動之後都用指令行手動檢查代碼是一件痛苦的事，你可能也不太喜歡通過運作 IDE 中某個插件來實作這個功能。同樣地，你的同僚可能會用不同的代碼檢查方式，也許他們的編輯器中也沒有那種插件，甚至你自己可能也不會嚴格檢查代碼和按照警告來更正代碼。總之，你分享出來的代碼庫将會逐漸地變得混亂且難以閱讀。

一個很好的解決方案是使用一個庫，自動将代碼按照 PEP 8 規範進行格式化。我們推薦的三個庫都有不同的自定義級别來控制如何格式化代碼。其中有一些設定較為特殊，例如 Pylint 和 Flake8 ，你需要先行測試，看看是否有你無法忍受但又不能修改的預設配置。

4、 Autopep8

​​Autopep8​​ 可以自動格式化指定的子產品中的代碼，包括重新縮進行、修複縮進、删除多餘的空格，并重構常見的比較錯誤（例如布爾值和 ​

​None​

​ 值）。你可以檢視文檔中完整的​​更正清單​​。

運作 ​

​pip install --upgrade autopep8​

​ 安裝 Autopep8。然後執行 ​

​autopep8 --in-place --aggressive --aggressive ​

​就可以重新格式化你的代碼。​

​aggressive​

​ 選項的數量表示 Auotopep8 在代碼風格控制上有多少控制權。在這裡可以詳細了解 ​​aggressive​​ 選項。

5、 Yapf

​​Yapf​​ 是另一種有自己的​​配置項​​清單的重新格式化代碼的工具。它與 Autopep8 的不同之處在于它不僅會指出代碼中違反 PEP 8 規範的地方，還會對沒有違反 PEP 8 但代碼風格不一緻的地方重新格式化，旨在令代碼的可讀性更強。

​pip install yapf​

​ 安裝 Yapf，然後執行 ​

​yapf [options] path/to/dir​

​ 或 ​

​yapf [options] path/to/module.py​

​ 可以對代碼重新格式化。​​定制選項​​的完整清單在這裡。

6、 Black

​​Black​​ 在代碼檢查工具當中算是比較新的一個。它與 Autopep8 和 Yapf 類似，但限制較多，沒有太多的自定義選項。這樣的好處是你不需要去決定使用怎麼樣的代碼風格，讓 Black 來給你做決定就好。你可以在這裡查閱 Black ​​有限的自定義選項​​以及​​如何在配置檔案中對其進行設定​​。

Black 依賴于 Python 3.6+，但它可以格式化用 Python 2 編寫的代碼。執行 ​

​pip install black​

​ 安裝 Black，然後執行 ​

​black path/to/dir​

​black path/to/module.py​

​ 就可以使用 Black 優化你的代碼。

檢查你的測試覆寫率

如果你正在進行編寫測試，你需要確定送出到代碼庫的新代碼都已經測試通過，并且不會降低測試覆寫率。雖然測試覆寫率不是衡量測試有效性和充分性的唯一名額，但它是確定項目遵循基本測試标準的一種方法。對于計算測試覆寫率，我們推薦使用 Coverage 這個庫。

7、 Coverage

​​Coverage​​ 有數種顯示測試覆寫率的方式，包括将結果輸出到控制台或 HTML 頁面，并指出哪些具體哪些地方沒有被覆寫到。你可以通過​​配置檔案​​自定義 Coverage 檢查的内容，讓你更友善使用。

​pip install coverage​

​ 安裝 Converage 。然後執行 ​

​coverage [path/to/module.py] [args]​

​ 可以運作程式并檢視輸出結果。如果要檢視哪些代碼行沒有被覆寫，執行 ​

​coverage report -m​

​ 即可。

持續內建工具