Pythonのバージョン管理をPipenvにした話。Windows10ではPipenvがベストプラクティスな気がする。

どうも、りーずです。

・Windows10でのPythonのバージョン管理はPipenvが良い
・Pipenvを使えるようにする手順
・Pipenvの使い方
・requirements.txtを作成する
・requirements.txtから仮想環境をpipenvで作る
・まとめ

このような構成でお届けします。Pipenvは良いよ!というメモです。

pip install pipenv
pipenv --python 3.7
.venv/Scripts/activate
deactivate
pipenv install django==2.2
django-admin startproject プロジェクト名
django-admin startapp アプリ名
python manage.py runserver
pipenv lock -r > requirements.txt

今回実際に使うのは上記のコマンドです。


・Windows10でのPythonのバージョン管理はPipenvが良い

Windows10環境のPythonのバージョン管理でAnacondaを使ったり、Virtualenvを使ったり、素のPythonでpipを使っていたりしたのですが、最近はPipenvがDjangoなどの開発には向いているのではないかと思うようになりました。その理由を述べていきます。

最初はWindows10でAnacondaを使おうとしたのですが、使いたいライブラリがなかなか動かせなかったり、インストールの設定でどれがベストなのかが分かりにくかったり、pipコマンドと混ぜると良くない(?)などの情報があり、使わなくなりました。
一言でいうと初心者には難しいです。

その後、Udemyや海外のYouTubeのPythonの英語の動画を見ているとよく使われているvirtualenvを使っていました。

しかしvirtualenvはPythonのバージョンを切り替えられないという欠点がありました。
(Python3.6、3.7、3.8などを切り替えられない。)

そこで色々と調べた結果、Pipenvを使うと
・Pythonのバージョンそのものも管理(切り替え)が出来る
・個々のフォルダ内で環境を作り、アクティベートするとそのまま設定したものが使える

というように、やりたいことが出来る唯一のバージョン管理ツールでした。
これには非常に利便性を感じたので、Djangoなどのアプリケーションを作ったり、ちょっとしたプログラミングをするにはPipenvでいいかな、という結論になりました。

僕はAnacondaとの共存は諦め、とりあえずPipenvのみでやっていこうと思いました。

これらのツイートで貼っているリンクが参考にしたものです。


・Pipenvを使えるようにする手順

まず、使いたいPythonは、公式からダウンロードしてインストールしておきます。(重要)

Python3.8を使いたければそれをダウンロードしてインストール、Python3.7を使いたければそれをダウンロードしてインストール、という感じです。

Pythonのインストール先ですが、

C:\Python
というフォルダを作り、そこに

Python3.6.7の64ビット版は
C:\Python\Python367

Python3.8.5の32ビット版は
C:\Python\Python385-32

という感じに数字を割り振り、分かりやすいように名前をつけてインストールしていくと良いです。
Program Filesフォルダにインストールすると、空白でエラーになるような事があったので、気をつけましょう。

僕は、インストーラーでパスは通してインストールしました。

「パスが通っている/パスを通す」という日本語は、「Windows10のシステム環境変数のPathという変数に、設定がされているという意味です。これをすることにより、ターミナル上で、プログラム名を入れるだけでプログラムを実行することが出来るようになります。「python」というコマンドが動くのも、「パソコン上のどこにあるpython.exeを動かすかが指定されているから」です。)

パスを通すと、『環境変数で一番上に来ているPythonのバージョン』がターミナル(コマンドプロンプト)のデフォルトになります。以下のようなイメージ。

3つのPythonをパスを通してインストールしている図。 この場合、実際にターミナル(コマンドプロンプト)で動くのは一番上のPython 3.85の32bit版になる。

もし、Windows10のターミナルコマンドで使いたいデフォルトのPythonのバージョンを変えたい場合は、システム環境変数の設定でそのバージョンを一番上に持ってくればOKです。
2行でセットなので、2行とも上に持っていきましょう。

ちなみに上の図で「使われない」と書かれているPythonも、以下のPipenvによって、仮想環境で使えるようになります。

・Pipenv(バージョン管理ツール)のインストール

さて、次はPipenvを入れなければいけません。

そして、これに限ってはPythonのどれかのバージョンに直接pipコマンドで入れる必要があります。
pipコマンドは
pip install ライブラリ名
で、PythonのライブラリをインストールできるPython公式のコマンドです。
ライブラリの管理に使います。

Pipenv(これもライブラリです)を入れるPythonのバージョンは、インストールしているPythonの最新のバージョンで良いと思います。

Pythonを入れているフォルダには「Scripts」という名前のフォルダがあり、どんなライブラリが入っているかを確認することが出来ます。

僕の場合は
Python3.8.5の32ビット版にPipenvを入れました。

まぁどれに入れても大丈夫だと思います。
現在pythonコマンドのパスが通っているものにしましょう。

では、実際にPipenvを入れてみましょう。まずはどのバージョンのPythonがターミナルで動いているか確認しましょう。

python --version

ここのPythonにPipenvを入れるので、バージョンは一応覚えておきましょう。
そうしたら、ターミナルで

pip install pipenv

と打ち、Pipenvをインストールします。現在パスを通しているPythonのバージョンのScriptsフォルダにインストールされます。

・システム環境変数を設定する
次に、環境変数の設定です。ここがポイントです。

『プロジェクトのフォルダ直下にPipenvの仮想環境が作られてほしい』ので、
新たに環境変数を設定します。

例えばプロジェクトのフォルダごと消去すれば、仮想環境ごと消せますし、プロジェクトフォルダに入ってターミナルでアクティベートコマンド(.venv/Scripts/activate)を実行するだけで、そのプロジェクトに設定した環境がすぐ立ち上がるようになります。

まずは、Windows10の左下の検索窓に『環境変数』と打ち込み、『システム環境変数の編集』画面を出しましょう。以下のようにして下さい。

Windows10の左下の検索窓に『環境変数』と打ち込む。

そうしたら、出てきた、『システム環境変数の編集』をクリックします。

※「環境変数を編集」をクリックすると「システム環境変数の編集」がグレーアウトするので注意。選ぶのは「システム環境変数の編集」です。

すると「システムのプロパティ」画面が出てきて
「環境変数」とクリックできる画面が出ます。そこで「環境変数」をクリック。

以下のように環境変数を編集する画面が出るはずです。

Windows10の環境変数(『システム環境変数』のほう)に「PIPENV_VENV_IN_PROJECT」という項目を作り、「true」という値を入れます。

以下の画像のようにします。

「システム環境変数」のなかに変数「PIPENV_VENV_IN_PROJECT」を作り、値を「true」にする

「システム環境変数」の「新規」で追加しましょう。

変数:PIPENV_VENV_IN_PROJECT
値:true

これにより、pipenvコマンドを使うとその各フォルダのルート直下に仮想環境が構築出来るようになります。

そうしたらパソコンを再起動しましょう。環境変数を反映させるためです。

・Pipenvの使い方

Pipenvの実際の使い方を説明します。
まず、仮想環境を作りたいフォルダ(プロジェクトフォルダ)を作ります。

そうしたらターミナルでその場所に移動し、そこで

pipenv --python 3.7

のように打ちます。(これは例なのでpython 3.8でも何でも良いです。)

こうするとその場所に仮想環境がPython3.7で構築されます。
(指定する「Python3.7」は手動であらかじめインストールされている必要があります。)

次に、

.venv/Scripts/activate

と打つと、アクティベートされます。

deactivate

で、ディアクティベートされます。

あとは自由に、djangoなどのライブラリを追加でインストールしていきましょう。
インストールする場合は必ず

pipenv install django==2.2

このように「pipenv install」とすることに気をつけましょう。
通常の「pip install」だと、おそらく仮想環境ではなく「今パスの通っているPythonの本体」にインストールされてしまいます。

また、仮想環境を消したい場合は「pipenv install」で作成されたファイルとフォルダを削除するだけでOKです。

.venv
Pipfile
Pipfile.lock

この1つのフォルダ(.venv)と2つのファイル(Pipfile、Pipfile.lock)です。

以上でPipenvの簡単な説明でした。

仮想環境を、Pythonのバージョンを指定して作成出来て、
それぞれのフォルダで仮想環境を作成&立ち上げられることが便利ですね。

使うときにはアクティベートのコマンド(.venv/Scripts/activate)を打つだけなので、どのPythonのバージョンで作ったかを覚えておく必要もありません。

アクティベート後にPythonのバージョンを確認したい場合は

python --version

で確認出来ます。
アクティベート後は普通のpythonコマンドで、その仮想環境のPythonが実行されるようになります。

ちなみに、djangoをインストールしたあとは
django-admin startproject プロジェクト名

のようにしてプロジェクトを作り
その中に入って
django-admin startapp アプリ名
でアプリを作り、
そのあとに
python manage.py runserver

としてから
http://localhost:8000/
(ローカルのサーバー。実行時に3000か8000か表示されるはず)
にアクセスしましょう。

参考:
「PipenvでDjango開発環境をつくる」
https://qiita.com/nochifuchi/items/4fe0164f0d8949cf11b7

・requirements.txtを作成する

requirements.txtを作成するには、
コマンドライン(ターミナル)で、

pipenv lock -r > requirements.txt

を実行します。

参考:「Pipenvことはじめ」
https://qiita.com/shinshin86/items/e11c1124e3e2e74556b8#requirementstxt%E3%81%AB%E6%9B%B8%E3%81%8D%E5%87%BA%E3%81%99

・requirements.txtから仮想環境をpipenvで作る

パターン1:Pythonのバージョンを指定したい場合

仮想環境のPythonのバージョンを指定したい場合は

最初に
pipenv --python 3.7(指定したいバージョン)
として、一番最初にPythonのバージョンを指定して仮想環境を作っておきます。
そして
.venv/Scripts/activate
で仮想環境に入り、
そのあとに requirements.txtのあるフォルダで
pipenv install
をします。そうするとそのPythonのバージョンとrequirements.txtの指定で環境が作られます。

パターン2:仮想環境のPythonのバージョンはpipenvのpythonで良い場合

Pythonのバージョンが、pipenvを入れてあるPythonのバージョンで良いのであれば、
requirements.txtから仮想環境をpipenvで作るには、そのディレクトリでそのまま

pipenv install

を実行すれば完了です。

一応「パターン1」のほうで明示的にPythonのバージョンを指定して作ったほうが良いとは思います。

参考:「requirements.txtからのインポート」
https://pipenv-ja.readthedocs.io/ja/translate-ja/basics.html#importing-from-requirements-txt


・まとめ

まとめです。
pipenv --python 3.7
で仮想環境を作成。
指定するPythonのバージョンはインストールされている必要がある。

仮想環境を作成したら
.venv/Scripts/activate
でアクティベート。
抜けるときは
deactivate
でディアクティベート。

あとは仮想環境に
pipenv install django==2.2
のようにして入れたいライブラリを入れていく。

djangoの場合はライブラリを入れたあとに
django-admin startproject プロジェクト名
このようにライブラリが用意したコマンドを打って、実際のコードを自動生成させていく。

もしプロジェクトが要らなくなったらそのフォルダごと削除すればOK。


Pipenvについて、より詳しくは、

「Windows + Python + pipenv でらくらく開発環境構築」
https://qrunch.net/@toyocy/entries/Y2wBhjSWunnK0CPI

「Pipenvを使ったPython開発まとめ」
https://qiita.com/y-tsutsu/items/54c10e0b2c6b565c887a

これらの2つの記事が詳しいので参考にしてみて下さい。


おまけ

pipenvコマンドを使うと、

pipenv : Courtesy Notice: Pipenv found itself running within a virtual environment,
so it will automatically use that environment, instead of creating its own for any p
roject. You can set PIPENV_IGNORE_VIRTUALENVS=1 to force pipenv to ignore that envir
onment and create its own instead. You can set PIPENV_VERBOSITY=-1 to suppress this
warning.

という文が出ることがありました。そこで環境変数に
PIPENV_IGNORE_VIRTUALENVS=1
を追加すると
python manage.py runserver
コマンドでdjangoを動かしたときにサーバーが停止出来なくなる挙動が出ました。
なので、現在はこの環境変数は設定していません。

参考:「pipenv で任意の場所の仮想環境を使う」
https://qiita.com/tonluqclml/items/cd0d2a2cb0197cbaee42