【Python】pipenvの仮想環境をプロジェクトのフォルダの中に作る

pipenvの仮想環境をプロジェクトのフォルダの中に作りたい！

概要

今回の記事では、pipenvの仮想環境をプロジェクトのフォルダの中に作る手順を掲載する。

特にオプションを設定せずにpipenvでinstallを実行してプロジェクトを作成すると、Windowsの場合は下記のパスにプロジェクトで使う仮想環境が保存される。

C:\Users\<ユーザー名>\.virtualenvs\「<プロジェクトのフォルダ名>-<識別子的な文字列>

VSCODEでPythonのプロジェクトを管理する際に仮想環境がプロジェクトのフォルダの中にあると何かと便利。なのでオプションを設定して、プロジェクトのフォルダのルートに仮想環境用のフォルダに仮想環境が保存されるようにする。

仕様書

環境

Windows 10 Home バージョン 22H2（OSビルド 19045.2846）
Python 3.10.6
pyenv 3.1.1
pipenv, version 2023.4.20

手順書

環境変数PIPENV_VENV_IN_PROJECTにtrueを設定するとプロジェクトのフォルダのルートに.venvというフォルダが作られ、この中に仮想環境のファイルが保存されるようになる。

環境変数を設定する手順はざっくり下記のとおり。

「設定」アプリを開いて、左上の検索に「環境」と入力すると「環境変数の編集」と「システム環境変数の編集」が表示される。ユーザーの環境変数を設定するなら「環境変数の編集」、全体（ルート的な）に環境変数を設定するなら「システム環境変数の編集」を左クリックする。（どっちでもいい）
タブ「詳細設定」の中のボタン「環境変数」を左クリックする。
環境変数のダイアログが表示される。上下のリストにいろいろ表示されるが、念のために隠してる。関係ない項目を変更しちゃうとPCの動作に支障をきたすので注意。「<ユーザ名>のユーザー環境変数」の中のボタン「新規」を左クリックする。前の手順で「システム環境変数の編集」を左クリックした場合は「システム環境変数」の中のボタン「新規」を左クリックする。この記事では、ユーザーの環境変数に設定する。
「変数名」にPIPENV_VENV_IN_PROJECT、「変数値」にtrueと入力して「OK」ボタンを左クリックする。
リストの中に先程入力した内容は表示されることを確認して「Ok」ボタンを左クリックする。「システム環境変数の編集」に入力した場合は、「システム環境変数」の中のリストに表示される。
PCを再起動する。

上記の手順を実行した後にpipenvでinstallするとコマンドを実行したフォルダの中にフォルダ.venvが作られてこの中に仮想環境のファイルが保存されるようになる。例としてC:\projects\sampleがプロジェクトのフォルダだった場合はC:\projects\sample\.venvに保存されるようになる。

仮想環境の場所を確認するには下記のコマンドを実行する。

pipenv --venv

まとめ（感想文）

繰り返しなんだけども、プロジェクトのフォルダの中に仮想環境のフォルダあるとVSCODEなどで管理が楽になるのでオススメ。個人的にはデフォルトでこの設定して欲しいと思う今日この頃。