1、簡介

使用Black對Python代碼進行格式化，可使代碼看起來更美觀。但是，隨著項目規模不斷變大，對每個文件運行Black變得很繁瑣。能否在文件保存后立即運行Black呢？本文就來介紹在PyCharm中實現這一目標的方法。

2、安裝Black

首先，在虛擬環境中安裝Black。

$ pip install black

也可以從PyCharm首選項中安裝該軟件包。

• PyCharm > Preferences。
• 搜索“Python Interpreter”。
• 點擊“+”圖標，并輸入“Black”。
• 點擊安裝軟件包。

圖片

安裝完Black后，點擊“Apply（應用）”和“OK（確定）”。

3、Black基本設置

需要再次打開首選項。這次搜索外部工具。

• Preference > Tools > External Tools。
• 點擊“+”圖標。
• 在名稱輸入框中填寫想要的名稱，并添加一些描述。
• 在工具設置中，按以下方式更新。

Programs: $PyInterpreterDirectory$/black
Arguments: $FilePath$
Working directory: $ProjectFileDir$

圖片

• 點擊“OK（確定）”

現在，已經完成了Black的基本設置，這樣就可以通過轉到“Tools（工具）”>“External Tools（外部工具）”>“Black”來格式化任何文件。

圖片

4、自動保存時運行Black

但是，如果必須對每個文件都這樣做，那么它怎么解決自動保存時運行Black的問題呢。

現在需要再次進入首選項。

• Preferences > 搜索“File Watchers（文件監視器）”。
• 在Tools > File Watchers下，點擊“+”圖標。
• 選擇“custom（自定義）”。

圖片

在彈出的對話框中，

• 在“Name（名稱）”中輸入選擇的名稱。
• 在文件類型中選擇“Python”。
• 在“tool to run on changes（更改時運行的工具）”中輸入以下內容。

Program: $PyInterpreterDirectory$/black
Arguments: $FilePath$
Output paths to refresh: $FilePath$
Working directory: $ProjectFileDir$

圖片

點擊“OK（確定）”，然后就可以開始使用了。

現在，只需重新啟動PyCharm實例，就可以見證“Black”的強大功能。