🚀 在 VS Code 中

Visual Studio Code 中的 Python

在 Visual Studio Code 中使用 Python,並搭配Microsoft Python 擴充功能,既簡單、有趣又有效率。此擴充功能讓 VS Code 成為絕佳的 Python 編輯器,並可在任何作業系統上搭配各種 Python 解譯器運作。它充分運用 VS Code 的強大功能,提供自動完成和 IntelliSense、程式碼靜態分析、偵錯和單元測試,以及輕鬆切換 Python 環境 (包括虛擬環境和 conda 環境) 的能力。

本文僅概略介紹適用於 VS Code 的 Python 擴充功能的各種功能。如需逐步瞭解如何編輯、執行和偵錯程式碼,請使用下方的按鈕。

Python 教學課程

安裝 Python 和 Python 擴充功能

教學課程會引導您完成安裝 Python 和使用擴充功能的步驟。您必須自行安裝 Python 解譯器,與擴充功能分開安裝。如需快速安裝,請使用 python.org 上的 Python從 VS Code Marketplace 安裝擴充功能

注意:為了協助您開始進行 Python 開發,您可以使用Python 設定檔範本,其中包含實用的擴充功能、設定和 Python 程式碼片段。

安裝 Python 版本後,使用 Python: 選取解譯器 命令來選取它。如果 VS Code 未自動找到您要尋找的解譯器,請參閱環境 - 手動指定解譯器

您可以透過設定來設定 Python 擴充功能。如需詳細資訊,請參閱Python 設定參考

適用於 Linux 的 Windows 子系統:如果您使用 Windows,WSL 是進行 Python 開發的絕佳方式。您可以在 Windows 上執行 Linux 發行版本,而且通常已安裝 Python。搭配 WSL 擴充功能,您可以在 WSL 內容中執行時,獲得完整的 VS Code 編輯和偵錯支援。若要深入瞭解,請前往在 WSL 中開發或嘗試在 WSL 中工作教學課程。

執行 Python 程式碼

若要體驗 Python,請建立一個名為 hello.py 的檔案 (使用檔案總管),並貼入下列程式碼

print("Hello World")

然後,Python 擴充功能會提供捷徑,以使用目前選取的解譯器 (命令面板中的 Python: 選取解譯器) 執行 Python 程式碼。若要執行現用 Python 檔案,請按一下編輯器右上角的 執行 Python 檔案 播放按鈕。

Using the run python file in terminal button

您也可以使用 Python: 在 Python 終端機中執行選取範圍/行 命令 (Shift+Enter) 執行個別行或選取的程式碼。如果沒有選取範圍,智慧型傳送會將游標所在行周圍最小的可執行程式碼區塊傳送到 Python 終端機 (Shift+Enter)。在編輯器中選取範圍的內容功能表上,也有相同的 執行 Python > 在 Python 終端機中執行選取範圍/行 命令。每次在終端機/REPL 中執行選取範圍或行時,都會使用相同的終端機,直到該終端機關閉為止。相同的終端機也用於 在終端機中執行 Python 檔案。如果該終端機仍在執行 REPL,您應該先結束 REPL (exit()) 或切換到不同的終端機,再執行 Python 檔案。

Python 擴充功能會根據選取範圍的第一個非空白行自動移除縮排,並視需要將所有其他行向左移動。

如有必要,此命令會開啟 Python 終端機;您也可以使用 Python: 啟動終端機 REPL 命令直接開啟互動式 REPL 環境,此命令會啟動具有目前選取解譯器的終端機,然後執行 Python REPL。

如需更詳細的逐步解說和其他執行程式碼的方式,請參閱執行程式碼教學課程

自動完成和 IntelliSense

Python 擴充功能支援使用目前選取解譯器的程式碼完成和 IntelliSense。IntelliSense 是許多功能的統稱,包括跨所有檔案以及內建和協力廠商模組的智慧型程式碼完成 (內容相關的方法和變數建議)。

IntelliSense 會在您輸入時快速顯示方法、類別成員和文件。您也可以隨時使用 ⌃Space (Windows、Linux Ctrl+Space) 觸發完成。將滑鼠停留在識別項上方會顯示更多關於它們的資訊。

IntelliSense and autocomplete for Python code

透過 AI 增強完成功能

GitHub Copilot 是一種 AI 驅動的程式碼完成工具,可協助您更快、更智慧地撰寫程式碼。您可以在 VS Code 中使用 GitHub Copilot 擴充功能來產生程式碼,或從它產生的程式碼中學習。

GitHub Copilot extension in the VS Code Marketplace

GitHub Copilot 為 Python 以外的語言以及各種架構 (包括 JavaScript、TypeScript、Ruby、Go、C# 和 C++) 提供建議。

您可以在Copilot 文件中深入瞭解如何開始使用 Copilot。

程式碼靜態分析

程式碼靜態分析會分析您的 Python 程式碼中是否有潛在錯誤,讓您可以輕鬆導覽至並修正不同的問題。

Python 擴充功能可以套用許多不同的程式碼靜態分析工具,包括 Pylint、pycodestyle、Flake8、mypy、pydocstyle、prospector 和 pylama。請參閱程式碼靜態分析

偵錯

不再需要 print 陳述式偵錯!VS Code 透過 Python 偵錯工具擴充功能提供絕佳的 Python 偵錯支援,讓您可以設定中斷點、檢查變數,並使用偵錯主控台深入瞭解程式的逐步執行方式。偵錯各種不同類型的 Python 應用程式,包括多執行緒、Web 和遠端應用程式。

如需 Python 偵錯的更具體資訊,例如設定 launch.json 設定和實作遠端偵錯,請參閱偵錯。一般 VS Code 偵錯資訊可在偵錯文件中找到。

此外,DjangoFlask 教學課程提供如何在 Web 應用程式內容中實作偵錯的範例,包括偵錯 Django 範本。

環境

Python 擴充功能會自動偵測安裝在標準位置的 Python 解譯器。它也會偵測工作區資料夾中的 conda 環境和虛擬環境。請參閱設定 Python 環境

目前的環境會顯示在 VS Code 狀態列的右側

Status Bar showing a selected interpreter

狀態列也會指出是否未選取任何解譯器

Status bar showing no selected Python interpreter

選取的環境會用於 IntelliSense、自動完成、程式碼靜態分析、格式化和任何其他語言相關功能。當您在終端機中執行或偵錯 Python,或使用 終端機: 建立新的終端機 命令建立新的終端機時,也會啟動它。

若要變更目前的解譯器 (包括切換至 conda 或虛擬環境),請選取狀態列上的解譯器名稱,或使用 Python: 選取解譯器 命令。

Python: Select Interpreter command

VS Code 會提示您顯示偵測到的環境清單,以及您手動新增至使用者設定的任何環境 (請參閱設定 Python 環境)。

Jupyter Notebook

若要在 VS Code 中啟用 Jupyter Notebook 檔案 (.ipynb) 的 Python 支援,您可以安裝 Jupyter 擴充功能。Python 和 Jupyter 擴充功能共同運作,在 VS Code 中提供絕佳的 Notebook 體驗,讓您可以直接檢視和修改具有 IntelliSense 支援的程式碼儲存格,以及執行和偵錯它們。

Jupyter notebook running in VS code in the Notebook Editor

您也可以透過 Jupyter: 匯出至 Python 指令碼 命令,將 Notebook 轉換並開啟為 Python 程式碼檔案。Notebook 的儲存格在 Python 檔案中以 #%% 註解分隔,而 Jupyter 擴充功能會顯示 執行儲存格執行下方儲存格 CodeLens。選取任一 CodeLens 都會啟動 Jupyter 伺服器,並在 Python 互動式視窗中執行儲存格。

Jupyter notebook running in VS Code and the Python interactive window

您也可以連線到遠端 Jupyter 伺服器來執行 Notebook。如需詳細資訊,請參閱Jupyter 支援

測試

Python 擴充功能支援使用 Python 內建的 unittest 架構和 pytest 進行測試

為了執行測試,您必須在專案的設定中啟用其中一個支援的測試架構。每個架構都有其特定的設定,例如用於識別測試探索路徑和模式的引數。

探索到測試後,VS Code 會提供各種命令 (在狀態列、命令面板和其他位置) 來執行和偵錯測試。這些命令也允許您執行個別的測試檔案和方法

組態

Python 擴充功能為其各種功能提供各種設定。這些設定在其相關主題中說明,例如編輯程式碼程式碼靜態分析偵錯測試。完整的清單可在設定參考中找到。

Python 設定檔範本

設定檔可讓您根據目前的專案或工作快速切換您的擴充功能、設定和 UI 版面配置。為了協助您開始進行 Python 開發,您可以使用Python 設定檔範本,這是一個精選的設定檔,其中包含實用的擴充功能、設定和程式碼片段。您可以依原樣使用設定檔範本,或將其用作起點,進一步自訂以符合您自己的工作流程。

您可以透過 設定檔 > 建立設定檔... 下拉式選單選取設定檔範本

Create Profile dropdown with profile templates

選取設定檔範本後,您可以檢閱設定和擴充功能,如果您不想將個別項目包含在新的設定檔中,可以移除它們。根據範本建立新的設定檔後,對設定、擴充功能或 UI 所做的變更會保存在您的設定檔中。

Microsoft Python 擴充功能提供本文先前所述的所有功能。您可以透過安裝其他熱門的 Python 擴充功能,將額外的 Python 語言支援新增至 VS Code。

  1. 開啟 擴充功能 檢視 (⇧⌘X (Windows、Linux Ctrl+Shift+X))。
  2. 輸入 'python' 以篩選擴充功能清單。

上方顯示的擴充功能是動態查詢的。按一下上方的擴充功能磚以閱讀描述和評論,以決定哪個擴充功能最適合您。請在市集中查看更多資訊。

後續步驟