程序員須要掌握的七種 Python 代碼更易維護的武器

檢查你的代碼風格

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

一、 Pylint

Pylint 是一個檢查違反 PEP 8 規範和常見錯誤的庫。它在一些流行的編輯器和 IDE 中都有集成，也能夠單獨從命令行運行。

執行 pip install pylint 安裝 Pylint 。而後運行 pylint [options] path/to/dir 或者 pylint [options] path/to/module.py 就能夠在命令行中使用 Pylint，它會向控制檯輸出代碼中違反規範和出現錯誤的地方。

你還能夠使用 pylintrc 配置文件來自定義 Pylint 對哪些代碼錯誤進行檢查。

二、 Flake8

Flake8 是「將 PEP 八、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 插件）。

三、 Isort

Isort 這個庫能將你在項目中導入的庫按字母順序排序，並將其正確劃分爲不一樣部分（例如標準庫、第三方庫、自建的庫等）。這樣提升了代碼的可讀性，而且能夠在導入的庫較多的時候輕鬆找到各個庫。

執行 pip install isort 安裝 isort，而後執行 isort path/to/module.py 就能夠運行了。文檔中還提供了更多的配置項，例如經過配置 .isort.cfg 文件來決定 isort 如何處理一個庫的多行導入。

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

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

四、 Autopep8

Autopep8 能夠自動格式化指定的模塊中的代碼，包括從新縮進行、修復縮進、刪除多餘的空格，並重構常見的比較錯誤（例如布爾值和 None 值）。你能夠查看文檔中完整的更正列表。

運行 pip install --upgrade autopep8 安裝 Autopep8。而後執行 autopep8 --in-place --aggressive --aggressive 就能夠從新格式化你的代碼。aggressive 選項的數量表示 Auotopep8 在代碼風格控制上有多少控制權。在這裏能夠詳細瞭解 aggressive 選項。

五、 Yapf

Yapf 是另外一種有本身的配置項列表的從新格式化代碼的工具。它與 Autopep8 的不一樣之處在於它不只會指出代碼中違反 PEP 8 規範的地方，還會對沒有違反 PEP 8 但代碼風格不一致的地方從新格式化，旨在令代碼的可讀性更強。

執行 pip install yapf 安裝 Yapf，而後執行 yapf [options] path/to/dir 或 yapf [options] path/to/module.py 能夠對代碼從新格式化。定製選項的完整列表在這裏。

六、 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

Coverage 有數種顯示測試覆蓋率的方式，包括將結果輸出到控制檯或 HTML 頁面，並指出哪些具體哪些地方沒有被覆蓋到。你能夠經過配置文件自定義 Coverage 檢查的內容，讓你更方便使用。

執行 pip install coverage 安裝 Converage 。而後執行 coverage [path/to/module.py] [args] 能夠運行程序並查看輸出結果。若是要查看哪些代碼行沒有被覆蓋，執行 coverage report -m 便可。

以上這些只是用於檢查 Python 代碼的各類工具中的其中幾個。若是你有其它喜好的工具，歡迎分享咱們將於你一塊兒學習。 更多Python技術文章清關注2019年，Python技術持續更新（附教程）