代碼可讀性是評判代碼品質的标準之一，有一個衡量代碼品質的标準是 Martin 提出的 “WFT” 定律，即每分鐘爆出 “WTF” 的次數。你在讀别人代碼或者做 Code Review 的時候有沒有 “WTF” 沖動呢？
為了幫助開發者統一代碼風格，Python 社群提出了 PEP8 代碼編碼風格，它并沒有強制要求大家必須遵循，Python 官方同時推出了一個檢查代碼風格是否符合 PEP8 的工具，名字也叫 pep8，後來被重命名為了pycodestyle。
看如下代碼：
import time, datetime
class ListNode:
def __init__(self, val):
self.val = val
self.next = None
# in python next is a reversed word
def reverse(self, head):
prev = None
while head:
temp = head.next
head.next = prev
prev = head
head = temp
a = [
[
1,
u'hello world',
0
],
[
2,
"hello python",
0
],
]
這是一個不符合 PEP8 的代碼段，用 pycodestyle 可檢測有哪些地方不符合 PEP8 風格
$ pycodestyle link.py
link.py:1: [E401] multiple imports on one line
link.py:3: [E302] expected 2 blank lines, found 1
pycodestyle 提示我們有兩處地方不符合規範，第一個是單行有多個 import，第二個是類與子產品之間需要空兩行，這隻是一個簡單代碼示例，真正的業務代碼可能有上百行甚至幾百行，如果我們要根據 PEP8 規範逐個進行修改建議會非常耗時，而我們的開發過程中，如果時刻關注每一行代碼是否完全遵循 PEP8，将影響開發效率。
而有這麼一款工具 Black，号稱不妥協的代碼格式化工具，為什麼叫不妥協呢？因為它檢測到不符合規範的代碼風格直接就幫你全部格式化好，根本不需要你确定，直接替你做好決定。它也是 requests 作者最喜歡的工具之一
使用非常簡單，安裝成功後，和其他系統指令一樣使用，隻需在 black 指令後面指定需要格式化的檔案或者目錄就ok
black link.py
這是一款小而美的工具，它并不是完全按照 PEP8 規範來格式化，比如預設每行代碼的字元數是88個，當然你可以通過參數 -l 自定義長度，能一行顯示完成的代碼會放在一行，比如有多個元素的清單
# in:
l = [1,
2,
3,
]
# out:
l = [1, 2, 3]
後者把多個元素放在一行，顯然更易讀，而且代碼更緊湊（如果你的工資是按照代碼行數來算的話，不建議這麼做），Black 是 PEP8 的嚴格子集。我的最佳實踐方式就是使用 PyCharm 自帶的格式化工具配合 Black 使用。因為 Black 也支援內建到 Pycharm 中。
如何內建 Pycharm
1、 安裝black：
pip install black
2、 找到 black 的安裝路徑
$ which black # linux/mac
$ where black # windows
3、 添加擴充工具，打開 Preferences->Tools->External Tools ，添加一個新的擴充工具，Program 填 black 的安裝路徑，Arguments 填 $FilePath$
4、選擇 Tools-> External Tools-> Black 即可對目前打開的檔案斤西瓜代碼格式化，當然，你還可以為其指定一個快捷鍵，使操作起來更友善。
值得注意的是，該工具隻支援 Python3.6 環境，同時還處在 beta 版本。
原文釋出時間為：2018-07-21
本文作者：劉志軍
本文來自雲栖社群合作夥伴“
Python愛好者社群”，了解相關資訊可以關注“
”