pip install -rにて指定したファイルに記載されている【-e .】

Question

尋ねたいこと

pip install -rにて指定している、インストールパッケージ対象ファイルに【-e .】という以下記載がありました。
本内容にはどういった意味があるのでしょうか。

コマンド

-e .
##以下インストール対象パッケージ
XXXXX
XXXXX

Answer 1

前置きとして

pip installコマンドでパッケージをインストールする際に、-rを使うと続けて指定したファイルの中身をみてインストール対象を解決します。
この中身の各行は、単純にパッケージ名を指定するだけでなく、再帰的にpip installのオプションを指定することができます。

例えば、テンプレートエンジンであるJinjaのGitHubリポジトリを見ると、requirementsフォルダ内のdev.inの中で-r docs.inを指定していく様子が見て取れます。

質問そのものについて

-e .の意味はは、「このフォルダをPythonパッケージとみなして、editable modeでのインストールをする」というものです。

editable modeとは

通常Pythonのパッケージはpip installを行うと、pipコマンド実行時点で参照しているライブラリフォルダに対してファイルのインストールを行います。
これは、pip install .といったローカルフォルダを指定していても例外ではありません。

ここで-e .のようにローカルのフォルダに対してeditable modeでのインストールを実行すると、ライブラリフォルダへのファイルインストールをする代わりに参照情報の設定だけを行うようになります。

挙動の違いとしては、そのフォルダで.pyファイルなどを編集すると即時で変更が反映されるような感じになります。
そのため、ローカルでのパッケージ・ライブラリの開発などに向いています。

※説明の参考例

Comments

[mintia123]

とても分かりやすいご回答をありがとうございます。