共用方式為


在 Visual Studio 中建立和管理 Python 環境

Python 環境是您執行 Python 程式代碼並包含全域、虛擬和 conda 環境的內容。 環境包含解釋器、連結庫(通常是 Python 標準連結庫),以及一組已安裝的套件。 這些元件會共同決定有效的語言建構和語法、您可以存取的作系統功能,以及您可以使用的套件。

在 Windows 上的 Visual Studio 中,您可以使用 [Python 環境] 視窗,如本文所述來管理環境,並選取一個作為新項目的預設值。

您可以在下列文章中了解環境的其他層面:

  • 針對任何指定的專案,您可以 選取特定環境 ,而不是使用預設值。

  • 如需針對 Python 專案建立和使用虛擬環境的詳細資訊,請參閱 使用虛擬環境

  • 如果您想要在環境中安裝套件,請參閱 [套件] 索引標籤 參考

  • 若要安裝另一個 Python 解釋器,請參閱安裝 Python 解釋器。 一般而言,如果您下載並執行主線 Python 散發套件的安裝程式,Visual Studio 會偵測到新的安裝和環境會出現在 [Python 環境 ] 視窗中,而且可以針對專案選取。

備註

您可以選取 [檔案>開啟資料夾] 來管理 Python 程式代碼以資料夾開啟>的環境。 Python 工具列可讓您在所有偵測到的環境之間切換,並新增環境。 環境資訊會儲存在工作區 .vs 資料夾中的PythonSettings.json 檔案中。

先決條件

  • 已安裝 Python 工作負載

如果您不熟悉 Visual Studio 中的 Python,請參閱下列文章以瞭解一般背景:

[Python 環境] 視窗

Visual Studio 知道的環境會顯示在 [Python 環境] 視窗中。 若要開啟視窗,請使用下列其中一種方法:

  • 選取 [檢視>其他 Windows>Python 環境]。
  • 以滑鼠右鍵按兩下方案總管中專案的 [Python 環境] 節點,然後選取 [檢視所有 Python 環境]。

方案總管中 [檢視所有 Python 環境] 命令的螢幕擷取畫面。

Visual Studio 2019 方案總管中 [檢視所有 Python 環境] 命令的螢幕快照。

Visual Studio 方案總管中 [檢視所有 Python 環境] 命令的螢幕快照。

[Python 環境] 視窗會出現在 Visual Studio 中的 [方案總管] 旁:

[Python 環境] 視窗的螢幕擷取畫面。

Visual Studio 2019 中 [Python 環境] 視窗的螢幕快照。

Visual Studio 中 [Python 環境] 視窗的螢幕快照。

Visual Studio 會使用登錄來尋找已安裝的全域環境(遵循 PEP 514),以及 虛擬環境和conda 環境。 如果您沒有在清單中看到預期的環境,請參閱 手動識別現有的環境

當您在清單中選取環境時,Visual Studio 會在 [Python 環境] 視窗的 [概觀] 索引標籤上顯示該環境的各種屬性和命令,例如解釋器位置。 [ 概觀 ] 索引標籤底部的命令,每個命令都會開啟命令提示字元,並執行解釋器。 如需詳細資訊,請參閱 Python 環境視窗索引標籤參考 - 概觀

使用環境清單下的下拉式清單,切換至不同的索引標籤,例如 套件IntelliSense。 這些索引標籤也會在 [Python 環境] 視窗索引卷標參考中說明。

選取環境並不會變更其與任何項目的關聯性。 在清單中以粗體顯示的默認環境,是 Visual Studio 用於任何新專案的默認環境。 若要搭配新專案使用不同的環境,請使用 [將此設為新專案的默認環境 ] 命令。 在項目的內容中,您一律可以選取特定環境。 如需詳細資訊,請參閱 選取項目的環境

在每個列出的環境右邊,是一個控件,可開啟該環境的 互動式 視窗。

備註

在 Visual Studio 2017 15.5 和更早版本中,另一個控件會顯示重新整理該環境的 IntelliSense 資料庫。 如需資料庫的詳細資訊,請參閱 Python 環境視窗索引卷標參考

小提示

當您展開 [ Python 環境] 視窗夠寬時,您會看到更完整的環境檢視,更方便使用。

展開的 Python 環境視窗的螢幕擷取畫面。

小提示

當您展開 [ Python 環境] 視窗夠寬時,您會看到更完整的環境檢視,更方便使用。

Visual Studio 2019 中 [Python 環境] 視窗展開檢視的螢幕快照。

小提示

當您展開 [ Python 環境] 視窗夠寬時,您會看到更完整的環境檢視,更方便使用。

Visual Studio 中 [Python 環境] 視窗展開檢視的螢幕快照。

備註

雖然 Visual Studio 會遵守 system-site-packages 選項,但它不提供從 Visual Studio 中變更它的方式。

如果沒有環境出現,該怎麼辦?

如果您在 [Python 環境] 視窗中沒有看到任何環境,表示 Visual Studio 無法偵測標準位置中的任何 Python 安裝。 或許您已安裝 Visual Studio 2017 或更新版本,但清除了 Python 工作負載安裝程式選項中的所有解釋器選項。 同樣地,您可能已安裝 Visual Studio 2015 或更早版本,但未手動安裝解釋器。 如需詳細資訊,請參閱 安裝 Python 解釋器。

如果您知道電腦上有 Python 解釋器,但 Visual Studio(任何版本)未偵測到它,請使用 + 自定義 命令手動指定解釋器位置。 如需詳細資訊,請參閱 手動識別現有的環境

環境類型

Visual Studio 可以使用全域、虛擬和 conda 環境。

全域環境

每個 Python 安裝都會維護自己的 全域環境。 例如,Python 2.7、Python 3.6、Python 3.7、Anaconda 4.4.0 等等。 如需詳細資訊,請參閱 安裝 Python 解釋器。

每個環境都由特定的 Python 解釋器、其標準連結庫和一組預安裝套件所組成。 它也包含您在啟動環境時安裝的任何其他套件。 將套件安裝到全域環境,可讓使用該環境的所有專案使用。 如果環境位於文件系統的受保護區域(例如 c:\program files 中),則安裝套件需要系統管理員許可權。

全域環境可供計算機上的所有專案使用。 在 Visual Studio 中,您會選取一個全域環境做為預設值,除非您特別為專案選擇不同的項目,否則會用於所有專案。 如需詳細資訊,請參閱 選取項目的環境

虛擬環境

在全域環境中工作是一個容易開始的方法。 經過一段時間,環境可能會變得雜亂無章,並針對不同的專案安裝許多不同的套件。 雜亂可能會讓您難以針對具有已知版本的特定套件集徹底測試您的應用程式。 但這種環境是您預期在組建伺服器或網頁伺服器上設定的環境。 當兩個專案需要不相容的套件或相同套件的不同版本時,也會發生衝突。

基於這些原因,開發人員通常會為專案建立 虛擬環境 。 虛擬環境是專案中包含特定解釋器複本的子資料夾。 如果您啟用虛擬環境,您安裝的任何套件只會安裝在該環境的子資料夾中。 當您在虛擬環境中執行 Python 程式時,您可以確信程式只針對這些特定套件執行。

Visual Studio 提供為專案建立虛擬環境的直接支援。 如果您開啟包含 requirements.txt 檔案的專案,Visual Studio 會自動提示您建立虛擬環境並安裝這些相依性。 當您從包含 requirements.txt 檔案的範本建立專案時,會看到相同的行為。

您可以隨時在開啟的專案內建立新的虛擬環境。 在 [方案總管] 中,展開項目節點,以滑鼠右鍵按兩下 [Python 環境],然後選擇 [ 新增環境]。 在 [新增環境] 中,選擇 [虛擬環境]。 如需詳細資訊,請參閱 建立虛擬環境

Visual Studio 也提供命令,從虛擬環境產生 requirements.txt 檔案,讓您輕鬆地在其他計算機上重新建立環境。 如需詳細資訊,請參閱 使用虛擬環境

Conda 環境

您可以使用 工具,或在 Visual Studio 2017 15.7 版和更新版本中使用整合式 conda 管理來建立 conda 環境 conda 。 Conda 環境需要 Anaconda 或 Miniconda。 這些平臺可透過Visual Studio安裝程式取得。 如需詳細資訊,請參閱 在Visual Studio中安裝 Python 支援。

  1. [Python 環境] 視窗或 Python 工具列中,選取 [新增環境 ] 以開啟 [ 新增環境 ] 對話框。

  2. 在 [ 新增環境] 對話框中,選取 [Conda 環境] 索引 標籤:

    Visual Studio 中 [新增環境] 對話框中 [Conda 環境] 索引卷標的螢幕快照。

  3. 設定下列欄位:

    領域 說明
    計畫 識別要在其中建立環境的專案。
    名稱 提供 conda 環境的名稱。
    從新增套件 指定如何將套件新增至 conda 環境。
    - 環境檔案:如果您有描述相依性的 environment.yml 檔案,請選取此選項。 輸入檔案的名稱,或流覽 (...) 至檔案位置,然後選取檔案。
    - 一或多個 Anaconda 套件名稱:如果您想要列出一或多個 Python 套件或 Python 版本,請選取此選項。

    套件清單會指示 conda 建立 Python 環境。 若要安裝最新版本的 Python,請使用 python 命令。 若要安裝特定版本,請使用 命令 python=,major>.<minor> ,如同 中的 python=3.7。 您也可以使用 [套件] 按鈕,從一系列功能表中選取 Python 版本和一般套件。
    將設定為目前的環境 在建立環境之後,在選取的項目中啟動新的環境。
    設定為新項目的默認環境 在Visual Studio中建立的任何新專案中,自動設定並啟動 conda 環境。 此選項與在 [Python 環境] 視窗中使用 [將此設為新項目的默認環境] 相同。
    在 Python 環境視窗中檢視 指定是否要在建立環境之後顯示 [Python 環境] 視窗。

    這很重要

    當您建立 conda 環境時,請務必指定至少一個 Python 版本或 Python 套件,以確保環境包含 Python 運行時間。 您可以使用 environments.yml 檔案或套件清單。 如果您沒有提供此規格,Visual Studio 會忽略環境。 環境不會出現在 [Python 環境] 視窗中的任何位置,它不會設定為專案的目前環境,而且無法作為全域環境使用。

    如果您碰巧在沒有 Python 版本的情況下建立 conda 環境,請使用 conda info 命令來查看 conda 環境資料夾的位置。 然後,您可以從該位置手動移除環境的子資料夾。

  4. 選取 ,創建

您可以在 [ 輸出 ] 視窗中監視 conda 環境的建立。 建立完成之後,輸出會顯示一些命令列介面 (CLI) 指示,例如 conda activate env

螢幕擷取畫面,顯示成功建立 conda 環境。

您可以在 [ 輸出 ] 視窗中監視 conda 環境的建立。 建立完成之後,輸出會顯示一些命令列介面 (CLI) 指示,例如 activate env

顯示 Visual Studio 中成功建立 conda 環境的螢幕快照。

  1. 在 Visual Studio 中,您可以使用與任何其他環境相同的方式,為專案啟用 conda 環境。 如需詳細資訊,請參閱 選取項目的環境

  2. 若要在環境中安裝更多套件,請使用 [Python 環境] 視窗上的 [套件] 索引標籤。

備註

如需 conda 環境的最佳結果,請使用 conda 4.4.8 或更新版本。 請記住,conda 版本與 Anaconda 版本不同。 您可以透過 Visual Studio 安裝程式安裝適當的 Miniconda 版本 (Visual Studio 2019 和 Visual Studio 2022) 和 Anaconda (Visual Studio 2017)。

若要查看 conda 版本,其中 conda 環境是儲存的,以及其他資訊,請在 Anaconda 命令提示字元中執行 conda info 命令 (Anaconda 所在的命令提示字元):

conda info

您的 conda 環境資料夾如下所示:

       envs directories : C:\Users\user\.conda\envs
                          c:\anaconda3\envs
                          C:\Users\user\AppData\Local\conda\conda\envs

因為 conda 環境不會與專案一起儲存,所以其行為與全域環境類似。 例如,將新套件安裝到 conda 環境,讓該套件可供使用環境的所有專案使用。

針對 Visual Studio 2017 15.6 版和更早版本,您可以手動指向 conda 環境,如手動 識別現有環境中所述。

Visual Studio 2017 15.7 版和更新版本會自動偵測 conda 環境,並在 [Python 環境] 視窗中顯示它們,如下一節所述。

手動識別現有的環境

使用下列步驟來識別安裝在非標準位置的環境。

  1. [Python 環境] 視窗或 Python 工具列中,選取 [新增環境 ] 以開啟 [ 新增環境 ] 對話框。

  2. 在 [ 新增環境] 對話框的 [ 現有環境 ] 索引標籤上,將 [ 環境 ] 字段設定為 <[自定義>]:

螢幕擷取畫面顯示如何在 [新增環境] 對話方塊中將 [環境] 欄位設定為 [自訂]。

Visual Studio 中 [新增環境] 對話框 [現有環境] 索引標籤的螢幕快照,其中顯示如何將 [環境] 字段設定為 [自定義]。

選取 [<自定義>] 值之後,對話框會新增更多欄位。

  1. 將 [ 前置詞路徑] 欄位設定為解釋器的路徑。 您可以瀏覽 [...] 將欄位設定為路徑位置。

螢幕擷取畫面,顯示如何在 [新增環境] 對話方塊中指定自訂環境的詳細資料。

此螢幕快照顯示如何在 Visual Studio 的 [新增環境] 對話框中指定自定義環境的詳細數據。

  1. 選取路徑之後,會填入其餘欄位。 檢視值,並視需要修改。 準備就緒後,選取 [新增]

您也可以隨時在 [Python 環境 ] 視窗中檢閱和修改環境的詳細數據。

  1. [Python 環境] 視窗中,選取環境,然後選取 [ 設定 ] 索引標籤。

  2. 進行變更之後,請選取 [ 套用 ] 命令。

您也可以使用 Remove 命令移除環境。 如需詳細資訊,請參閱 設定索引標籤。此命令不適用於自動偵測的環境。

修正或刪除無效的環境

如果 Visual Studio 找到環境的登錄專案,但解釋器的路徑無效,則 [Python 環境] 視窗會以罷工字型格式顯示環境名稱,如下圖所示:

「Python 環境」視窗中無效環境的螢幕擷取畫面。

[Python 環境] 視窗的螢幕快照,其中顯示 Visual Studio 中無效的環境。

若要更正您想要保留的環境,請先嘗試使用環境安裝程序的 修復 程式。 大部分的安裝程式都包含修復選項。

修改登錄以更正環境

如果 Python 環境沒有修復選項,或您想要移除無效的環境,您可以使用下列步驟直接修改登錄。 當您變更登錄時,Visual Studio 會自動更新 [Python 環境] 視窗。

  1. 執行 regedit.exe 可執行檔以開啟登錄編輯器。

  2. 瀏覽至對應至組態的環境資料夾:

    Python 版本 資料夾
    64 位版本 HKEY_LOCAL_MACHINE\SOFTWARE\PythonHKEY_CURRENT_USER\Software\Python
    32 位版本 HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Python
    IronPython IronPython
  3. 展開環境的散發和版本節點結構:

    分配 Node
    CPython PythonCore><版本節點>
    Anaconda ContinuumAnalytics><版本節點>
    IronPython <版本節點>
  4. 檢查 InstallPath 節點底下的值:

    登錄編輯器中一般 CPython 安裝的登錄項目螢幕快照。

    • 如果計算機上仍有環境,請將 ExecutablePath 專案的值變更為正確的位置。 也視需要更正 (Default)WindowedExecutablePath 專案的值。
    • 如果您的電腦上已不存在環境,而且您想要從 [Python 環境] 視窗移除它,請刪除 InstallPath 節點的版本號碼父節點。 您可以在上圖中看到此節點的範例。 在此範例中,此節點為 3.6

    謹慎

    HKEY_CURRENT_USER\SOFTWARE\Python 金鑰中的設定無效,會覆寫 HKEY_LOCAL_MACHINE\SOFTWARE\Python 金鑰中的設定。

刪除或移除 Python 環境

若要移除 Python 專案,請流覽至 方案總管中的 Python 環境。 以滑鼠右鍵按下您要移除的 Python 環境,然後選取 [移除]。

螢幕擷取畫面,顯示如何移除 Python 環境。

顯示如何在 Visual Studio 中移除 Python 環境的螢幕快照。

如果您想要保留 Python 環境,但從專案中移除它,請選取 [移除]。 如果您想要永久刪除環境,請選取 [ 刪除]。

螢幕擷取畫面,顯示如何刪除或移除 Python 環境。

顯示如何在 Visual Studio 中刪除或移除 Python 環境的螢幕快照。