在 VS Code 中格式化 Python

格式化使原始碼更易於人類閱讀。透過強制執行特定的規則和約定，例如行間距、縮排和運算子周圍的空格，程式碼在視覺上變得更有條理、更易於理解。您可以在 autopep8 頁面上檢視一個示例。請記住，格式化不會影響程式碼本身的功能。

程式碼檢查（Linting）透過分析程式碼中的常見語法、風格、功能性錯誤以及不規範的程式設計實踐來幫助防止錯誤。儘管格式化和程式碼檢查之間有一些重疊，但這兩種功能是互補的。

選擇格式化工具

在 VS Code Marketplace 中搜索您選擇的格式化工具擴充套件。

Microsoft 釋出了以下格式化工具擴充套件

社群提供的格式化工具擴充套件

此外，以下是支援 import 排序的格式化工具擴充套件

注意：如果您在上面的表格或 Marketplace 中沒有找到您偏好的格式化工具，您可以透過擴充套件為其新增支援。您可以使用 Python 擴充套件模板將新的 Python 工具整合到 VS Code 中。

設定預設格式化工具

安裝格式化工具擴充套件後，您可以按照以下步驟將其選為 VS Code 中 Python 檔案的預設格式化工具

1. 在 VS Code 中開啟一個 Python 檔案。
2. 在編輯器上右鍵單擊以顯示上下文選單。
3. 選擇使用...格式化文件(Format Document With...)。
4. 從下拉選單中選擇配置預設格式化工具...(Configure Default Formatter...)。
5. 從列表中選擇您偏好的格式化工具擴充套件。

或者，您可以在使用者 settings.json 檔案的 [python] 作用域下設定 "editor.defaultFormatter"，將其設為所有 Python 檔案的預設格式化工具。您可以使用首選項: 開啟使用者設定(JSON) (Preferences: Open User Settings (JSON)) 命令開啟 settings.json。

例如，要將 Black Formatter 設定為預設格式化工具，請將以下設定新增到您的使用者 settings.json 檔案中

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }

要將某個格式化工具擴充套件設定為 import 排序器，您可以在使用者 settings.json 檔案或工作區 settings.json 檔案的 [python] 作用域下，在 "editor.codeActionsOnSave" 中設定您的偏好。您可以分別使用首選項: 開啟使用者設定(JSON) (Preferences: Open User Settings (JSON)) 和首選項: 開啟工作區設定(JSON) (Preferences: Open Workspace Settings (JSON)) 命令開啟這些 settings.json 檔案。這將為所有 Python 檔案啟用儲存時 import 排序。

例如，要將 Ruff 設定為您偏好的 import 排序器，您可以將以下設定新增到您的使用者 settings.json 或工作區 settings.json 檔案中

{
  "[python]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports.ruff": "explicit"
    }
  }
}

格式化您的程式碼

您可以透過在編輯器上右鍵單擊並選擇格式化文件 (Format Document)，或使用鍵盤快捷鍵 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 來格式化您的程式碼。

您還可以將以下設定新增到您的使用者 settings.json 檔案中，以啟用儲存時格式化程式碼的功能

  "[python]": {
    "editor.formatOnSave": true
  }

常規格式化設定

您可以參考每個格式化工具擴充套件的 README 檔案以獲取有關支援設定的更多詳細資訊。以下是大多數格式化工具擴充套件支援的設定

格式化問題排查

如果格式化失敗，請檢查以下可能的原因

注意：如果您在上面沒有找到您偏好的格式化工具，您可以透過擴充套件為其新增支援。Python 擴充套件模板可以輕鬆地將新的 Python 工具整合到 VS Code 中。

後續步驟

• 除錯 - 瞭解如何在本地和遠端除錯 Python。
• 測試 - 配置測試環境以及發現、執行和除錯測試。
• 基本編輯 - 瞭解功能強大的 VS Code 編輯器。
• 程式碼導航 - 快速瀏覽您的原始碼。
• Python 擴充套件模板 - 建立一個擴充套件，將您最喜歡的程式碼檢查工具整合到 VS Code 中。