編譯：linux中國-Hank Chow，英文：Jeff Triplett

https://linux.cn/article-10059-1.html

檢查你的代碼的質(zhì)量，通過這些外部庫使其更易維護(hù)。

可讀性很重要。
— Python 之禪The Zen of Python，Tim Peters

隨著軟件項(xiàng)目進(jìn)入“維護(hù)模式”，對可讀性和編碼標(biāo)準(zhǔn)的要求很容易落空（甚至從一開始就沒有建立過那些標(biāo)準(zhǔn)）。然而，在代碼庫中保持一致的代碼風(fēng)格和測試標(biāo)準(zhǔn)能夠顯著減輕維護(hù)的壓力，也能確保新的開發(fā)者能夠快速了解項(xiàng)目的情況，同時能更好地全程保持應(yīng)用程序的質(zhì)量。

使用外部庫來檢查代碼的質(zhì)量不失為保護(hù)項(xiàng)目未來可維護(hù)性的一個好方法。以下會推薦一些我們最喜愛的檢查代碼（包括檢查 PEP 8 和其它代碼風(fēng)格錯誤）的庫，用它們來強(qiáng)制保持代碼風(fēng)格一致，并確保在項(xiàng)目成熟時有一個可接受的測試覆蓋率。

檢查你的代碼風(fēng)格

PEP 8 是 Python 代碼風(fēng)格規(guī)范，它規(guī)定了類似行長度、縮進(jìn)、多行表達(dá)式、變量命名約定等內(nèi)容。盡管你的團(tuán)隊(duì)自身可能也會有稍微不同于 PEP 8 的代碼風(fēng)格規(guī)范，但任何代碼風(fēng)格規(guī)范的目標(biāo)都是在代碼庫中強(qiáng)制實(shí)施一致的標(biāo)準(zhǔn)，使代碼的可讀性更強(qiáng)、更易于維護(hù)。下面三個庫就可以用來幫助你美化代碼。

1、 Pylint

Pylint 是一個檢查違反 PEP 8 規(guī)范和常見錯誤的庫。它在一些流行的編輯器和 IDE 中都有集成，也可以單獨(dú)從命令行運(yùn)行。

執(zhí)行 pip install pylint 安裝 Pylint 。然后運(yùn)行 pylint [options] path/to/dir 或者 pylint [options] path/to/module.py 就可以在命令行中使用 Pylint，它會向控制臺輸出代碼中違反規(guī)范和出現(xiàn)錯誤的地方。

你還可以使用 pylintrc 配置文件來自定義 Pylint 對哪些代碼錯誤進(jìn)行檢查。

2、 Flake8

Flake8 是“將 PEP 8、Pyflakes（類似 Pylint）、McCabe（代碼復(fù)雜性檢查器）和第三方插件整合到一起，以檢查 Python 代碼風(fēng)格和質(zhì)量的一個 Python 工具”。

執(zhí)行 pip install flake8 安裝 flake8 ，然后執(zhí)行 flake8 [options] path/to/dir 或者 flake8 [options] path/to/module.py 可以查看報出的錯誤和警告。

和 Pylint 類似，F(xiàn)lake8 允許通過配置文件來自定義檢查的內(nèi)容。它有非常清晰的文檔，包括一些有用的提交鉤子，可以將自動檢查代碼納入到開發(fā)工作流程之中。

Flake8 也可以集成到一些流行的編輯器和 IDE 當(dāng)中，但在文檔中并沒有詳細(xì)說明。要將 Flake8 集成到喜歡的編輯器或 IDE 中，可以搜索插件（例如 Sublime Text 的 Flake8 插件）。

3、 Isort

Isort 這個庫能將你在項(xiàng)目中導(dǎo)入的庫按字母順序排序，并將其正確劃分為不同部分（例如標(biāo)準(zhǔn)庫、第三方庫、自建的庫等）。這樣提高了代碼的可讀性，并且可以在導(dǎo)入的庫較多的時候輕松找到各個庫。

執(zhí)行 pip install isort 安裝 isort，然后執(zhí)行 isort path/to/module.py 就可以運(yùn)行了。文檔中還提供了更多的配置項(xiàng)，例如通過配置 .isort.cfg 文件來決定 isort 如何處理一個庫的多行導(dǎo)入。

和 Flake8、Pylint 一樣，isort 也提供了將其與流行的編輯器和 IDE 集成的插件。

分享你的代碼風(fēng)格

每次文件發(fā)生變動之后都用命令行手動檢查代碼是一件痛苦的事，你可能也不太喜歡通過運(yùn)行 IDE 中某個插件來實(shí)現(xiàn)這個功能。同樣地，你的同事可能會用不同的代碼檢查方式，也許他們的編輯器中也沒有那種插件，甚至你自己可能也不會嚴(yán)格檢查代碼和按照警告來更正代碼?？傊?，你分享出來的代碼庫將會逐漸地變得混亂且難以閱讀。

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

4、 Autopep8

Autopep8 可以自動格式化指定的模塊中的代碼，包括重新縮進(jìn)行、修復(fù)縮進(jìn)、刪除多余的空格，并重構(gòu)常見的比較錯誤（例如布爾值和 None 值）。你可以查看文檔中完整的更正列表。

運(yùn)行 pip install --upgrade autopep8 安裝 Autopep8。然后執(zhí)行 autopep8 --in-place --aggressive --aggressive 就可以重新格式化你的代碼。aggressive 選項(xiàng)的數(shù)量表示 Auotopep8 在代碼風(fēng)格控制上有多少控制權(quán)。在這里可以詳細(xì)了解 aggressive 選項(xiàng)。

5、 Yapf

Yapf 是另一種有自己的配置項(xiàng)列表的重新格式化代碼的工具。它與 Autopep8 的不同之處在于它不僅會指出代碼中違反 PEP 8 規(guī)范的地方，還會對沒有違反 PEP 8 但代碼風(fēng)格不一致的地方重新格式化，旨在令代碼的可讀性更強(qiáng)。

執(zhí)行 pip install yapf 安裝 Yapf，然后執(zhí)行 yapf [options] path/to/dir 或 yapf [options] path/to/module.py 可以對代碼重新格式化。定制選項(xiàng)的完整列表在這里。

6、 Black

Black 在代碼檢查工具當(dāng)中算是比較新的一個。它與 Autopep8 和 Yapf 類似，但限制較多，沒有太多的自定義選項(xiàng)。這樣的好處是你不需要去決定使用怎么樣的代碼風(fēng)格，讓 Black 來給你做決定就好。你可以在這里查閱 Black 有限的自定義選項(xiàng)以及如何在配置文件中對其進(jìn)行設(shè)置。

Black 依賴于 Python 3.6+，但它可以格式化用 Python 2 編寫的代碼。執(zhí)行 pip install black 安裝 Black，然后執(zhí)行 black path/to/dir 或 black path/to/module.py 就可以使用 Black 優(yōu)化你的代碼。

檢查你的測試覆蓋率

如果你正在進(jìn)行編寫測試，你需要確保提交到代碼庫的新代碼都已經(jīng)測試通過，并且不會降低測試覆蓋率。雖然測試覆蓋率不是衡量測試有效性和充分性的唯一指標(biāo)，但它是確保項(xiàng)目遵循基本測試標(biāo)準(zhǔn)的一種方法。對于計(jì)算測試覆蓋率，我們推薦使用 Coverage 這個庫。

7、 Coverage

Coverage 有數(shù)種顯示測試覆蓋率的方式，包括將結(jié)果輸出到控制臺或 HTML 頁面，并指出哪些具體哪些地方?jīng)]有被覆蓋到。你可以通過配置文件自定義 Coverage 檢查的內(nèi)容，讓你更方便使用。

執(zhí)行 pip install coverage 安裝 Converage 。然后執(zhí)行 coverage [path/to/module.py] [args] 可以運(yùn)行程序并查看輸出結(jié)果。如果要查看哪些代碼行沒有被覆蓋，執(zhí)行 coverage report -m 即可。

持續(xù)集成工具

持續(xù)集成Continuous integration（CI）是在合并和部署代碼之前自動檢查代碼風(fēng)格錯誤和測試覆蓋率最小值的過程。很多免費(fèi)或付費(fèi)的工具都可以用于執(zhí)行這項(xiàng)工作，具體的過程不在本文中贅述，但 CI 過程是令代碼更易讀和更易維護(hù)的重要步驟，關(guān)于這一部分可以參考 Travis CI 和 Jenkins。

以上這些只是用于檢查 Python 代碼的各種工具中的其中幾個。如果你有其它喜愛的工具，歡迎分享。

看完本文有收獲？請轉(zhuǎn)發(fā)分享給更多人

關(guān)注「Python開發(fā)者」，提升Python技能