Visual Studio で Python 環境を作成および管理する

Python 環境は、Python コードを実行するコンテキストであり、グローバル環境、仮想環境、conda 環境が含まれます。環境は、インタープリター、ライブラリ (通常は Python 標準ライブラリ)、インストールされているパッケージのセットで構成されます。これらのコンポーネントによって、有効な言語構造と構文、アクセスできるオペレーティングシステム機能、および使用できるパッケージが決まります。

Windows 上の Visual Studio では、この記事の説明に従って [Python 環境 ] ウィンドウを使用して環境を管理し、新しいプロジェクトの既定値として選択します。

環境のその他の側面については、次の記事を参照してください。

特定のプロジェクトでは、既定を使用するのではなく、特定の環境を選択できます。
Python プロジェクトの仮想環境の作成と使用の詳細については、「仮想環境の使用」を参照してください。
環境にパッケージをインストールする場合は、「パッケージ」タブのリファレンスを参照してください。
別の Python インタープリターをインストールするには、「 Python インタープリターのインストール」を参照してください。一般に、メインライン Python ディストリビューション用のインストーラーをダウンロードして実行すると、Visual Studio によって新しいインストールが検出され、[ Python 環境 ] ウィンドウに環境が表示され、プロジェクト用に選択できます。

注

フォルダーとして開く Python コードの環境を管理するには、 ファイル>Open>Folder を選択します。 Python ツールバーを使用すると、検出されたすべての環境を切り替え、新しい環境を追加することもできます。環境情報は、ワークスペースの .vs フォルダーの PythonSettings.json ファイルに格納されます。

[前提条件]

インストールされている Python ワークロード

Visual Studio で Python を初めて使用する場合は、一般的な背景情報について次の記事を参照してください。

Python 環境ウィンドウ

Visual Studio で認識されている環境は、[ Python 環境 ] ウィンドウに表示されます。ウィンドウを開くには、次のいずれかの方法を使用します。

表示>その他の Windows>Python 環境を選択します。
ソリューションエクスプローラーでプロジェクトの [Python 環境] ノードを右クリックし、[すべての Python 環境の表示] を選択します。

Visual Studio のソリューションエクスプローラーと共に [Python 環境] ウィンドウが表示されます。

Visual Studio では、仮想環境と conda 環境と共に、レジストリ (PEP 514 に続く) を使用して、インストールされているグローバル環境を検索します。一覧に想定される環境が表示されない場合は、「既存の環境を手動で識別する」を参照してください。

一覧で環境を選択すると、Visual Studio は Python 環境ウィンドウの [概要] タブに、その環境のさまざまなプロパティとコマンド (インタープリターの場所など) を表示します。 [ 概要 ] タブの下部にあるコマンドはそれぞれ、インタープリターが実行されているコマンドプロンプトを開きます。詳細については、「 Python 環境」ウィンドウのタブリファレンス - 概要を参照してください。

環境の一覧のドロップダウンリストを使用して、 パッケージ や IntelliSense などのさまざまなタブに切り替えます。これらのタブについては、「 Python 環境」ウィンドウのタブリファレンスでも説明されています。

環境を選択しても、プロジェクトとの関係は変更されません。一覧の太字で示されている既定の環境は、Visual Studio が新しいプロジェクトに使用する環境です。新しいプロジェクトで別の環境を使用するには、[この環境を 新しいプロジェクトの既定の環境 にする] コマンドを使用します。プロジェクトのコンテキスト内では、常に特定の環境を選択できます。詳細については、「プロジェクトの環境を選択する」を参照してください。

表示されている各環境の右側には、その環境の 対話型 ウィンドウを開くコントロールがあります。

注

Visual Studio 2017 15.5 以前では、その環境の IntelliSense データベースを更新する別のコントロールが表示されます。データベースの詳細については、「 Python 環境」ウィンドウのタブリファレンスを参照してください。

ヒント

[Python 環境] ウィンドウを十分に広げると、作業に便利な環境の詳細なビューが表示されます。

ヒント

[Python 環境] ウィンドウを十分に広げると、作業に便利な環境の詳細なビューが表示されます。

ヒント

[Python 環境] ウィンドウを十分に広げると、作業に便利な環境の詳細なビューが表示されます。

注

Visual Studio ではシステムサイトパッケージオプションが考慮されますが、Visual Studio 内から変更する方法は提供されません。

環境が表示されない場合はどうすればよいですか?

[Python 環境] ウィンドウに環境が表示されない場合は、Visual Studio が標準の場所にある Python インストールを検出できなかったことを意味します。 Visual Studio 2017 以降をインストールしたが、Python ワークロードのインストーラーオプションのすべてのインタープリターオプションをクリアした可能性があります。同様に、Visual Studio 2015 以前をインストールしたが、インタープリターを手動でインストールしなかった可能性があります。詳細については、「 Python インタープリターのインストール」を参照してください。

コンピューターに Python インタープリターがあることがわかっているが、Visual Studio (任意のバージョン) で検出されなかった場合は、 + Custom コマンドを使用してインタープリターの場所を手動で指定します。詳細については、「既存の環境を手動で識別する」を参照してください。

環境の種類

Visual Studio は、グローバル環境、仮想環境、conda 環境で動作できます。

グローバル環境

各 Python インストールでは、独自の グローバル環境が維持されます。たとえば、Python 2.7、Python 3.6、Python 3.7、Anaconda 4.4.0 などです。詳細については、「 Python インタープリターのインストール」を参照してください。

各環境は、特定の Python インタープリター、標準ライブラリ、およびプレインストールされたパッケージのセットで構成されます。環境がアクティブ化されている間にインストールする他のパッケージも含まれます。パッケージをグローバル環境にインストールすると、その環境を使用するすべてのプロジェクトでパッケージを使用できるようになります。環境がファイルシステムの保護された領域 ( c:\program ファイル内など) にある場合、パッケージをインストールするには管理者特権が必要です。

グローバル環境は、コンピューター上のすべてのプロジェクトで使用できます。 Visual Studio では、既定として 1 つのグローバル環境を選択します。これは、プロジェクトに別の環境を特に選択しない限り、すべてのプロジェクトに使用されます。詳細については、「プロジェクトの環境を選択する」を参照してください。

仮想環境

グローバル環境での作業は、簡単に始める方法です。時間の経過と共に、さまざまなプロジェクトにさまざまなパッケージがインストールされ、環境が煩雑になる可能性があります。混乱により、既知のバージョンの特定のパッケージセットに対してアプリケーションを徹底的にテストすることが困難になる可能性があります。ただし、この種の環境は、ビルドサーバーまたは Web サーバーに設定する予定です。競合は、2 つのプロジェクトで互換性のないパッケージまたは同じパッケージの異なるバージョンが必要な場合にも発生する可能性があります。

このような理由から、開発者は多くの場合、プロジェクトの 仮想環境 を作成します。仮想環境は、特定のインタープリターのコピーを含むプロジェクト内のサブフォルダーです。仮想環境をアクティブ化すると、インストールするすべてのパッケージは、その環境のサブフォルダーにのみインストールされます。仮想環境内で Python プログラムを実行すると、そのプログラムが特定のパッケージのみに対して実行されていることを確信できます。

Visual Studio は、プロジェクトの仮想環境を作成するための直接サポートを提供します。 requirements.txt ファイルを含むプロジェクトを開くと、Visual Studio によって、仮想環境を作成し、それらの依存関係をインストールするように自動的に求められます。テンプレートにrequirements.txtファイルが含まれている場合、そのテンプレートからプロジェクトを作成したときに同じ動作が見られます。

開いているプロジェクト内でいつでも、新しい仮想環境を作成できます。 ソリューションエクスプローラーでプロジェクトノードを展開し、[Python 環境] を右クリックし、[環境の追加] を選択します。 [ 環境の追加] で、[ 仮想環境] を選択します。詳細については、「仮想環境の作成」を参照してください。

Visual Studio には、仮想環境から requirements.txt ファイルを生成するコマンドも用意されているため、他のコンピューターで環境を簡単に再作成できます。詳細については、「仮想環境の使用」を参照してください。

Conda 環境

conda 環境は、 conda ツールを使用するか、Visual Studio 2017 バージョン 15.7 以降で統合された conda 管理を使用して作成できます。 conda 環境には、Anaconda または Miniconda が必要です。これらのプラットフォームは、Visual Studio インストーラーから入手できます。詳細については、「 Visual Studio での Python サポートのインストール」を参照してください。

[Python 環境] ウィンドウまたは Python ツールバーの [環境の追加] を選択して、[環境の追加] ダイアログを開きます。
[ 環境の追加 ] ダイアログで、[ Conda 環境 ] タブを選択します。

次のフィールドを構成します。

フィールド	Description
プロジェクト	環境を作成するプロジェクトを識別します。
名前	conda の環境名を提供します。
からパッケージを追加する	conda 環境にパッケージを追加する方法を指定します。 - 環境ファイル: 依存関係を記述する environment.yml ファイルがある場合は、このオプションを選択します。ファイルの名前を入力するか、ファイルの場所を参照 (...) してファイルを選択します。 - 1 つ以上の Anaconda パッケージ名: 1 つ以上の Python パッケージまたは Python バージョンを一覧表示する場合は、このオプションを選択します。パッケージの一覧は、Python 環境を作成するように conda に指示します。最新バージョンの Python をインストールするには、 `python` コマンドを使用します。特定のバージョンをインストールするには、`python=,major>.<minor>`のようにコマンド `python=3.7`を使用します。 [パッケージ] ボタンを使用して、一連のメニューから Python バージョンと一般的なパッケージを選択することもできます。
現在の環境として設定	環境が作成された後、選択したプロジェクトの新しい環境をアクティブにします。
新しいプロジェクトの既定の環境として設定する	Visual Studio で作成された新しいプロジェクトで conda 環境を自動的に設定およびアクティブ化します。このオプションは、[Python 環境] ウィンドウの [この環境を新しいプロジェクトの既定の環境にする] を使用する場合と同じです。
Python 環境のウィンドウで表示	環境の作成後に [Python 環境 ] ウィンドウを表示するかどうかを指定します。

Important

conda 環境を作成するときは、少なくとも 1 つの Python バージョンまたは Python パッケージを指定して、環境に Python ランタイムが含まれていることを確認してください。 environments.yml ファイルまたはパッケージリストを使用できます。この仕様を指定しない場合、Visual Studio は環境を無視します。環境は Python 環境 ウィンドウのどこにも表示されず、プロジェクトの現在の環境として設定されておらず、グローバル環境としては使用できません。

Python バージョンを使用せずに conda 環境を作成する場合は、 conda info コマンドを使用して conda 環境フォルダーの場所を確認します。その後、環境のサブフォルダーをその場所から手動で削除できます。

を選択してを作成します。

出力ウィンドウで conda 環境の作成を監視できます。作成が完了すると、 conda activate envなどのコマンドラインインターフェイス (CLI) 命令が出力に表示されます。

出力ウィンドウで conda 環境の作成を監視できます。作成が完了すると、 activate envなどのコマンドラインインターフェイス (CLI) 命令が出力に表示されます。

Visual Studio では、他の環境と同じ方法でプロジェクトの conda 環境をアクティブ化できます。詳細については、「プロジェクトの環境を選択する」を参照してください。
環境にさらにパッケージをインストールするには、[Python 環境] ウィンドウの [パッケージ] タブを使用します。

注

conda 環境で最適な結果を得るには、conda 4.4.8 以降を使用します。 conda のバージョンは Anaconda のバージョンとは異なる点に注意してください。 Visual Studio インストーラーを使用して、Miniconda (Visual Studio 2019 および Visual Studio 2022) と Anaconda (Visual Studio 2017) の適切なバージョンをインストールできます。

conda 環境が格納されている conda バージョンやその他の情報を表示するには、Anaconda コマンドプロンプト (Anaconda がパス内にあるコマンドプロンプト) で conda info コマンドを実行します。

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 環境 ウィンドウに表示されます。

既存の環境を手動で識別する

次の手順を使用して、標準以外の場所にインストールされている環境を特定します。

[Python 環境] ウィンドウまたは Python ツールバーの [環境の追加] を選択して、[環境の追加] ダイアログを開きます。
[ 環境の追加 ] ダイアログの [ 既存の環境 ] タブで、[ 環境 ] フィールドを <Custom に設定します>:

<Custom>値を選択すると、ダイアログにさらにフィールドが追加されます。

[プレフィックスパス] フィールドをインタープリターのパスに設定します。フィールドを設定するには、パスの場所を参照 (...) します。

パスを選択すると、残りのフィールドが入力されます。値を確認し、必要に応じて変更します。準備ができたら、[追加] を選択 します。

また、[ Python 環境 ] ウィンドウでは、環境の詳細をいつでも確認および変更できます。

[ Python 環境 ] ウィンドウで、環境を選択し、[ 構成 ] タブを選択します。
変更を加えた後、[ 適用 ] コマンドを選択します。

Remove コマンドを使用して環境を削除することもできます。詳細については、「構成」タブを参照してください。このコマンドは、自動検出された環境では使用できません。

無効な環境を修正または削除する

Visual Studio で環境のレジストリエントリが見つかるが、インタープリターへのパスが無効な場合、次の図に示すように、[ Python 環境] ウィンドウに取り消し線フォント形式で環境名が表示されます。

保持する環境を修正するには、まず環境インストーラーの修復プロセスを使用してみてください。ほとんどのインストーラーには修復オプションが含まれています。

環境を修正するようにレジストリを変更する

Python 環境に修復オプションがない場合、または無効な環境を削除する場合は、次の手順を使用してレジストリを直接変更できます。レジストリを変更すると、Visual Studio によって [Python 環境] ウィンドウが自動的に更新されます。

regedit.exe 実行可能ファイルを実行して、レジストリエディターを開きます。

構成に対応する環境フォルダーを参照します。

Python バージョン	フォルダー
64 ビットバージョン	HKEY_LOCAL_MACHINE\SOFTWARE\Python または HKEY_CURRENT_USER\Software\Python
32 ビットバージョン	HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Python
IronPython	IronPython

環境の配布ノードとバージョンノード構造を展開します。

流通	Node
CPython	PythonCore><Version ノード>
Anaconda	ContinuumAnalytics><バージョンノード>
IronPython	<バージョンノード>

InstallPath ノードの下の値を調べます。
- コンピューターに環境がまだ存在する場合は、 ExecutablePath エントリの値を正しい場所に変更します。必要に応じて 、(Default) エントリと WindowedExecutablePath エントリの値も修正します。
- コンピューターに環境が存在しなくなり、[ Python 環境 ] ウィンドウから削除する場合は、 InstallPath ノードのバージョン番号の親ノードを削除します。前の図では、このノードの例を確認できます。この例では、このノードは 3.6 です。
注意事項

HKEY_CURRENT_USER\SOFTWARE\Python キーの設定が無効な場合は、HKEY_LOCAL_MACHINE\SOFTWARE\Python キーの設定がオーバーライドされます。