まえがき
最近久々に Python を触ってみました。
Python といえばバージョン管理を考えるのが厄介だなという印象でした。
なにぶん macos ではデフォルトで Python2 が入っているので、Python3 を使うにはバージョン管理ソフトが必須となります。 バージョン管理のツールだと pyenv やら virtualenv やら入り乱れていて、何がデファクトスタンダードだかよくわからないのが実情だったと思います。
今回あらためて Python を書くにあたり調べたところ、どうやら pipenv がもっとも有力なバージョン管理であり、さらにパッケージの管理までしてしてくれるとのことで便利そうだなと思い使ってみました。
結論としては、 pipenv はバージョン管理+パッケージ管理ができる素晴らしいツールですが、ややデメリットもあるかなというところです。
導入(mac)
README には書かれていないですが普通に brew で install できます。
brew install pipenv
Python のディレクトリで以下を実施して仮想環境を初期化します。このとき Python のバージョンを指定して、そのバージョンで初期化することができます。
pipenv --Python 3.8
またこのときデフォルトではグローバルな場所に環境が構築されますが、環境変数を設定することでローカルな環境( .venv 配下)に構築することが可能です。
VSCode では .venv に Python 環境があった方がインタプリターを指定しやすいので、なるべく設定した方が良いと思われ。
初期化すると以下のように Pipfile が生成されます。Pipfile が npm でいう package.json に当たるファイルのようです。
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
[dev-packages]
[requires]
python_version = "3.8"
何やら npm と同じような雰囲気を感じますね。
pipenv 環境に入るには
pipenv shell を用います。その後、pipenv 環境で python コマンドなどが使えるようになります。
ちょっとした動作確認など npm でいう npx と同じような目的で使われる機能ですね。
$ pipenv shell
Launching subshell in virtual environment...
. /Users/mineo/.local/share/virtualenvs/test-wjEkysQk/bin/activate
$ python app.py
パッケージ管理
package を追加
pipenv install numpy
Installing numpy...
Adding numpy to Pipfile's [packages]...
✔ Installation Succeeded
Pipfile.lock not found, creating...
Locking [dev-packages] dependencies...
Locking [packages] dependencies...
Building requirements...
Resolving dependencies...
✔ Success!
Updated Pipfile.lock (456e4b)!
Installing dependencies from Pipfile.lock (456e4b)...
🐍 ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 0/0 — 00:00:00
To activate this project's virtualenv, run pipenv shell.
Alternatively, run a command inside the virtualenv with pipenv run.
Pipfile が以下のようになり numpy が追加されました。また、 Pipfile.lock が生成されます。 npm でいう package-lock.json に当たるファイルのようです。
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
numpy = "*"
[dev-packages]
[requires]
python_version = "3.8"
また、dev で install する場合は --dev をつけるようです
package を削除
pipenv uninstall numpy
Installing numpy...
Adding numpy to Pipfile's [packages]...
✔ Installation Succeeded
Pipfile.lock not found, creating...
Locking [dev-packages] dependencies...
Locking [packages] dependencies...
Building requirements...
Resolving dependencies...
✔ Success!
Updated Pipfile.lock (456e4b)!
Installing dependencies from Pipfile.lock (456e4b)...
🐍 ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 0/0 — 00:00:00
To activate this project's virtualenv, run pipenv shell.
Alternatively, run a command inside the virtualenv with pipenv run.
requirements.txt に出力
何かと必要な requirements.txt に package を出力することもできます。
https://pipenv-ja.readthedocs.io/ja/translate-ja/advanced.html#generating-a-requirements-txt
pipenv lock -r > requirements.txt
Pipfile から環境構築
pipenv の仮想環境が構築され、Pipfile の package がまとめて install されます。
pipenv install
dev も含めて install
pipenv install --dev
構築した環境を削除
以下で install した package や Python の仮想環境などを全て削除します。
pipenv --rm
npm だと node_modules を手動で消さないといけないので、この点は npm より使い勝手が良いですね。
scripts
pipenv でも npm のように任意の scripts を設定することができます。
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[scripts]
start = "python app.py"
[packages]
numpy = "*"
[dev-packages]
[requires]
python_version = "3.8"
pipenv run start
ただし、ここで気をつけないといけないのは script をで使えない文字列があることです。例えば、以下のように requirements.txt に出力する scripts を設定した場合、残念な結果になります。
[scripts]
exportPackage = "pipenv lock -r > requirements.txt"
$ pipenv run exportPackage
Usage: pipenv lock [OPTIONS]
Try 'pipenv lock -h' for help.
Error: Got unexpected extra arguments (> requirements.txt)
また、 && も使えないため複数の script を組み合わせることもできません。私的にはこれが一番残念な点でした。
issue で議論されていましたが、どうも pipenv では Pipfile ではなく invoke というタスクランナーを使って解決するべきという結論のようです。
https://github.com/pypa/pipenv/issues/2038#issuecomment-505493265
おわりに
scripts で && が使えないなど少し残念な点はありましたが、バージョン管理を含めた環境構築ができるので、Pipenv はチーム開発に適したツールだと思います。全体的な使い勝手も npm に近く直感的にわかりやすいです。