使用 Devcontainer 在 VSCode 中進(jìn)行 Python 開發(fā)

在本指南中，我們將引導(dǎo)您完成使用 Visual Studio Code (VSCode) 在基于 Docker 的開發(fā)環(huán)境中設(shè)置和使用 devcontainer-python-template 進(jìn)行 Python 開發(fā)的步驟。此模板允許您快速啟動并運(yùn)行 devcontainer 中的 Python 項(xiàng)目。

您將基于模板創(chuàng)建自己的存儲庫，而不是直接克隆存儲庫，這樣您就可以將更改推送回您自己的存儲庫。

1. 從模板創(chuàng)建新存儲庫

• 轉(zhuǎn)到 devcontainer-python-template 存儲庫：https://github.com/jdevto/devcontainer-python-template。
• 單擊位于存儲庫頁面右上角附近的“使用此模板”按鈕。
• 選擇創(chuàng)建新存儲庫。
• 填寫存儲庫詳細(xì)信息：
  • 存儲庫名稱：為您的新項(xiàng)目選擇一個名稱，例如 python-flask-web-app。
  • 描述：（可選）添加存儲庫的描述。
  • 可見性：選擇您的存儲庫是公共還是私有。
  • 所有者：（可選）如果您要在組織下創(chuàng)建存儲庫，請選擇適當(dāng)?shù)乃姓撸膸艋蚪M織）。
• 單擊從模板創(chuàng)建存儲庫。

這將在您的 GitHub 帳戶上創(chuàng)建一個新的存儲庫，并使用 devcontainer-python-template 的內(nèi)容進(jìn)行初始化。

2. 在本地克隆您的新存儲庫

• 現(xiàn)在您已經(jīng)創(chuàng)建了一個新的存儲庫，打開 VSCode。
• 將新創(chuàng)建的存儲庫克隆到本地計(jì)算機(jī)：

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

創(chuàng)建分支并從中工作始終是最佳實(shí)踐。

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

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

• 在 VSCode 中打開存儲庫：
  • 克隆存儲庫后，在 Visual Studio Code 中打開它。
  • 在 VSCode 菜單中，轉(zhuǎn)到活動欄并單擊遠(yuǎn)程資源管理器。
  • 選擇在容器中重新打開。這將構(gòu)建并啟動 .devcontainer 文件夾中定義的開發(fā)容器 (devcontainer)。
• 安裝過程中會發(fā)生什么：VSCode 將自動：
  • 按照 devcontainer.json 配置文件中指定的方式構(gòu)建 Docker 容器。
  • 安裝requirements.txt或其他項(xiàng)目文件中列出的任何依賴項(xiàng)（例如Python包）。
  • 在容器內(nèi)干凈、隔離的開發(fā)環(huán)境中打開項(xiàng)目。
• 成功設(shè)置的輸出：如果 .devcontainer 設(shè)置成功，您應(yīng)該看到類似于以下內(nèi)容的輸出：

git branch dev
git checkout dev

• 打開終端：

  • 在同一個 VSCode 窗口中關(guān)閉并重新打開終端。
  • 您應(yīng)該看到如下提示：

    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. 驗(yàn)證 Python 是否正常工作

繼續(xù)之前，請確保 Python 在 devcontainer 內(nèi)正常工作：

• 在 VSCode 中打開集成終端。
• 運(yùn)行以下命令檢查Python版本：

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

• 您應(yīng)該看到如下輸出：

  python --version

5. 運(yùn)行測試Python腳本

該模板包含一個簡單的測試腳本，位于 hello/main.py。運(yùn)行此腳本來驗(yàn)證設(shè)置并確保 Python 正確執(zhí)行：

• 在終端中，運(yùn)行測試腳本：

  Python 3.12.7

• 預(yù)期輸出：

  python hello/main.py

6. 清理

一旦確認(rèn) Python 正在運(yùn)行并且測試腳本成功運(yùn)行：

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

  Hello, Devcontainer!

• 根據(jù)需要更新許可證文件

7. Flask Web 應(yīng)用程序開發(fā)

• 使用以下內(nèi)容更新 README.md 文件：

  rm -rf hello

• 創(chuàng)建項(xiàng)目目錄

  • 創(chuàng)建一個文件夾來保存您的項(xiàng)目。

    # 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.
  

• 設(shè)置虛擬環(huán)境

  • 設(shè)置Python虛擬環(huán)境來管理依賴項(xiàng)。

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

• 安裝 Flask

  • 在虛擬環(huán)境中安裝Flask。

  python -m venv venv
  source venv/bin/activate
  

  • 創(chuàng)建一個requirements.txt 文件來跟蹤依賴關(guān)系。

  pip install flask
  

• 創(chuàng)建應(yīng)用程序

  • 創(chuàng)建app.py 文件。

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

  • 使用以下內(nèi)容更新 app.py 文件：

  git branch dev
  git checkout dev
  

• 運(yùn)行應(yīng)用程序

  • 運(yùn)行應(yīng)用程序以驗(yàn)證設(shè)置。

    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.
  

  • 您應(yīng)該看到類似這樣的內(nèi)容：

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

  • 在瀏覽器中打開http://127.0.0.1:5000。您應(yīng)該看到“Hello, World!”。

• 擴(kuò)展項(xiàng)目結(jié)構(gòu)

隨著應(yīng)用程序的發(fā)展，添加支持模板、靜態(tài)文件和測試的目錄結(jié)構(gòu)。

• 創(chuàng)建以下結(jié)構(gòu)：
  

    python --version
  

  Python 3.12.7

• 使用以下內(nèi)容更新 base.html 文件：
  

    python hello/main.py
  

• 再次運(yùn)行 Flask 應(yīng)用
  再次運(yùn)行應(yīng)用程序以測試更新后的版本。
  

    Hello, Devcontainer!
  

• 打開瀏覽器并導(dǎo)航至 http://127.0.0.1:5000。

• 您應(yīng)該看到類似這樣的內(nèi)容：
  

    rm -rf hello
  

  • 環(huán)境清理 當(dāng)您完成測試并運(yùn)行 Flask 應(yīng)用程序后：

• 停止 Flask 服務(wù)器

  • 在運(yùn)行 Flask 應(yīng)用的終端中按 Ctrl C。這將終止服務(wù)器進(jìn)程。

• 退出開發(fā)環(huán)境

  • 在 VSCode 中，按 Ctrl Shift P（或 macOS 上的 Cmd Shift P）打開命令面板。
  • 鍵入在 SSH 中重新打開文件夾 并選擇該選項(xiàng)。這可確保您脫離開發(fā)容器并返回本地環(huán)境，從而為容器外的任何其他任務(wù)實(shí)現(xiàn)無縫工作流集成。

8.將分支推送到GitHub

• 執(zhí)行

  # 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. 創(chuàng)建拉取請求 (PR)

導(dǎo)航到 GitHub 上的存儲庫

• 訪問 GitHub 上的存儲庫。

轉(zhuǎn)到“拉取請求”選項(xiàng)卡

• 單擊存儲庫頁面頂部的“拉取請求”選項(xiàng)卡。

創(chuàng)建新的拉取請求

• 點(diǎn)擊“新拉取請求”按鈕。

選擇 PR 分支

• 基礎(chǔ)分支：選擇要合并到的分支（例如，主分支或生產(chǎn)分支）。
• 比較分支：選擇您剛剛推送的分支（例如，dev）。

打開拉取請求創(chuàng)建

• 點(diǎn)擊“創(chuàng)建拉取請求”。

查看更改

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

添加標(biāo)題和描述

• 提供簡潔且具有描述性的標(biāo)題（例如，壯舉：更新模板開發(fā)）。

• 添加包含任何必要詳細(xì)信息的描述（例如更改原因、問題參考等）。

完成拉取請求

• 再次點(diǎn)擊“創(chuàng)建拉取請求”進(jìn)行確認(rèn)。

審核并批準(zhǔn) PR

• 自我審核您的更改或請求隊(duì)友審核。

合并拉取請求

• 一切看起來都不錯后，導(dǎo)航到 PR 并單擊“合并拉取請求”。
• 點(diǎn)擊“確認(rèn)合并”確認(rèn)合并。

以上是使用 Devcontainer 在 VSCode 中進(jìn)行 Python 開發(fā)的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！