この記事でできること
VSCodeでPythonプロジェクトを新規作成し、仮想環境(.venv)を構築・設定・有効化するまでの手順を紹介します。
こんな方にオススメ
- 仮想環境についてはわかったけど、実際にどうやって作るの?
- Python初心者でVSCodeは他言語で使ったことあるよ!
環境
-
Windows 11
-
VSCode(最新版)
-
Python 3.11.4(公式からインストール済み)
※ Pythonのインストールがまだの方は、こちらの公式手順をご参照ください。 -
VSCodeの新しいウィンドウでプロジェクトを開いている
手順
ステップ1:仮想環境を作成
.venv
をプロジェクト直下に作成
VSCode のターミナル(Ctrl
+ `(バッククォート))で以下を実行:
python -m venv .venv
.venvフォルダが作成されていたら成功
ステップ2:仮想環境を選ぶ
-
Ctrl+Shift+P
→Python: インタープリターの選択
を開く - 表示されたリストから以下を探す:
./.venv/Scripts/python.exe (Windowsの場合)
./.venv/bin/python (Mac/Linuxの場合)
上記のファイルが表示されないときの対処法
- VSCodeをいったん再起動する
- ワークスペースに
.vscode/settings.json
がある場合は、以下のように手動で追記:
{
"python.pythonPath": ".venv/Scripts/python.exe"
}
(VSCode最新版では "python.defaultInterpreterPath"
に変更されている場合もあります)
正しい仮想環境が選ばれたかの確認
ターミナルで以下のコマンドを実行してみてください:
where python # Windows の場合
which python # mac/Linux の場合
出力が以下のようになっていれば OK です:
例(Windows):
C:\Users\ユーザー名\プロジェクト名\.venv\Scripts\python.exe
例(mac/Linux):
/Users/ユーザー名/project/.venv/bin/python
出力されなかった場合:
以下のコマンドを実行
python -c "import sys; print(sys.executable)"
出力が以下のようになっていれば OK です:
例(Windows):
C:\Users\ユーザー名\プロジェクト名\.venv\Scripts\python.exe
例(mac/Linux):
/Users/ユーザー名/project/.venv/bin/python
ステップ3:VSCodeターミナルで仮想環境を有効にする
VSCodeターミナル内で実行:
.venv\Scripts\activate # Windows の場合
source .venv/bin/activate # mac/Linux の場合
🔄 実行後、ターミナルに以下のような表示が出るようになります:
(.venv) PS C:\Users\ユーザー名\プロジェクト名 >
※ パス(C:\Users\~)はご自身のPC環境に応じて変わります
ステップ3の必要性
もしステップ3が無いと、ターミナルでコマンドを打つときに問題が起こる可能性があります。
特に、ステップ4の作業(pip install)は仮想環境ではなく、グローバルに入ってしまう可能性があります。
ステップ4:必要なライブラリをインストール
1. 必要なライブラリをインストール
仮想環境が有効か確認( (.venv)
表示があるか確認)したうえで、進めてください。
下記のコマンドは例になります。
※ ご自身がインストールしたいライブラリによってinstallより後の内容( torch
, torchvision
)を書き換えてください。
pip install torch torchvision
ライブラリとは
色んな便利な機能をひとまとめにしたものです。
Pythonファイルの冒頭に書かれているimport
の後の部分(又はfrom
の後)がライブラリの名前になります。
import torch
from torchvision import models, transforms
2. requirements.txt
を作成
複数人で開発したり、同じ環境を別のPCで再現したいときに役立ちます。
以下のコマンドを実行:
pip freeze > requirements.txt
【今後】同じ環境を再現するとき
requirements.txt を渡したうえで、pip install -r requirements.txt
を移行先のターミナル内で実行すると同じ環境を再現できます。
まとめ
今回はVSCodeでPythonプロジェクトの仮想環境を作ってみました。
初めてやったのですが、最初ライブラリを仮想環境ではなくグローバルにインストールしてしまって焦りました💦
反省を活かし、1つ1つの段階に確認事項を出来るだけ書いてみました。
この記事を読んで、同じ間違いをする人が減ると嬉しいです!