仮想環境¶

Pythonにおける開発に欠かせない、仮想環境(Virtual Environment)(1)について紹介します。

仮想環境を扱うツールがvenvという名前なのもあり、略してvenvと呼称されます。

仮想環境の必要性¶

Pythonではプロジェクトの環境は自動で分離されません。

何も考えずにパッケージをインストールすると、そのパッケージはグローバルな環境にインストールされます。一般的にPythonはシステム上にインストールされているため、システムに対しパッケージがインストールされることになります。

これによる問題点は何でしょうか？

例えば、2つのPythonプロジェクトとして「プロジェクトA」と「プロジェクトB」があるとします。プロジェクトAではパッケージXのv1を使用しており、プロジェクトBではパッケージXのv2を使用しているとします。

グローバルな環境にそれぞれがインストールされると、パッケージXのv1とv2が共存することになります。

flowchart
    A[プロジェクトA] --> X1
    B[プロジェクトB] --> X2
    subgraph グローバル環境
        X1[パッケージX v1]
        X2[パッケージX v2]
    end

しかし残念ながら、あるパッケージの異なるバージョンが共存することはできません。実際に異なるバージョンをインストールすると、後勝ちとなり先に存在していたバージョンが上書きされます。

flowchart
    subgraph グローバル環境
        X1[パッケージX v1]
        X2[パッケージX v2]
        X1 <-.->|⛔️共存不可| X2
    end

これでは他プロジェクトとのパッケージ競合を常に気にかける必要があり、非常に煩雑です。そもそも特定のプロジェクトでしか使わないパッケージを、グローバルな環境にインストールする事自体が望ましくありません。

仮想環境による環境の分離¶

仮想環境がこの問題を解決します。

仮想環境はプロジェクトごとに作成します。パッケージは仮想環境に対しインストールされるため、他の環境からは分離して管理されます。各仮想環境はそれぞれ独立しているため、他の環境を気にかける必要がありません。

flowchart
    B[プロジェクトB] --> X2[パッケージX v2]
    subgraph 仮想環境B
        X2
    end
    A[プロジェクトA] --> X1[パッケージX v1]
    subgraph 仮想環境A
        X1
    end
    subgraph グローバル環境
        Y[...]
    end

仮想環境の扱い方¶

では、実際に仮想環境の使い方を見てみましょう。

ここでは、Ubuntu上での動作を例にします。システムにPythonがインストールされていれば、同様に動作するでしょう。

mkdir venv_demo

cd venv_demo

仮想環境は、venvモジュールを利用します。 Ubuntu24.04では、aptコマンドでモジュールをインストールします。

sudo apt install python3-venv

venvモジュールを使用し、.venvという名前で仮想環境を作成します。

python -m venv .venv

コマンドの意味

-m venvで、venvモジュールをスクリプトとして呼び出しています。

仮想環境の名前

仮想環境の名前は任意に指定できますが、慣例として.venvという名前が使用されます。

VSCodeなどのIDEもこの名前で仮想環境を検知しているため、特別な理由がない限り.venvとしておきましょう。

コマンド実行すると、指定した仮想環境名でディレクトリが作成されます。ディレクトリ内は下記のような構造となっているはずです。

仮想環境を作成した後、この仮想環境を有効化する必要があります。