相關(guān)資料:https://muzing.top/posts/a29e4743/#the-black-code-style
Black 自稱“零妥協(xié)代碼格式化工具(The uncompromising code formatter)”。
截止到 2022 年 5 月,Black 已經(jīng)在 GitHub 斬獲 27.4k 個 Stars,由 Google 開發(fā)維護的 YAPF 為 12.5k ,而 autopep8 則只有 4.1k ??梢哉f Black 是目前最廣受好評的 Python 代碼格式化工具。
安裝
可以通過 pip 直接從 PyPI 下載安裝:
pip install black
集成到PyCharm
相比于每次都專門打開一個終端,手動使用命令行調(diào)用 Black 格式化代碼,我們更希望能把 Black 集成到我們常用的 IDE / 編輯器中,不需要離開寫代碼的界面即可完成格式化操作。
確認Black安裝位置
在 macOS / Linux / BSD 上:
$ which black
/usr/local/bin/black # 可能的位置
在 Windows 上:
$ where black
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # 可能的位置
在 PyCharm 中添加外部工具
打開 文件 -> 設置 -> 工具 -> 外部工具
File -> Settings -> Tools -> External Tools
創(chuàng)建工具
- 名稱:Black
- 描述:毫不妥協(xié)的 Python 代碼格式化工具
- 程序:「上一小節(jié)得到的安裝位置」
- 參數(shù):
$FilePath$ - 工作目錄:
$ProjectFileDir$
設置-工具-外部工具
使用
在已經(jīng)打開的代碼編輯界面(或項目文件樹的某個目錄上)鼠標右鍵,找到 External Tools -> Black,點擊即可。
設置快捷鍵
還可以在 設置 -> 鍵盤映射 -> 外部工具 -> Black 上右鍵,打開編輯快捷鍵的菜單,添加鍵盤快捷鍵:

保存文件時自動格式化(可選)
1.確保已經(jīng)安裝了 File Watchers 插件
2.進入 設置 -> 工具 -> File Watchers,點擊 + 以添加一個新的 watcher:
- Name: Black
- File type: Python
- Scope: Project Files
- Program: 上一小節(jié)得到的安裝位置
- Arguments:
$FilePath$ - Output paths to refresh:
$FilePath$ - Working directory:
$ProjectFileDir$
3.在高級選項中:
- 取消勾選
“Auto-save edited files to trigger the watcher” - 取消勾選
“Trigger the watcher on external changes”
