檢查你的代碼的質量，通過這些外部庫使其更易維護。
可讀性很重要。
—Python之禪TheZenofPython，TimPeters
隨著軟件項目進入“維護模式”，對可讀性和編碼標準的要求很容易落空(甚至從一開始就沒有建立過那些標準)。然而，在代碼庫中保持一致的代碼風格和測試標準能夠顯著減輕維護的壓力，也能確保新的開發者能夠快速了解項目的情況，同時能更好地全程保持應用程序的質量。
使用外部庫來檢查代碼的質量不失為保護項目未來可維護性的一個好方法。以下會推薦一些我們最喜愛的檢查代碼(包括檢查PEP8和其它代碼風格錯誤)的庫，用它們來強制保持代碼風格一致，并確保在項目成熟時有一個可接受的測試覆蓋率。
檢查你的代碼風格
PEP8是Python代碼風格規范，它規定了類似行長度、縮進、多行表達式、變量命名約定等內容。盡管你的團隊自身可能也會有稍微不同于PEP8的代碼風格規范，但任何代碼風格規范的目標都是在代碼庫中強制實施一致的標準，使代碼的可讀性更強、更易于維護。下面三個庫就可以用來幫助你美化代碼。
1、Pylint
Pylint是一個檢查違反PEP8規范和常見錯誤的庫。它在一些流行的編輯器和IDE中都有集成，也可以單獨從命令行運行。
執行pipinstallpylint安裝Pylint。然后運行pylint[options]path/to/dir或者pylint[options]path/to/module.py就可以在命令行中使用Pylint，它會向控制臺輸出代碼中違反規范和出現錯誤的地方。
你還可以使用pylintrc配置文件來自定義Pylint對哪些代碼錯誤進行檢查。
2、Flake8
Flake8是“將PEP8、Pyflakes(類似Pylint)、McCabe(代碼復雜性檢查器)和第三方插件整合到一起，以檢查Python代碼風格和質量的一個Python工具”。
執行pipinstallflake8安裝flake8，然后執行flake8[options]path/to/dir或者flake8[options]path/to/module.py可以查看報出的錯誤和警告。
和Pylint類似，Flake8允許通過配置文件來自定義檢查的內容。它有非常清晰的文檔，包括一些有用的提交鉤子，可以將自動檢查代碼納入到開發工作流程之中。
Flake8也可以集成到一些流行的編輯器和IDE當中，但在文檔中并沒有詳細說明。要將Flake8集成到喜歡的編輯器或IDE中，可以搜索插件(例如SublimeText的Flake8插件)。
3、Isort
Isort這個庫能將你在項目中導入的庫按字母順序排序，并將其正確劃分為不同部分(例如標準庫、第三方庫、自建的庫等)。這樣提高了代碼的可讀性，并且可以在導入的庫較多的時候輕松找到各個庫。
執行pipinstallisort安裝isort，然后執行isortpath/to/module.py就可以運行了。文檔中還提供了更多的配置項，例如通過配置.isort.cfg文件來決定isort如何處理一個庫的多行導入。
和Flake8、Pylint一樣，isort也提供了將其與流行的編輯器和IDE集成的插件。
分享你的代碼風格
每次文件發生變動之后都用命令行手動檢查代碼是一件痛苦的事，你可能也不太喜歡通過運行IDE中某個插件來實現這個功能。同樣地，你的同事可能會用不同的代碼檢查方式，也許他們的編輯器中也沒有那種插件，甚至你自己可能也不會嚴格檢查代碼和按照警告來更正代碼。總之，你分享出來的代碼庫將會逐漸地變得混亂且難以閱讀。
一個很好的解決方案是使用一個庫，自動將代碼按照PEP8規范進行格式化。我們推薦的三個庫都有不同的自定義級別來控制如何格式化代碼。其中有一些設置較為特殊，例如Pylint和Flake8，你需要先行測試，看看是否有你無法忍受但又不能修改的默認配置。
4、Autopep8
Autopep8可以自動格式化指定的模塊中的代碼，包括重新縮進行、修復縮進、刪除多余的空格，并重構常見的比較錯誤(例如布爾值和None值)。你可以查看文檔中完整的更正列表。
運行pipinstall--upgradeautopep8安裝Autopep8。然后執行autopep8--in-place--aggressive--aggressive就可以重新格式化你的代碼。aggressive選項的數量表示Auotopep8在代碼風格控制上有多少控制權。在這里可以詳細了解aggressive選項。
5、Yapf
Yapf是另一種有自己的配置項列表的重新格式化代碼的工具。它與Autopep8的不同之處在于它不僅會指出代碼中違反PEP8規范的地方，還會對沒有違反PEP8但代碼風格不一致的地方重新格式化，旨在令代碼的可讀性更強。
執行pipinstallyapf安裝Yapf，然后執行yapf[options]path/to/dir或yapf[options]path/to/module.py可以對代碼重新格式化。定制選項的完整列表在這里。
6、Black
Black在代碼檢查工具當中算是比較新的一個。它與Autopep8和Yapf類似，但限制較多，沒有太多的自定義選項。這樣的好處是你不需要去決定使用怎么樣的代碼風格，讓Black來給你做決定就好。你可以在這里查閱Black有限的自定義選項以及如何在配置文件中對其進行設置。
Black依賴于Python3.6+，但它可以格式化用Python2編寫的代碼。執行pipinstallblack安裝Black，然后執行blackpath/to/dir或blackpath/to/module.py就可以使用Black優化你的代碼。
檢查你的測試覆蓋率
如果你正在進行編寫測試，你需要確保提交到代碼庫的新代碼都已經測試通過，并且不會降低測試覆蓋率。雖然測試覆蓋率不是衡量測試有效性和充分性的唯一指標，但它是確保項目遵循基本測試標準的一種方法。對于計算測試覆蓋率，我們推薦使用Coverage這個庫。
7、Coverage
Coverage有數種顯示測試覆蓋率的方式，包括將結果輸出到控制臺或HTML頁面，并指出哪些具體哪些地方沒有被覆蓋到。你可以通過配置文件自定義Coverage檢查的內容，讓你更方便使用。
執行pipinstallcoverage安裝Converage。然后執行coverage[path/to/module.py][args]可以運行程序并查看輸出結果。如果要查看哪些代碼行沒有被覆蓋，執行coveragereport-m即可。
持續集成工具
持續集成Continuousintegration(CI)是在合并和部署代碼之前自動檢查代碼風格錯誤和測試覆蓋率最小值的過程。很多免費或付費的工具都可以用于執行這項工作，具體的過程不在本文中贅述，但CI過程是令代碼更易讀和更易維護的重要步驟，關于這一部分可以參考TravisCI和Jenkins。
以上內容為大家介紹了讓Python代碼更易維護的工具，希望對大家有所幫助，如果想要了解更多Python相關知識，請關注IT培訓機構:千鋒教育。http://www.jun-ho.cn/
京公網安備 11010802030320號