參加你附近的 ,瞭解 VS Code 中的 AI 輔助開發。

在 VS Code 中開始使用 Python

在本教程中,您將學習如何在 Visual Studio Code 中使用 Python 3 來建立、執行和除錯一個 Python“擲骰子!”應用程式,以及如何使用虛擬環境、包等等!透過使用 Python 擴充套件,您可以將 VS Code 變成一個出色的輕量級 Python 編輯器。

如果您是程式設計新手,請檢視 Visual Studio Code for Education - Python 簡介 課程。該課程全面介紹了 Python,在一個隨時可用的基於瀏覽器的開發環境中提供了結構化的模組。

要更深入地瞭解 Python 語言,您可以在 VS Code 環境中探索 python.org 上列出的任何程式設計教程

有關側重於資料科學的 Python 教程,請檢視我們的資料科學部分

先決條件

要成功完成本教程,您需要首先設定您的 Python 開發環境。具體來說,本教程需要:

安裝 Python 直譯器

除了 Python 擴充套件,您還需要安裝一個 Python 直譯器。您使用哪個直譯器取決於您的具體需求,但下面提供了一些指導。

Windows

python.org 安裝 Python。使用頁面上首先出現的下載 Python 按鈕來下載最新版本。

注意:如果您沒有管理員許可權,在 Windows 上安裝 Python 的另一個選擇是使用 Microsoft Store。Microsoft Store 提供了受支援的 Python 版本的安裝程式。

有關在 Windows 上使用 Python 的更多資訊,請參閱 Python.org 上的在 Windows 上使用 Python

macOS

不支援在 macOS 上使用系統安裝的 Python。相反,推薦使用像 Homebrew 這樣的包管理系統。要在 macOS 上使用 Homebrew 安裝 Python,請在終端提示符下使用 brew install python3 命令。

注意:在 macOS 上,請確保您的 VS Code 安裝位置已包含在 PATH 環境變數中。更多資訊請參閱這些設定說明

Linux

Linux 上內建的 Python 3 安裝可以正常工作,但要安裝其他 Python 包,您必須使用 get-pip.py 安裝 pip

其他選項

  • 資料科學:如果您使用 Python 的主要目的是資料科學,那麼您可能會考慮從 Anaconda 下載。Anaconda 不僅提供 Python 直譯器,還提供了許多用於資料科學的有用庫和工具。

  • 適用於 Linux 的 Windows 子系統:如果您在 Windows 上工作,並希望有一個 Linux 環境來使用 Python,適用於 Linux 的 Windows 子系統 (WSL) 是您的一個選擇。如果您選擇此選項,您還需要安裝 WSL 擴充套件。有關在 VS Code 中使用 WSL 的更多資訊,請參閱 VS Code 遠端開發 或嘗試在 WSL 中工作教程,該教程將引導您完成設定 WSL、安裝 Python 以及建立一個在 WSL 中執行的 Hello World 應用程式。

注意:要驗證您是否已在您的機器上成功安裝 Python,請執行以下命令之一(取決於您的作業系統):

Linux/macOS:開啟終端視窗並鍵入以下命令

python3 --version

Windows:開啟命令提示符並執行以下命令

py -3 --version

如果安裝成功,輸出視窗應顯示您安裝的 Python 版本。或者,您可以在 VS Code 整合終端中使用 py -0 命令檢視您機器上安裝的 Python 版本。預設直譯器由星號 (*) 標識。

在工作區資料夾中啟動 VS Code

透過在資料夾中啟動 VS Code,該資料夾將成為您的“工作區”。

使用命令提示符或終端,建立一個名為 "hello" 的空資料夾,導航到該資料夾中,然後透過輸入以下命令在該資料夾 (.) 中開啟 VS Code (code):

mkdir hello
cd hello
code .

注意:如果您使用的是 Anaconda 發行版,請確保使用 Anaconda 命令提示符。

或者,您可以透過作業系統 UI 建立一個資料夾,然後使用 VS Code 的檔案 > 開啟資料夾來開啟專案資料夾。

建立虛擬環境

Python 開發者的一個最佳實踐是使用專案特定的虛擬環境。一旦您激活了該環境,您之後安裝的任何包都將與包括全域性直譯器環境在內的其他環境隔離,從而減少了因包版本衝突而可能出現的許多複雜問題。您可以使用 Venv 或 Anaconda 透過 Python: Create Environment 在 VS Code 中建立非全域性環境。

開啟命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)),開始鍵入 Python: Create Environment 命令進行搜尋,然後選擇該命令。

該命令會列出環境型別,Venv 或 Conda。在本例中,選擇 Venv

Create Environment dropdown

然後,該命令會列出可用於您專案的直譯器。選擇您在本教程開始時安裝的直譯器。

Virtual environment interpreter selection

選擇直譯器後,通知將顯示環境建立的進度,並且環境資料夾 (/.venv) 將出現在您的工作區中。

Create environment status notification

使用命令面板中的 Python: Select Interpreter 命令,確保已選擇您的新環境。

Select an Interpreter

注意:有關虛擬環境的更多資訊,或者如果您在環境建立過程中遇到錯誤,請參閱環境

建立 Python 原始碼檔案

從檔案資源管理器工具欄,選擇 hello 資料夾上的新建檔案按鈕。

File Explorer New File

將檔案命名為 hello.py,VS Code 將自動在編輯器中開啟它。

File Explorer hello.py

透過使用 .py 副檔名,您告訴 VS Code 將此檔案解釋為 Python 程式,以便它使用 Python 擴充套件和所選的直譯器來評估其內容。

注意:檔案資源管理器工具欄還允許您在工作區內建立資料夾,以更好地組織您的程式碼。您可以使用新建資料夾按鈕快速建立一個資料夾。

現在您的工作區中有了一個程式碼檔案,請在 hello.py 中輸入以下原始碼:

msg = "Roll a dice!"
print(msg)

當您開始輸入 print 時,請注意 IntelliSense 是如何提供自動補全選項的。

IntelliSense appearing for Python code

IntelliSense 和自動補全功能不僅適用於標準的 Python 模組,也適用於您在所選 Python 直譯器環境中安裝的其他包。它還為物件型別上可用的方法提供補全。例如,因為 msg 變數包含一個字串,所以當您輸入 msg. 時,IntelliSense 會提供字串方法。

IntelliSense appearing for a variable whose type provides methods

最後,儲存檔案 (⌘S (Windows, Linux Ctrl+S))。此時,您已準備好在 VS Code 中執行您的第一個 Python 檔案。

有關編輯、格式化和重構的完整詳細資訊,請參閱編輯程式碼。Python 擴充套件也完全支援程式碼檢查 (Linting)

執行 Python 程式碼

點選編輯器右上角的執行 Python 檔案播放按鈕。

Using the Run Python File button

該按鈕會開啟一個終端面板,您的 Python 直譯器會在其中自動啟用,然後執行 python3 hello.py (macOS/Linux) 或 python hello.py (Windows)。

Program output in a Python terminal

在 VS Code 中,還有另外三種執行 Python 程式碼的方法:

  1. 在編輯器視窗的任意位置右鍵單擊,然後選擇執行 Python > 在終端中執行 Python 檔案(這會自動儲存檔案)。

    Run Python File in Terminal command in the Python editor

  2. 選擇一行或多行,然後按 Shift+Enter 或右鍵單擊並選擇執行 Python > 在 Python 終端中執行選中內容/行。或者,您可以在沒有選擇的情況下使用 Shift+Enter 啟用智慧傳送,Python 擴充套件會將游標附近最小的可執行程式碼塊傳送到終端。此命令對於僅測試檔案的一部分非常方便。

    注意:如果您希望傳送游標所在特定行的程式碼,可以透過在您的使用者設定中設定 python.REPL.enableREPLSmartSend : "false" 來關閉智慧傳送。

  3. 從命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中,選擇 Python: Start Terminal REPL 命令,為當前選定的 Python 直譯器開啟一個 REPL 終端(由 >>> 表示)。在 REPL 中,您可以一次輸入並執行一行程式碼。

恭喜,您剛剛在 Visual Studio Code 中運行了您的第一段 Python 程式碼!

配置並執行偵錯程式

現在讓我們嘗試除錯我們的 Python 程式。除錯支援由 Python Debugger 擴充套件提供,該擴充套件隨 Python 擴充套件自動安裝。為確保其已正確安裝,請開啟擴充套件檢視 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 並搜尋 @installed python debugger。您應該在結果中看到 Python Debugger 擴充套件。

Python Debugger extension shown in installed extensions view in VS Code.

接下來,在 hello.py 的第 2 行設定一個斷點,方法是將游標放在 print 呼叫上並按 F9。或者,單擊編輯器左側邊欄,行號旁邊。設定斷點後,邊欄中會出現一個紅圈。

Setting a breakpoint in hello.py

接下來,要初始化偵錯程式,請按 F5。由於這是您第一次除錯此檔案,命令面板將開啟一個配置選單,允許您為開啟的檔案選擇除錯配置型別。

List of Python debugger configuration options

注意:VS Code 對其所有各種配置都使用 JSON 檔案;launch.json 是包含除錯配置的檔案的標準名稱。

選擇 Python File,這是使用當前選定的 Python 直譯器執行編輯器中顯示的當前檔案的配置。

偵錯程式將啟動,然後在檔案的第一行斷點處停止。當前行在左邊距中用黃色箭頭指示。如果此時檢查區域性變數視窗,您可以看到 msg 變量出現在區域性窗格中。

Debugging step 2 - variable defined

頂部會出現一個除錯工具欄,從左到右依次是以下命令:繼續 (F5)、單步跳過 (F10)、單步進入 (F11)、單步跳出 (⇧F11 (Windows, Linux Shift+F11))、重啟 (⇧⌘F5 (Windows, Linux Ctrl+Shift+F5)) 和停止 (⇧F5 (Windows, Linux Shift+F5))。

Debugging toolbar

狀態列的顏色也會改變(在許多主題中為橙色),以指示您處於除錯模式。Python 除錯控制檯也會自動出現在右下方面板中,以顯示正在執行的命令以及程式輸出。

要繼續執行程式,請選擇除錯工具欄上的繼續命令 (F5)。偵錯程式將程式執行到結束。

提示:透過將滑鼠懸停在程式碼上(例如變數)也可以看到除錯資訊。對於 msg,將滑鼠懸停在變數上將在變數上方的一個框中顯示字串 Roll a dice!

您還可以在除錯控制檯中處理變數(如果您看不到它,請在 VS Code 右下角區域選擇除錯控制檯,或從 ... 選單中選擇它)。然後嘗試在控制檯底部的 > 提示符下逐行輸入以下內容:

msg
msg.capitalize()
msg.split()

Debugging step 3 - using the debug console

再次選擇工具欄上的藍色繼續按鈕(或按 F5)以執行程式至完成。如果您切換回Python 除錯控制檯,"Roll a dice!" 會出現在其中,並且一旦程式完成,VS Code 就會退出除錯模式。

如果您重新啟動偵錯程式,偵錯程式將再次在第一個斷點處停止。

要在程式完成前停止執行,請使用除錯工具欄上的紅色方塊停止按鈕 (⇧F5 (Windows, Linux Shift+F5)),或使用執行 > 停止除錯選單命令。

有關完整詳細資訊,請參閱除錯配置,其中包含有關如何使用特定 Python 直譯器進行除錯的說明。

提示:使用日誌點代替 print 語句:開發人員經常在原始碼中散佈 print 語句以快速檢查變數,而不必在偵錯程式中逐行單步執行程式碼。在 VS Code 中,您可以改用日誌點。日誌點就像一個斷點,但它會將訊息記錄到控制檯而不會停止程式。有關更多資訊,請參閱 VS Code 主要除錯文章中的日誌點

安裝和使用包

讓我們透過使用包來擴充套件前面的示例。

在 Python 中,包是您獲取任意數量的有用程式碼庫的方式,通常來自 PyPI,它們為您的程式提供附加功能。在此示例中,您使用 numpy 包來生成一個隨機數。

返回資源管理器檢視(左側最頂部的圖示,顯示檔案),開啟 hello.py,並貼上以下原始碼:

import numpy as np

msg = "Roll a dice!"
print(msg)

print(np.random.randint(1,9))

提示:如果您手動輸入上述程式碼,您可能會發現在行尾按 Enter 時,自動補全會更改 as 關鍵字後面的名稱。為避免這種情況,請先鍵入一個空格,然後再按 Enter

接下來,按照上一節所述,使用“Python: 當前檔案”配置在偵錯程式中執行該檔案。

您應該會看到訊息 "ModuleNotFoundError: No module named 'numpy'"。此訊息表示您的直譯器中沒有所需的包。如果您使用的是 Anaconda 發行版或之前已安裝 numpy 包,則可能不會看到此訊息。

要安裝 numpy 包,請停止偵錯程式並使用命令面板執行終端:建立新終端 (⌃⇧` (Windows, Linux Ctrl+Shift+`))。此命令會為您的選定直譯器開啟一個命令提示符。

要在您的虛擬環境中安裝所需的包,請根據您的作業系統輸入以下適當的命令:

  1. 安裝包

    # Don't use with Anaconda distributions because they include matplotlib already.
    
    # macOS
    python3 -m pip install numpy
    
    # Windows (may require elevation)
    py -m pip install numpy
    
    # Linux (Debian)
    apt-get install python3-tk
    python3 -m pip install numpy
    
  2. 現在,無論是否使用偵錯程式,重新執行程式以檢視輸出!

跨環境管理依賴項

在處理 Python 專案時,有效管理依賴項至關重要。一個有用的技巧是使用 pip freeze > requirements.txt 命令。此命令幫助您建立一個 requirements.txt 檔案,該檔案列出了虛擬環境中安裝的所有包。然後,此檔案可用於在其他地方重建相同的環境。

按照以下步驟建立 requirements.txt 檔案:

  1. 如果尚未啟用,請啟用您的虛擬環境。

    source venv/bin/activate  # On macOS/Linux
    
    .\venv\Scripts\activate   # On Windows
    
  2. 生成 requirements.txt 檔案。

    pip freeze > requirements.txt
    

現在,您可以使用新生成的 requirements.txt 檔案在另一個環境中安裝依賴項。此外,隨著專案複雜度的增加,您可以繼續向其中新增依賴項。

pip install -r requirements.txt

透過遵循這些步驟,您可以確保專案依賴項在不同環境中保持一致,從而更容易與他人協作和部署您的專案。

恭喜您完成 Python 教程!在本教程中,您學習瞭如何建立 Python 專案、建立虛擬環境、執行和除錯 Python 程式碼以及安裝 Python 包。探索更多資源,學習如何在 Visual Studio Code 中充分利用 Python!

後續步驟

要學習如何使用流行的 Python Web 框架構建 Web 應用程式,請參閱以下教程:

在 Visual Studio Code 中,Python 還有更多值得探索的內容: