😽

venvによるPython仮想環境の作成

2024/12/08に公開

Python

仮想環境

venv

tech

本記事の概要

本記事では、Windows環境におけるvenvを使用したPythonの仮想環境の作成から削除までの一連の手順を解説します。具体的には、venvによる仮想環境の作成、環境の有効化（activate）、パッケージの一括インストール、Visual Studio Codeでの開発環境設定、環境の無効化（deactivate）、そして安全な仮想環境の削除方法までを説明します。

前提とする環境

本記事において前提としている環境を次に示します。

OS: Windows 11
- バージョン: 23H2
- 64ビットオペレーティングシステム、x64ベースプロセッサ
Visual Studio Code: 1.95.3

仮想環境の作成とactivate～deactivate

仮想環境の作成とactivate～deactivateまでの手順を説明します。
まず、コマンドプロンプト上で次のコマンドを順番に実行し、仮想環境を作成します。

# 仮想環境を作成するディレクトリに移動する（パスは自身の環境に合わせる）
cd C:\Users\username\Projects\my-project

# 仮想環境を作成する
py -m venv .venv

次に、仮想環境の有効化のためにactivateを実行します。このactivateの実行により、自動的に環境変数PATHが変更されます。

# 仮想環境の有効化
.venv\Scripts\activate

# activateされたことを確認する
# 正常にactivateされていれば.venvを含むディレクトリパスが出力される
where python

パッケージの一括インストールの準備としてrequirements.txtを作成します。
今回は例として次のような構成とします。

requirements.txt

numpy==1.26.3
pandas==2.1.3
matplotlib==3.8.1

作成したrequirements.txtをプロジェクトのルートディレクトリ直下に配置します。
requirements.txtのドラッグ＆ドロップ、または、コマンドプロンプト上で次のコマンドを実行します。

move C:\{元のパス}\requirements.txt C:\Users\username\Projects\my-project

コマンドプロンプト上で次のコマンドを実行し、パッケージを一括インストールします。

# パッケージを一括インストール
py -m pip install -r requirements.txt

# 指定通りインストールされていることを確認
pip list

コーディング等の作業を行うには、VSCode上で次の操作をして作成した仮想環境のディレクトリに移動します。

ファイル > フォルダを開くで対象のディレクトリを開く
Ctrl + Shift + Pでコマンドパレットを開く
Python: Select Interpreterと入力する
一覧から仮想環境のインタープリタを選択する

VSCode上でコーディング等の作業を行います。
今回は例として以下のsample_plot.pyを作成します。

sample_plot.py

import matplotlib.pyplot as plt
import numpy as np

# データの生成
x = np.linspace(-5, 5, 100)
y1 = np.sin(x)
y2 = np.sin(2 * x)

# プロットの作成
plt.figure(figsize=(6, 4))
plt.plot(x, y1, label="Sin(x)", color="lightblue")
plt.plot(x, y2, label="Sin(2x)", color="lightgreen")

# グラフの設定
plt.title("Sine Wave Plot")
plt.xlabel("x")
plt.ylabel("y")
plt.grid(True, axis="x")
plt.legend(loc="upper right")

# グラフの表示
plt.show()

VSCode上でsample_plot.pyを右クリックし、ターミナルでPythonファイルを実行するを実行します。
次のグラフが表示されます。
sine_wave_plot

作業中にパッケージの追加インストールが必要になった場合は次のコマンドを実行します。

# 例としてseabornをインストールする
pip install seaborn

# requirements.txtを更新する
py -m pip freeze > requirements.txt

作業が完了したら、ターミナルを終了します。

ターミナル終了後、VSCodeで以下の操作を行います。

VSCode上で開いているファイルを全て閉じる
Ctrl + Shift + Pでコマンドパレットを開く
Python: Select Interpreterと入力する
一覧から別のインタープリタを選択する

最後にコマンドプロンプト上でdeactivateを実行します。

deactivate

作成した仮想環境の削除

仮想環境の削除は、単純にディレクトリを削除するだけでできますが安全を考慮して以下の手順を踏むことが推奨されます。まず、削除対称の仮想環境が有効化されている場合はdeactivateコマンドで無効化し、使用中の環境を誤って削除することを防ぎます。その後、rmdirコマンドでディレクトリを削除します。

deactivate
rmdir .venv /s /q

まとめ

本記事では、venvを使用した仮想環境の作成、requirements.txtによるパッケージの一括インストール、Visual Studio Codeでの開発環境設定、安全な仮想環境の削除までの一連の流れを解説しました。これらの手順を理解することで、プロジェクトごとに独立した開発環境を管理することができます。