1、簡(jiǎn)介

使用Black對(duì)Python代碼進(jìn)行格式化，可使代碼看起來更美觀。但是，隨著項(xiàng)目規(guī)模不斷變大，對(duì)每個(gè)文件運(yùn)行Black變得很繁瑣。能否在文件保存后立即運(yùn)行Black呢？本文就來介紹在PyCharm中實(shí)現(xiàn)這一目標(biāo)的方法。

2、安裝Black

首先，在虛擬環(huán)境中安裝Black。

$ pip install black

也可以從PyCharm首選項(xiàng)中安裝該軟件包。

• PyCharm > Preferences。
• 搜索“Python Interpreter”。
• 點(diǎn)擊“+”圖標(biāo)，并輸入“Black”。
• 點(diǎn)擊安裝軟件包。

圖片

安裝完Black后，點(diǎn)擊“Apply（應(yīng)用）”和“OK（確定）”。

3、Black基本設(shè)置

需要再次打開首選項(xiàng)。這次搜索外部工具。

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

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

圖片

• 點(diǎn)擊“OK（確定）”

現(xiàn)在，已經(jīng)完成了Black的基本設(shè)置，這樣就可以通過轉(zhuǎn)到“Tools（工具）”>“External Tools（外部工具）”>“Black”來格式化任何文件。

圖片

4、自動(dòng)保存時(shí)運(yùn)行Black

但是，如果必須對(duì)每個(gè)文件都這樣做，那么它怎么解決自動(dòng)保存時(shí)運(yùn)行Black的問題呢。

現(xiàn)在需要再次進(jìn)入首選項(xiàng)。

• Preferences > 搜索“File Watchers（文件監(jiān)視器）”。
• 在Tools > File Watchers下，點(diǎn)擊“+”圖標(biāo)。
• 選擇“custom（自定義）”。

圖片

在彈出的對(duì)話框中，

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

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

圖片

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

現(xiàn)在，只需重新啟動(dòng)PyCharm實(shí)例，就可以見證“Black”的強(qiáng)大功能。