使用 Devcontainer 在 VSCode 中進行 Python 開發

使用 Devcontainer 在 VSCode 中進行 Python 開發

在本指南中，我們將引導您完成使用 Visual Studio Code (VSCode) 在基於 Docker 的開發環境中設定和使用 devcontainer-python-template 進行 Python 開發的步驟。此範本可讓您快速啟動並執行 devcontainer 中的 Python 專案。

您將基於範本建立自己的儲存庫，而不是直接複製儲存庫，以便您可以將變更推送回您自己的儲存庫。

1. 從範本建立新儲存庫

• 到 devcontainer-python-template 儲存庫：https://github.com/jdevto/devcontainer-python-template。
• 點選位於儲存庫頁面右上角附近的「使用此範本」按鈕。
• 選擇建立新儲存庫。
• 填寫儲存庫詳細資料：
  • 儲存庫名稱：為您的新專案選擇名稱，例如 python-flask-web-app。
  • 描述：（可選）新增儲存庫的描述。
  • 可見性：選擇您的儲存庫是公有還是私有。
  • 擁有者：（可選）如果您要在組織下建立儲存庫，請選擇適當的擁有者（您的帳戶或組織）。
• 點選從範本建立儲存庫。

這將在您的 GitHub 帳戶上建立一個新的儲存庫，並使用 devcontainer-python-template 的內容進行初始化。

2. 在本機複製您的新儲存庫

• 現在您已經建立了一個新的儲存庫，開啟 VSCode。
• 將新建立的儲存庫複製到本機：

git clone git@github.com:jdevto/python-flask-web-app.git
cd python-flask-web-app

建立分支並從中工作始終是最佳實踐。

git clone git@github.com:jdevto/python-flask-web-app.git
cd python-flask-web-app

3. 在 VSCode 中開啟儲存庫並啟動 Devcontainer

• 在 VSCode 中開啟儲存庫：
  • 複製儲存庫後，在 Visual Studio Code 中開啟它。
  • 在 VSCode 選單中，前往活動欄並點選遠端資源管理器。
  • 選擇在容器中重新開啟。這將建置並啟動 .devcontainer 資料夾中定義的開發容器 (devcontainer)。
• 安裝過程中會發生什麼：VSCode 將自動：
  • 按照 devcontainer.json 設定檔中指定的方式建置 Docker 容器。
  • 安裝requirements.txt或其他專案檔案中列出的任何相依性（例如Python套件）。
  • 在容器內乾淨、隔離的開發環境中開啟專案。
• 成功設定的輸出：如果 .devcontainer 設定成功，您應該會看到類似以下內容的輸出：

git branch dev
git checkout dev

• 開啟終端機：

  • 在同一個 VSCode 視窗中關閉並重新開啟終端。
  • 您應該看到以下提示：

    Running the postCreateCommand from devcontainer.json...
  
    [7382 ms] Start: Run in container: /bin/sh -c .devcontainer/scripts/postCreate.sh
    Linux 726a838654fd 6.8.0-49-generic #49~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Nov  6 17:42:15 UTC 2 x86_64 GNU/Linux
    Done. Press any key to close the terminal.
  

4. 驗證 Python 是否正常運作

繼續之前，請確保 Python 在 devcontainer 內正常運作：

• 在 VSCode 中開啟整合終端。
• 執行以下指令檢查Python版本：

root ➜ /workspaces/python-flask-web-app (main) $

• 您應該看到以下輸出：

  python --version

5. 運行測試Python腳本

此範本包含一個簡單的測試腳本，位於 hello/main.py。執行此腳本來驗證設定並確保 Python 正確執行：

• 在終端機中，執行測試腳本：

  Python 3.12.7

• 預期輸出：

  python hello/main.py

6. 清理

一旦確認 Python 正在運行並且測試腳本成功運行：

• 刪除測試腳本：如果不再需要測試腳本，請刪除 hello 目錄：

  Hello, Devcontainer!

• 依需求更新許可證文件

7. Flask Web 應用程式開發

• 使用以下內容更新 README.md 檔案：

  rm -rf hello

• 建立專案目錄

  • 建立一個資料夾來保存您的專案。

    # python-flask-web-app
  
    A simple demo showcasing a Python Flask web application running in a VSCode development container. This setup is designed to provide an isolated, portable, and consistent environment for Python development.
  

• 設定虛擬環境

  • 設定Python虛擬環境來管理相依性。

  mkdir flask-web-app
  cd flask-web-app
  

• 安裝 Flask

  • 在虛擬環境中安裝Flask。

  python -m venv venv
  source venv/bin/activate
  

  • 建立一個requirements.txt 檔案來追蹤依賴關係。

  pip install flask
  

• 建立應用程式

  • 建立app.py 檔案。

  git clone git@github.com:jdevto/python-flask-web-app.git
  cd python-flask-web-app
  

  • 使用以下內容更新 app.py 檔案：

  git branch dev
  git checkout dev
  

• 運行應用程式

  • 運行應用程式以驗證設定。

    Running the postCreateCommand from devcontainer.json...
  
    [7382 ms] Start: Run in container: /bin/sh -c .devcontainer/scripts/postCreate.sh
    Linux 726a838654fd 6.8.0-49-generic #49~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Nov  6 17:42:15 UTC 2 x86_64 GNU/Linux
    Done. Press any key to close the terminal.
  

  • 您應該會看到類似這樣的內容：

  root ➜ /workspaces/python-flask-web-app (main) $
  

  • 在瀏覽器中開啟http://127.0.0.1:5000。您應該會看到“Hello, World!”。

• 擴充項目結構

隨著應用程式的發展，增加支援範本、靜態檔案和測試的目錄結構。

• 建立以下結構：
  

    python --version
  

  Python 3.12.7

• 使用以下內容更新 base.html 檔案：
  

    python hello/main.py
  

• 再次運行 Flask 應用
  再次運行應用程式以測試更新後的版本。
  

    Hello, Devcontainer!
  

• 開啟瀏覽器並導航至 http://127.0.0.1:5000。

• 您應該會看到類似這樣的內容：
  

    rm -rf hello
  

  • 環境清理 當您完成測試並運行 Flask 應用程式後：

• 停止 Flask 伺服器

  • 在執行 Flask 應用的終端機中按 Ctrl C。這將終止伺服器進程。

• 退出開發環境

  • 在 VSCode 中，按 Ctrl Shift P（或 macOS 上的 Cmd Shift P）開啟指令面板。
  • 鍵入在 SSH 中重新開啟資料夾 並選擇該選項。這可確保您脫離開發容器並返回本機環境，從而為容器外的任何其他任務實現無縫工作流程整合。

8.將分支推送到GitHub

• 執行

  # python-flask-web-app

  A simple demo showcasing a Python Flask web application running in a VSCode development container. This setup is designed to provide an isolated, portable, and consistent environment for Python development.

9. 建立拉取請求 (PR)

導航到 GitHub 上的儲存庫

• 存取 GitHub 上的儲存庫。

前往「拉取請求」標籤

• 點選儲存庫頁面頂部的「拉取請求」標籤。

建立新的拉取請求

• 點選「新拉取請求」按鈕。

選擇 PR 分支

• 基礎分支：選擇要合併到的分支（例如，主分支或生產分支）。
• 比較分支：選擇您剛剛推送的分支（例如，dev）。

開啟拉取請求建立

• 點選「建立拉取請求」。

查看更改

• 檢查提交和更改文件的列表，以確保一切看起來正確。

新增標題和描述

• 提供簡潔且具描述性的標題（例如，壯舉：更新範本開發）。

• 新增包含任何必要詳細資訊的描述（例如更改原因、問題參考等）。

完成拉取請求

• 再次點選「建立拉取請求」確認。

審核並批准 PR

• 自我審核您的更改或請求隊友審核。

合併拉取請求

• 一切看起來都不錯後，導覽至 PR 並點擊「合併拉取請求」。
• 點選「確認合併」確認合併。

以上是使用 Devcontainer 在 VSCode 中進行 Python 開發的詳細內容。更多資訊請關注PHP中文網其他相關文章！