在 VS Code 中格式化 Python 程式碼

格式化可以讓原始程式碼更容易被閱讀。透過強制執行特定的規則與慣例（例如行距、縮排以及運算子周圍的間距），程式碼在視覺上會變得更有條理且更易於理解。您可以在 autopep8 頁面上查看範例。請記住，格式化不會影響程式碼本身的功能。

Linting（程式碼檢查）有助於透過分析程式碼中的常見語法、風格、功能錯誤以及非常規的程式設計習慣來預防錯誤。雖然格式化與 Linting 之間有一些重疊，但這兩項功能是相輔相成的。

選擇格式化工具 (Formatter)

請在 VS Code Marketplace 中搜尋您選擇的格式化工具擴充功能。

Microsoft 發佈了下列格式化擴充功能

社群提供的格式化擴充功能

此外，以下是支援匯入排序 (import sorting) 的格式化擴充功能

注意：如果您在上述表格或 Marketplace 中找不到您偏好的格式化工具，您可以透過擴充功能新增支援。您可以使用 Python 擴充功能範本 (Python Extension Template) 將新的 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"
  }

若要將格式化擴充功能設定為匯入排序工具，您可以在使用者 settings.json 或工作區 settings.json 檔案中的 [python] 作用域內，設定 "editor.codeActionsOnSave" 偏好選項。您分別可以使用 喜好設定：開啟使用者設定 (JSON) 與 喜好設定：開啟工作區設定 (JSON) 指令來開啟這些 settings.json 檔案。這將啟用所有 Python 檔案在儲存時進行匯入排序。

例如，若要將 Ruff 設為您偏好的匯入排序工具，您可以將以下設定新增至您的使用者 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 Extension Template) 可讓您輕鬆地將新的 Python 工具整合到 VS Code 中。

後續步驟

• 偵錯 - 學習如何在本地與遠端對 Python 程式進行偵錯。
• 測試 - 設定測試環境，並探索、執行與偵錯測試。
• 基本編輯 - 了解功能強大的 VS Code 編輯器。
• 程式碼導覽 - 在原始碼中快速移動。
• Python 擴充功能範本 - 建立一個擴充功能，將您最喜愛的 Linter 整合到 VS Code 中。