•
Python 格式化工具選擇與 Black 指令教學
4 分鐘閱讀 •
what is the default or 推薦的 python formatter in VSCode?
當您在 VS Code 中編輯 Python 檔案時，格式化工具（Formatter）並不再內建於 Python Extension，而是透過外部擴充功能提供。以下說明預設與常見推薦的 Formatter，以及如何進行設定。
格式化工具簡介
預設 Formatter
- 安裝 Microsoft 官方的 Python Extension 後，VS Code 預設即安裝並使用 autopep8 作為 Python 檔案的格式化工具autopep8 可自動修正大多數符合 PEP 8 的程式風格問題1。
推薦的第三方 Formatter
- Black
- 「不妥協的」Python 代碼格式化工具，能將程式碼統一為固定風格且幾乎免參數配置，社群採用度極高，與 PEP 8 相容。
- YAPF
- Google 開源的 Python 格式化工具，提供高度可自訂的排版風格選項。
- Ruff
- 主要為超快的 linter，但也支援自動修復與 import 排序，可輔助格式化與程式碼健檢2。
如何設定預設 Formatter
- 開啟任一
.py檔案。 - 於編輯區按右鍵，選擇 Format Document With…。
- 再選 Configure Default Formatter…。
- 從清單中挑選您要的格式化擴充，例如
ms-python.black-formatter或ms-python.autopep83。
設定完成後，即可透過快捷鍵（Windows/Linux：Shift+Alt+F；macOS：Option+Shift+F）或儲存檔案時自動格式化（於設定中開啟 editor.formatOnSave）來統一程式碼風格。
我後來在 jim60105/standalone-civitai-shortcut 中 採用 black
how to run python black formatter in command line for specific folder only?
在命令列針對特定資料夾執行 Black 格式化，只需要在指令後面接上該資料夾的路徑即可。以下示範最常用的做法以及進階參數。
前置作業
確認已安裝 Black
pip install black
針對特定資料夾格式化
基本指令
black path/to/your_folder這個指令會遞迴掃描
your_folder底下所有.py檔案，並直接套用 Black 的預設排版規則4。
常用進階選項
-l,--line-length：設定單行最長字元數（預設 88）black path/to/your_folder --line-length 100--check：僅檢查哪些檔案需要被格式化，但不會實際修改black path/to/your_folder --check--diff：顯示格式化前後差異，但不改寫檔案black path/to/your_folder --diff
範例
假設專案結構如下：
my_project/
├── src/
│ ├── module1.py
│ └── module2.py
└── tests/
└── test_module.py
要只格式化 src 資料夾，可執行：
black my_project/src
執行後，Black 會在終端顯示被修改或檢查通過的檔案清單。若要一次格式化整個專案，則改為指定 my_project/ 即可4。