Visual Studio の検索パスで Python フォルダーを使用する

通常の Python プログラムでは、PYTHONPATH 環境変数 (または IRONPYTHONPATH など) によって、モジュール ファイル用の既定の検索パスが提供されます。 from <name> import... または import <name> ステートメントは、指定された <name> と一致するファイルの特定場所を検索するよう Python に指示します。 この場所は、次の順序で検索されます。

  1. Python の組み込みモジュール
  2. 現在実行中の Python コードを含むフォルダー
  3. 該当する環境変数で定義されている "モジュール検索パス" (詳細については、Python コア ドキュメントの「モジュール検索パス」および「環境変数」を参照してください)。

検索パス環境変数がシステム全体に対して設定されている場合でも、Visual Studio はこの変数を無視します。 その理由は、変数を使用すると、次のような簡単に答えることができない疑問が生じるためです。

  • 参照されているモジュールでインストールする必要があるバージョンは、Python 2.7 か、Python 3.6 か、それともその他のバージョンか?
  • 検索パス環境変数で検出されているファイルは、標準ライブラリ モジュールをオーバーライドする必要があるか?
  • オーバーライド動作は予期および対処されているか、それともこのアクションは悪意のある可能性があるか?

開発者を支援するために、Visual Studio では、Python 環境およびプロジェクトの両方で直接検索パスを指定する手段が用意されています。 Visual Studio で実行またはデバッグするコードは、検索パスを PYTHONPATH 環境変数および同等の変数で受け取ります。 検索パスを追加することで、Visual Studio は指定された場所にあるライブラリを検査し、必要に応じてライブラリの IntelliSense データベースを構築します。 (Visual Studio 2017 バージョン 15.5 以前では、ライブラリの数によっては、データベースの構築に時間がかかる場合があります。)

前提条件

  • 見ることができます。 製品をインストールするには、「Visual Studio のインストール」の手順に従います。

  • 検索パスに追加する Python フォルダー。

検索パスに Python フォルダーを追加する

Visual Studio の検索パスに Python フォルダーを追加するには、次の手順に従います。

  1. ソリューション エクスプローラーで Python プロジェクト ノードを展開し、[検索パス] を右クリックして [フォルダーを検索パスに追加] を選択します。

    ソリューション エクスプローラーで Python プロジェクト用のノードにある [検索パス] から [フォルダーを検索パスに追加] コマンドにアクセスする方法を示すスクリーンショット。

  2. ダイアログで、認識された検索パスに追加するフォルダーの場所を参照します。

  3. フォルダーを選択し、[フォルダーの選択] を選択します。

フォルダーが検索パスに追加されると、Visual Studio ではプロジェクトに関連付けられているすべての環境にそれらのパスが使用されます。

Note

環境が Python 3 ベースの場合に、検索パスを Python 2.7 モジュールに追加しようとすると、エラーが発生することがあります。

検索パスに zip ファイルと egg ファイルを追加する

[検索パスへの Zip アーカイブの追加] オプションを使用すれば、.zip または .egg 拡張子を持つファイルを検索パスに追加できます。 フォルダーと同様に、これらのファイルの内容もスキャンされて、IntelliSense に利用されます。