Pythonのvenvモジュールで仮想環境を作成する方法

仮想環境が必要な理由

Pythonベースのアプリケーションを開発していると、特定のバージョンのPythonパッケージが必要になることがあります。しかし、そのバージョンをシステム全体向けにインストールしてしまうと、他のアプリケーションが要求するパッケージのバージョンと競合する可能性があります。このような互換性の問題を回避するためには、目的ごとに独立した環境を並行して用意しておくことが望まれます。

仮想環境を利用すれば、Pythonパッケージをシステム全体ではなく、特定のアプリケーション専用の隔離された場所にインストールできます。

venvモジュールで仮想環境を作成する

Pythonの標準ライブラリに含まれるvenvモジュールを使うと、仮想環境を作成できます。仮想環境とは、ファイルシステム上の一つのディレクトリであり、独自のPythonインタープリタや各種スクリプトのコピーを保持しています。以下のコマンドを実行すると、指定した名前のディレクトリに仮想環境が作成されます。

C:\python37>python -m venv e:\testenv

コマンド実行後、指定した場所に新しいディレクトリが作成されていることを確認できます。必要に応じて、以下のオプションを指定することも可能です。

Scriptsフォルダの内容

ENV_DIR（この例ではtestenv）配下の「scripts」フォルダには、Pythonインタープリタのローカルコピー、pipインストーラー、そして環境を有効化・無効化するためのスクリプトが格納されています。

activate
activate.bat
activate.ps1
deactivate.bat
easy_install-3.7.exe
easy_install.exe
pip.exe
pip3.7.exe
pip3.exe
python.exe
pythonw.exe

仮想環境を有効化する

隔離された環境内でPythonを起動するには、まず仮想環境を有効化（アクティベート）する必要があります。そのためには、コマンドラインから「activate.bat」を実行します。

E:\testenv>scripts\activate

(testenv) E:\testenv>python
Python 3.7.2 (tags/v3.7.2:9a3ffc0492, Dec 23 2018, 23:09:28) [MSC v.1916 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>

コマンドプロンプトの左側に括弧付きで仮想環境名が表示されていれば、有効化は成功です。これで仮想環境内のPythonを利用できるようになります。

この状態でpip3ユーティリティを使ってパッケージをインストールすると、仮想環境のscriptsフォルダ内にローカルインストールされるため、システム全体からは参照されません。

仮想環境を無効化する

通常の環境へ戻るには、scriptsフォルダ内の「deactivate.bat」を使って仮想環境を無効化（ディアクティベート）します。

>>> quit()

(testenv) E:\testenv>scripts\deactivate
E:\testenv>

補足：古いバージョンのPythonの場合

Python 3.3より前のバージョンでは、別途インストールが必要な「virtualenv」を使用してください。

また、venvモジュールにはEnvironmentBuilderクラスが定義されており、スクリプトからプログラム的に仮想環境を作成することも可能です。