如何使用 Black 程式碼格式化工具

python 是當今使用最多的流行程式語言之一，因為：它是開源的，它有廣泛的用途（例如 Web 程式設計、業務應用、遊戲、科學程式設計等等），它有一個充滿活力和專注的社群支援它。這個社群可以讓我們在 Python Package Index（PyPI）中有如此龐大、多樣化的軟體包，用以擴充套件和改進 Python 並解決不可避免的問題。

在本系列中，我們將介紹七個可以幫助你解決常見 Python 問題的 PyPI 庫。在第一篇文章中，我們瞭解了 Cython。今天，我們將使用 Black 這個程式碼格式化工具。

有時創意可能是一件美妙的事情。有時它只是一種痛苦。我喜歡創造性地解決難題，但我希望我的 Python 格式儘可能一致。沒有人對使用“有趣”縮排的程式碼印象深刻。

但是比不一致的格式更糟糕的是除了檢查格式之外什麼都沒有做的程式碼審查。這對審查者來說很煩人，對於被審查者來說甚至更煩人。當你的 linter 告訴你程式碼縮排不正確時，但沒有提示 正確 的縮排量，這也會令人氣憤。

使用 Black，它不會告訴你 要 做什麼，它是一個優良、勤奮的機器人：它將為你修復程式碼。

要了解它如何工作的，請隨意寫一些非常不一致的內容，例如：

def add(a, b): return a+b
def mult(a, b):
return \
a * b

Black 抱怨了麼？並沒有，它為你修復了！

$ black math 
reformatted math
All done! ✨ ? ✨
1 file reformatted.
$ cat math 
def add(a, b):
return a + b
def mult(a, b):
return a * b

Black 確實提供了報錯而不是修復的選項，甚至還有輸出 diff 編輯樣式的選項。這些選項在持續整合 （CI）系統中非常有用，可以在本地強制執行 Black。此外，如果 diff 輸出被記錄到 CI 輸出中，你可以直接將其貼上到 patch 中，以便在極少數情況下你需要修復輸出，但無法本地安裝 Black 使用。

$ black --check --diff bad 
--- math 2019-04-09 17:24:22.747815 +0000
+++ math 2019-04-09 17:26:04.269451 +0000
@@ -1,7 +1,7 @@
-def add(a, b): return a + b
+def add(a, b):
+ return a + b
def mult(a, b):
- return \
- a * b
+ return a * b
would reformat math
All done! ? ? ?
1 file would be reformatted.
$ echo $?
1

在本系列的下一篇文章中，我們將介紹 attrs ，這是一個可以幫助你快速編寫簡潔、正確的程式碼的庫。