推薦一個小而美的 Python 格式化工具

代碼可讀性是評判代碼質量的標準之一，有一個衡量代碼質量的標準是 Martin 提出的 「WFT」 定律，即每分鐘爆出 「WTF」 的次數。你在讀別人代碼或者做 Code Review 的時候有沒有 「WTF」 衝動呢？

為了幫助開發者統一代碼風格，Python 社區提出了 PEP8 代碼編碼風格，它並沒有強制要求大家必須遵循，Python 官方同時推出了一個檢查代碼風格是否符合 PEP8 的工具，名字也叫 pep8，後來被重命名為了 pycodestyle。

看如下代碼：

這是一個不符合 PEP8 的代碼段，用 pycodestyle 可檢測有哪些地方不符合 PEP8 風格。

pycodestyle 提示我們有兩處地方不符合規範，第一個是單行有多個 import，第二個是類與模塊之間需要空兩行，這只是一個簡單代碼示例，真正的業務代碼可能有上百行甚至幾百行，如果我們要根據 PEP8 規範逐個進行修改建議會非常耗時，而我們的開發過程中，如果時刻關注每一行代碼是否完全遵循 PEP8，將影響開發效率。

而有這麼一款工具 Black，號稱不妥協的代碼格式化工具，為什麼叫不妥協呢？因為它檢測到不符合規範的代碼風格直接就幫你全部格式化好，根本不需要你確定，直接替你做好決定。它也是 requests 作者最喜歡的工具之一

使用非常簡單，安裝成功後，和其他系統命令一樣使用，只需在 black 命令後面指定需要格式化的文件或者目錄就ok。

這是一款小而美的工具，它並不是完全按照 PEP8 規範來格式化，比如默認每行代碼的字元數是88個，當然你可以通過參數 -l 自定義長度，能一行顯示完成的代碼會放在一行，比如有多個元素的列表

後者把多個元素放在一行，顯然更易讀，而且代碼更緊湊（如果你的工資是按照代碼行數來算的話，不建議這麼做），Black 是 PEP8 的嚴格子集。我的最佳實踐方式就是使用 PyCharm 自帶的格式化工具配合 Black 使用。因為 Black 也支持集成到 Pycharm 中。

如何集成 Pycharm？

1、 安裝black：

2、 找到 black 的安裝路徑

3、 添加擴展工具，打開 Preferences->Tools->External Tools ，添加一個新的擴展工具，Program 填 black 的安裝路徑，Arguments 填 $FilePath$

4、選擇 Tools-> External Tools-> Black 即可對當前打開的文件斤西瓜代碼格式化，當然，你還可以為其指定一個快捷鍵，使操作起來更方便。

值得注意的是，該工具只支持 Python3.6 環境

原文：https://www.toutiao.com/a6558976206853636616/

題圖：pexels，CC0 授權。

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！