python代碼格式化工具Black怎么用

python 是當(dāng)今使用最多的流行編程語言之一，因?yàn)椋核情_源的，它有廣泛的用途（例如 Web 編程、業(yè)務(wù)應(yīng)用、游戲、科學(xué)編程等等），它有一個(gè)充滿活力和專注的社區(qū)支持它。這個(gè)社區(qū)可以讓我們在 Python Package Index（PyPI）中有如此龐大、多樣化的軟件包，用以擴(kuò)展和改進(jìn) Python 并解決不可避免的問題。

Black

有時(shí)創(chuàng)意可能是一件美妙的事情。有時(shí)它只是一種痛苦。我喜歡創(chuàng)造性地解決難題，但我希望我的 Python 格式盡可能一致。沒有人對使用“有趣”縮進(jìn)的代碼印象深刻。

但是比不一致的格式更糟糕的是除了檢查格式之外什么都沒有做的代碼審查。這對審查者來說很煩人，對于被審查者來說甚至更煩人。當(dāng)你的 linter 告訴你代碼縮進(jìn)不正確時(shí)，但沒有提示正確的縮進(jìn)量，這也會令人氣憤。

使用 Black，它不會告訴你要做什么，它是一個(gè)優(yōu)良、勤奮的機(jī)器人：它將為你修復(fù)代碼。

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

def add(a, b): return a+b

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

Black 抱怨了么？并沒有，它為你修復(fù)了！

$ 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 確實(shí)提供了報(bào)錯(cuò)而不是修復(fù)的選項(xiàng)，甚至還有輸出 diff 編輯樣式的選項(xiàng)。這些選項(xiàng)在持續(xù)集成 （CI）系統(tǒng)中非常有用，可以在本地強(qiáng)制運(yùn)行 Black。此外，如果 diff 輸出被記錄到 CI 輸出中，你可以直接將其粘貼到 patch 中，以便在極少數(shù)情況下你需要修復(fù)輸出，但無法本地安裝 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