pipの使い方

こちらでは、 pipコマンドについて解説していきます。

pipコマンドはpythonのパッケージをインストールするために使用するコマンドです。

Pythonには大まかに分けて2系と3系があります。 2系におけるパッケージの管理はpip2を、3系にはpip3を使用します。

pipのインストール

pip3のインストールには、以下のコマンドを実行します。

> sudo apt update
> sudo apt install -y python3-pip

pipのバージョン確認

-Vオプションでpip3自体のバージョンが確認できます。

> pip3 -V

(実行結果)

> pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.5)

パッケージのインストール

パッケージのインストールには、 pip3 installコマンドを使います。 pip3 installの後にパッケージ名を入力し実行することでインストールできます。

> pip3 install パッケージ名

パッケージのアップグレード

パッケージを最新版にアップグレードするには、 --upgradeオプションを使います。 pip3 install --upgrade の後にパッケージ名を入力し実行することでアップグレードできます。

> pip3 install --upgrade パッケージ名

---短縮形---
> pip3 install -U パッケージ名

pip自体のアップグレード

パッケージ名にpipを指定することで、pip自体をアップグレードできます。

> pip3 install --upgrade pip

パッケージが最新版かどうかの確認

最新版かの確認のは pip3 listコマンド と --outdatedオプションを使用します。 最新版でないパッケージが一覧で表示され、インストール済みのバージョンと最新バージョンを確認できます。

> pip3 list --outdated

バージョンを指定してインストール

パッケージ名の後に == とつけてその後にバージョンを記入することで、バージョンを指定してインストールすることができます。

> pip3 install パッケージ名==バージョン

• 最新バージョンが不安定な時
• 特定のバージョンでないと動作しない時 などに利用します。

インストール済みのバージョン以前の数値を指定すれば、ダウングレードをすることも可能です。

インストール可能であるバージョンの確認

インストール可能なバージョンは、以下のコマンドで確認できます。

> pip3 install パッケージ名==

パッケージのアンインストール

パッケージをアンインストールしたいときは、 pip3 uninstallコマンドを使用します。 pip3 uninstall の後にパッケージ名を入力し実行することでアンインストールできます。

> pip3 uninstall パッケージ名

インストール済みのパッケージの確認

インストール済みのパッケージを確認するには、pip3 list もしくは pip3 freezeを使用します。

freezeは、別の環境にパッケージを移したい場合、バックアップを取りたい場合に活用することが一般的です。 一方でlistはpipなど、他の環境に移す必要がないパッケージも表示されます。

list

インストール済みのパッケージを確認するにはpip3 list を実行します。 既にインストールされているパッケージとバージョンを確認することができます。

> pip3 list 

結果

> cryptography (1.7.1)
> idna (2.2)
> keyring (10.1)
> keyrings.alt (1.3)
> pip (9.0.1)
> pyasn1 (0.1.9)
> pycrypto (2.6.1)
> pygobject (3.22.0)
> pyxdg (0.25)
> SecretStorage (2.3.1)
> setuptools (33.1.1)
> six (1.10.0)
> wheel (0.29.0)

freeze

pip3 freezeでもパッケージとバージョンを確認できます。 パッケージ名==バージョンの形式になっており、textファイルなどに保存しておくとコマンド一つでインストールすることができます。(後述)

> pip3 freeze

結果

> cryptography==1.7.1
> idna==2.2
> keyring==10.1
> keyrings.alt==1.3
> pyasn1==0.1.9
> pycrypto==2.6.1
> pygobject==3.22.0
> pyxdg==0.25
> SecretStorage==2.3.1
> six==1.10.0

freezeを使って現在のバージョンのバックアップを取っておく方法

• 別の環境に同じバージョンのパッケージ一式をインストールしたい場合
• ある時点のパッケージとバージョンをバックアップしておきたい場合

には、先ほど紹介したfreeze コマンドが便利です。

実行すると今インストールしているパッケージとバージョンが出力されるので、その内容をテキストファイルに保存することでバックアップを作成します。

保存しておくテキストファイルの名前は、 requirements.txt を使用するのが一般的です。

pip3 freeze > requirements.txt

# requirements.txt の中身
alembic==1.7.5
app==0.0.1
bcrypt==3.2.0
captcha==0.3
certifi==2021.10.8
cffi==1.15.0
charset-normalizer==2.0.9

・・・・・・

バックアップを復元するにはpip3 install の後に -r と requirements.txt を入力し実行します。

> pip3 install -r requirements.txt

このようにバックアップを作成しておくことで、簡単にバックアップ時点のパッケージがインストールされた状態に戻すことができます。

パッケージの中には、他のパッケージの特定のバージョンのみに対応している物もあります。 パッケージをアップグレードしたときに、正常に動作しなくなってしまうことも。 対策として、アップグレード前に現在バージョンのバックアップを取っておくと安心です。

バージョンの控えは開発をする時や、githubやアプリケーションを公開するときに必ず利用するので、よく理解しておきましょう。

インストールできない場合のトラブルシューティング

pipがエラーになる場合、以下を確認してみてください。

インターネットが繋がっているか

pipはネット経由でリポジトリからパッケージをダウンロードしています。 ネットが繋がっていない場合、ダウンロードができずエラーとなります。

アクセスが許可されているか

セキュリティ設定などにより、リポジトリへのアクセスが制限されている場合も、ネットが繋がっていないケース同様、エラーとなります。

pipが最新になっているか

pipのバージョンが、インストールしようとしているパッケージに対応していない場合もエラーとなります。 最新にアップグレードした上で、再度インストールを行ってみてください。

まとめ

今回は pipコマンドの使い方について解説しました。

> pip3 install パッケージ名

パッケージをインストールしたりバージョンの管理をする際に必ず使用するので、簡単な使い方だけでも覚えておきましょう。