PyCharm編輯器結合Black外掛,輕鬆實現Python程式碼格式化

蜗牛渣渣發表於2024-05-09

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”的強大功能。

相關文章