pip listの使い方。おすすめ利用法も紹介

2024年10月31日

こんにちは、デジタルボーイです。Pythonのパッケージ管理で、pip listは個人的にはかなりよく使っているので、備忘録がてら、説明したいと思います。

記事を書いた人

デジタルボーイです。
データサイエンス歴20年以上のおっさんです。中小企業診断士として、データサイエンス、WEBマーケティング、SEOに関するデータ分析、コンサルティングの仕事をしています。自己紹介の詳細はコチラ

お時間のない人のための、結論！！

Python環境の全てのパッケージを確認したい場合、pip listのコマンドで実行できます。

% pip list

環境設定

OS: macOS
Python: 3.10

pip list

pip listの便利な利用法：
個人的にはpip showの代替として、pip listを使う場合がよくあります。pip showはパッケージによっては出力が多いため、仮想環境などでインストールしているパッケージが限られいるのであれば、pip listの方が出力はシンプルでみやすいです。　

pip listは、現在のPython環境にインストールされている、すべてのパッケージとそのバージョンを、ターミナル上で確認しやすいフォーマットで表示します。

使い方

% pip list

出力例

Package    Version
---------- -------
numpy      1.21.0
pandas     1.3.0
pip        21.1.3
setuptools 57.0.0

僕個人の使用用途

僕は個人的には、仮想環境の中のパッケージ一覧を表示させたり、あと、パッケージのバージョンを確認したい時にも利用します。まあ、バージョン確認では本来はpip show <パッケージ名>を使うべきなんでしょうが、結構、アウトプットが膨大な場合があるので、pip listの方をよく使いますね。

pip listのオプション

pip listには結構オプションがあります。僕の個人的な利用頻度を★（１〜３）で表していますので、見て見てください。

1. –outdated

利用頻度：★★★

最新版が利用可能な古いパッケージのみを表示します。仮想環境での開発では、かなり頻繁に使っています。

使用例:

pip list --outdated

出力例:

Package    Version Latest Type
---------- ------- ------ -----
numpy      1.21.0  1.22.0 wheel
pandas     1.3.0   1.4.0  wheel

2. –uptodate

利用頻度：★

最新のバージョンがインストールされているパッケージを表示します。まあ、–outdatedを使うのであれば、いらんかも

使用例:

pip list --uptodate

3. –format

利用頻度：★

出力形式を指定します。オプションには columns（デフォルト）、freeze、json があるらしい。今回調べてはじめてしった。使ったことなし。

使用例:

pip list --format=json

4. –not-required

利用頻度：★★★

他のパッケージの依存関係として必要とされていないパッケージを表示します。僕は、依存関係でエラーとなった時は、確認のため、一番初めに使います。

使用例:

pip list --not-required

5. –user

利用頻度：★

当該ユーザーでインストールされたパッケージのみを表示するらしい。僕は、同じマシンを複数ユーザーで使っていないので、不要なだけですが。

使用例:

pip list --user

6. –local

利用頻度：★

グローバルにインストールされたパッケージは除外した、パッケージのみを表示するらしい。仮想環境の中でpip listする僕はほぼ使わない。

使用例:

pip list --local

7. –exclude

利用頻度：★

指定したパッケージを出力から除外するらしい。僕は使わない。

使用例:

pip list --exclude numpy,pandas

8. –include-editable

利用頻度：★

開発モードでインストールされたパッケージ編集可能なパッケージのみを含めるらしい。僕はこれを知らなかったし、まず、使わない。

使用例:

pip list --include-editable

9. –verbose (-v)

利用頻度：★★

詳細な情報を表示します。今回調べてはじめて知ったが、インストール場所をリストで出すのはちょっと面白いかも。依存関係でインストールエラーとなった場合、インストール場所はpip showで見ますが出力が多すぎて、よくわからない時があります。一覧で、インストール場所を見たい場合には、とても使えるのでは？

使用例:

pip list --verbose

出力例:

Package    Version  Location                            Installer
---------- -------- ----------------------------------- ----------
numpy      1.21.0   /usr/local/lib/python3.8/site-packages pip
pandas     1.3.0    /usr/local/lib/python3.8/site-packages pip

まとめ

以上が、pip ilstの簡単な使用例でした！