Zenn
🫨

VS Code Python 環境構築手順 (pyenv + venv 版)

に公開
Python
tech

このドキュメントは、pyenvでPythonバージョンを管理し、プロジェクトごとにvenvで仮想環境を構築する、モダンで推奨される開発環境のセットアップ手順をまとめたものです。

1. ワークフローの全体像

  1. pyenv: プロジェクトで使うPythonのバージョンを決定する。
  2. venv: そのPythonバージョンを元に、プロジェクト専用のライブラリ環境（仮想環境）を作成する。
  3. VS Code: 仮想環境内のPythonインタプリタを指定して、コーディングとデバッグを行う。

2. 前提条件

  • Visual Studio Code がインストールされていること。
  • pyenv がインストールされ、利用したいPythonバージョンがインストール済みであること。（例: pyenv install 3.12.4）

3. 手順

ステップ1: プロジェクトのPythonバージョンを指定

ターミナルでプロジェクトディレクトリに移動し、pyenvを使ってこのプロジェクトで利用するPythonのバージョンを固定します。これにより .python-version ファイルが作成されます。

# このプロジェクトでは Python 3.12.4 を使う、と指定する
pyenv local 3.12.4

# バージョンが正しく設定されたか確認
python --version
# > Python 3.12.4

ステップ2: 仮想環境の作成と有効化

次に、pyenvで指定したPythonを使って、プロジェクト専用の仮想環境 venv を作成します。

# 仮想環境を作成
python -m venv venv

# 仮想環境を有効化
source venv/bin/activate

成功すると、ターミナルのプロンプトの先頭に (venv) と表示されます。

ステップ3: VS Codeの設定

  1. VS Code Python拡張機能のインストール (未インストールの場合)

    code --install-extension ms-python.python

  2. プロジェクトをVS Codeで開く

    code .

  3. Pythonインタプリタの選択 (最重要)

    • VS Codeが開いたら、Cmd + Shift + P (macOS) または Ctrl + Shift + P (Windows/Linux) を押してコマンドパレットを開きます。
    • Python: Select Interpreter と入力して選択します。
    • 候補一覧から、./venv/bin/python のように venv ディレクトリ内にあるインタプリタを選択します。推奨(Recommended)やスター付きで表示されることが多いです。

    これにより、VS Codeは仮想環境にインストールされたライブラリを正しく認識するようになります。

ステップ4: 動作確認

  1. VS Codeで新しいファイル hello.py を作成します。

    # hello.py
import sys

print("Hello, Python!")
print(f"実行中のPythonのパス: {sys.executable}")

  2. エディタ右上の再生ボタン、または F5 キーで実行します。

  3. ターミナルに以下のように表示され、実行パスが venv 内のものであれば成功です。

    Hello, Python!
実行中のPythonのパス: /path/to/your/project/venv/bin/python

これで、pyenvとvenvを組み合わせたクリーンな開発環境がVS Codeで整いました。

Discussion