🐥

[備忘録] - macのVSCodeで作成したpythonのvenv環境が利用できるインタプリタ一覧に出てこなかった時の設定方法

2023/08/21に公開

環境と背景

Macbook M2でHomebrewを使ってPythonをインストール。
その後、任意のフォルダにvenvで仮想環境を作成。
しかし、VSCodeのインタプリタ選択のリストに作成したvenv環境が出てこない。

このインタプリタ選択のリストに作成したvenv環境を表示させる方法をメモしておく。

※ 赤丸の場所をクリックすると、上に「インタープリターの選択」が出てくる。

設定方法

settings.jsonファイルに以下を書き込む。

// Folders in your home directory to look into for virtual environments.
  "python.venvFolders": [
    "<環境のあるフォルダ>"
  ]

前提条件

  • VSCodeでMicrosoftのPython拡張機能
    「Python extension for Visual Studio Code」
    をインストールしている。

  • Pythonのソースコード(xxx.py など)を開いている。

手順

1.「setting.json」ファイルを開く

  • 「Command⌘」+「Shift⇧」+「P」を押してコマンドパレットを開く。
  • 「settings.json」と入力して「基本設定:ユーザー設定を開く(Preference : Open User Settings)」を開く

2.venv環境を作成したフォルダを書き込む

以下を書き込む。
「<環境のあるフォルダ>」は、ホームディレクトリをルートとして記載する。

  "python.venvFolders": [
    "<環境のあるフォルダ>"
  ]

<記載例>
ユーザーが suzuki で、venv環境を /Users/suzuki/.pyenv/py_venv_01 に用意している場合。

  "python.venvFolders": [
    ".pyenv"
  ]

このように記載すると、 /Users/suzuki/.pyenv 以下にあるvenv環境を自動的に認識してくれる。
ホームディリクトリ /Users/suzuki 以下ではない任意の場所に用意したvenv環境を指定する方法は試していません。
(ここに絶対パスで指定するとできるかもしれません)

既に他の設定が settings.json に記載されている場合

既に書かれている項目の最後に「, (カンマ)」を入力して、追加する。

{
  "<既存の設定項目>" : <既存の設定項目の値> ,

  "python.venvFolders": [
    "<環境のあるフォルダ>"
  ]
}

複数記載する場合はカンマで繋げて記載する。

  "python.venvFolders": [
    "<環境のあるフォルダ1>",
    "<環境のあるフォルダ2>",
    "<環境のあるフォルダ3>"
  ]

最後にはカンマがないことに注意。

記載して保存したら設定したvenv環境がリストに出てくる。

以上。

情報元

こちらに書かれていることを実践しました。
ありがとうございます。

https://tekunabe.hatenablog.jp/entry/2018/12/28/vscode_venv_default_rolad

Discussion