Visual Studio でプロジェクトの Python 環境を選択する

適用対象:yesVisual Studio noVisual Studio for Mac noVisual Studio Code

Python プロジェクトのすべてのコードは、グローバル Python 環境、Anaconda 環境、仮想環境、conda 環境など、特定の環境のコンテキスト内で実行されます。 また、Visual Studio では、デバッグ、インポートとメンバーの入力候補、構文チェックだけでなく、Python のバージョンやインストールされているパッケージ セットに固有の言語サービスを必要とするその他のタスクにもその環境が使用されます。

Visual Studio のすべての新しい Python プロジェクトは、最初は既定のグローバル環境を使用するように構成されています。この環境は、ソリューション エクスプローラー[Python 環境] ノードに表示されます。

ソリューション エクスプローラーに表示される既定のグローバル Python 環境

プロジェクトの環境を変更するには、 [Python 環境] ノードを右クリックし、 [環境を追加] を選択します。 Python ツール バーの環境ドロップダウンから [環境を追加] を選択することもできます。

[環境を追加] ダイアログ ボックスで、 [既存の環境] タブを選択した後、 [環境] ドロップダウン リストから新しい環境を選択します。

[環境を追加] ダイアログでのプロジェクトの環境の選択

グローバル デフォルト以外の環境を既にプロジェクトに追加している場合は、新しく追加した環境をアクティブにする必要がある場合があります。 [Python 環境] ノードの下でその環境を右クリックし、[環境をアクティブ化する] を選択します。 プロジェクトから環境を削除するには、[削除] を選択します。

プロジェクトの環境のアクティブ化と削除

仮想環境を使用する

仮想環境は、特定の Python インタープリターと、他のグローバル環境や conda 環境とは異なる特定のライブラリ セットの固有の組み合わせです。 仮想環境はプロジェクトに固有であり、プロジェクト フォルダーで管理されます。 そのフォルダーには、環境のインストール済みのライブラリの他に、ファイル システムの他の場所にある環境の "基本インタープリター" へのパスを示す pyvenv.cfg ファイルが格納されます。 (つまり、仮想環境にはインタープリターのコピーではなく、それに対するリンクのみが含まれます)。

仮想環境を使用する利点は、時間の経過とともにプロジェクトの開発が進んでも、プロジェクトの正確な依存関係が常に仮想環境に反映されるということです。 (一方、共有グローバル環境では、プロジェクトでの使用の有無に関係なく、複数のライブラリが含まれます)。仮想環境から requirements.txt ファイルを簡単に作成でき、そのファイルを使用して依存関係を別の開発環境または実稼働コンピューターに再インストールできます。 詳細については、「requirements.txt での必須パッケージの管理」をご覧ください。

requirements.txt ファイルが含まれているプロジェクトを Visual Studio で開くと、仮想環境を再作成するためのオプションが自動的に示されます。 Visual Studio がインストールされていないコンピューターでは、pip install -r requirements.txt を使用してパッケージを復元できます。

仮想環境には基本インタープリターへのハード コードされたパスが含まれていること、および requirements.txt を使用して環境を再作成できるため、通常は、ソース管理から仮想環境フォルダー全体が除外されます。

以降のセクションで、プロジェクト内の既存の仮想環境をアクティブ化する方法と、新しい仮想環境を作成する方法について説明します。

Visual Studio では、ソリューション エクスプローラーの.[Python 環境] ノードを使用して、他の環境と同じようにプロジェクトの仮想環境をアクティブ化できます。

仮想環境がプロジェクトに追加されると、[Python 環境] ウィンドウに表示されます。 他の環境と同様にアクティブ化でき、そのパッケージを管理できます。

仮想環境を作成する

次のように、Visual Studio で新しい仮想環境を直接作成できます。

  1. ソリューション エクスプローラー[Python 環境] を右クリックして [環境を追加] を選択するか、Python ツールバーの環境ドロップダウン リストから [環境を追加] を選択します。 表示される [環境を追加] ダイアログで、[仮想環境] タブを選択します。

    [環境を追加] ダイアログ ボックスの [仮想環境] タブ

  2. 仮想環境の名前を指定し、ベース インタープリターを選択して、その場所を確認します。 [Install packages from file](ファイルからパッケージをインストールする) の下で、必要な場合は requirements.txt ファイルのパスを指定します。

  3. ダイアログのその他のオプションを確認します。

    オプション 説明
    現在の環境として設定 環境を作成した後、選択したプロジェクトで新しい環境をアクティブ化します。
    新しいプロジェクトの既定の環境として設定 Visual Studio で作成されるすべての新しいプロジェクトで、仮想環境を自動的に設定してアクティブにします。 このオプションを使う場合、特定のプロジェクトの外部の場所に仮想環境を配置する必要があります。
    Python 環境ウィンドウで表示 環境の作成後、[Python 環境] ウィンドウを開くかどうかを指定します。
    この環境をグローバルに使用可能にする 仮想環境をグローバル環境としても機能させるかどうかを指定します。 このオプションを使う場合、特定のプロジェクトの外部の場所に仮想環境を配置する必要があります。
  4. [作成] を選択して仮想環境を完成します。 環境の構成と必要なパッケージのダウンロード中は進行状況バーが表示されます。 完了すると、仮想環境がアクティブになり、ソリューション エクスプローラー[Python 環境] ノードと、それを含むプロジェクトの [Python 環境] ウィンドウに表示されます。

既存の仮想環境をアクティブ化する

他の場所で既に仮想環境を作成している場合は、次のようにプロジェクトでその仮想環境をアクティブ化することができます。

  1. ソリューション エクスプローラー[Python 環境] を右クリックし、[環境を追加] を選択します。

  2. [参照] ダイアログが表示されたら、仮想環境があるフォルダーに移動して選択し、 [OK] を選択します。 Visual Studio でその環境内に requirements.txt ファイルが検出されると、それらのパッケージをインストールするかどうかが確認されます。

  3. しばらくすると、ソリューション エクスプローラー[Python 環境] ノードに仮想環境が表示されます。 既定では仮想環境はアクティブ化されないので、仮想環境を右クリックし、[環境をアクティブ化する] を選択します。

仮想環境を削除する

  1. ソリューション エクスプローラーで仮想環境を右クリックし、 [クリア] を選択します。

  2. 仮想環境をクリアするか削除するかが確認されます。 [クリア] を選択すると、その環境はプロジェクトで使用できなくなりますが、ファイル システムには残ります。 [削除] を選択すると、プロジェクトから環境がクリアされ、ファイル システムからも削除されます。 ベース インタープリターは影響を受けません。

インストール済みのパッケージを表示する

ソリューション エクスプローラーで、特定の環境のノードを展開すると、その環境にインストールされているパッケージがすぐに表示されます (つまり、環境がアクティブな場合にコード内でそれらのパッケージをインポートして使用できます)。

ソリューション エクスプローラーでの環境の Python パッケージ

新しいパッケージをインストールするには、環境を右クリックし、[Python パッケージの管理] を選択して (または Python ツールバー上のパッケージ ボタンを使って) [Python 環境] ウィンドウの適切な [パッケージ] タブに切り替えます。 [パッケージ] タブで、検索用語 (通常はパッケージ名) を入力すると、一致するパッケージが Visual Studio に表示されます。

Visual Studio 内では、ほとんどの環境のパッケージ (および依存関係) が Python Package Index (PyPI) からダウンロードされます。ここでは利用可能なパッケージを検索することもできます。 Visual Studio のステータス バーと出力ウィンドウには、インストールに関する情報が表示されます。 パッケージをアンインストールするには、パッケージを右クリックして [Remove (削除)] を選びます。

通常、conda パッケージ マネージャーでは既定のチャンネルとして https://repo.continuum.io/pkgs/ が使われますが、その他のチャンネルも使用可能です。 詳細については、チャンネルの管理に関するページ (docs.conda.io) をご覧ください。

表示されるエントリは常に正確であるとは限らず、インストールとアンインストールが信頼できない場合、または使用できない場合がある点に注意してください。 Visual Studio は、使用可能な場合は pip パッケージ マネージャーを使い、必要な場合はダウンロードしてインストールします。 Visual Studio は、easy_install パッケージ マネージャーを使うこともできます。 コマンド ラインから pip または easy_install を使ってインストールされたパッケージも表示されます。

また、現在 Visual Studio では、conda を使用して conda 環境にパッケージをインストールする操作はサポートされていません。 代わりにコマンド ラインから conda を使用してください。

ヒント

pip でパッケージのインストールに失敗する一般的な状況は、パッケージの *.pyd ファイルにネイティブ コンポーネントのソース コードが含まれる場合です。 必要なバージョンの Visual Studio がインストールされていない場合、pip はこれらのコンポーネントをコンパイルできません。 このような状況では、"エラー: vcvarsall.bat が見つかりません" というエラー メッセージが表示されます。 多くの場合、easy_install を使用してコンパイル済みのバイナリをダウンロードでき、Python の古いバージョンに適したコンパイラを https://python.en.uptodown.com/windows/versions からダウンロードできます。 詳しくは、Python Tools チーム ブログの「How to deal with the pain of "unable to find vcvarsallbat"」("vcvarsallbat が見つからない" という問題への対処方法) をご覧ください。

関連項目