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

可讀性很重要。
— 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 <filename> 就可以重新格式化你的代碼。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 即可。

持續集成工具

持續集成 Continuous integration （CI）是在合併和部署代碼之前自動檢查代碼風格錯誤和測試覆蓋率最小值的過程。很多免費或付費的工具都可以用於執行這項工作，具體的過程不在本文中贅述，但 CI 過程是令代碼更易讀和更易維護的重要步驟，關於這一部分可以參考 Travis CI 和 Jenkins。

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

via: https://opensource.com/article/18/7/7-python-libraries-more-maintainable-code

作者：Jeff Triplett 選題：lujun9972 譯者：HankChow 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive