pip

使い方

pip <command> [options]

説明

ロギング

コンソールロギング

pipはコンソールログレベルを制御する -v, --verbose、と -q, --quiet を提供します。

ファイルロギング

pipは冗長ログを最大限に保存するファイルを指定するための --log オプションを提供します。このオプションはデフォルトでは空です。このログは以前のログに追加されます。

すべてのpipオプションと同様に、--log は環境変数として設定することも、pip設定ファイルに配置することもできます。コンフィグレーション セクションを参照してください。

--exists-actionオプション

このオプションは、パスがすでに存在する場合のデフォルトの動作を指定します。可能な場合:ファイルをダウンロードするか、インストール用のリポジトリをチェックアウトしてアーカイブを作成します。--exists-action が定義されていない場合、pipは決定が必要なときにプロンプトを表示します。

(s)witch

VCS(バージョン管理システム)のチェックアウトにのみ関連します。チェックアウトを適切なURLまたはリビジョンに切り替えようとしています。

(i)gnore

現在の操作を中止する(例:ファイルをコピーしない、アーカイブを作成しない、チェックアウトを変更しない)

(w)ipe

新しいファイルを作成、ダウンロード、またはチェックアウトする前に、ファイルまたはVCS(バージョン管理システム)のチェックアウトを削除してください。

(b)ackup

ファイルまたはチェックアウトを {name}{'.bak' * n} に変更します。nは、ファイルはある時点に存在しないような .bak 拡張子の数です。したがって、最新のバックアップは .bak の後で最大の番号になります。

(a)abort

pipを中止し、ゼロ以外の終了ステータスを返します。

ビルドシステムインターフェイス

Pipはビルドシステムを起動してパッケージをビルドします。現在、唯一サポートされているビルドシステムは setuptools ですが、Pythonパッケージのインフラの今後の開発には、他のビルドシステムのサポートが含まれる予定です。パッケージビルドと同様に、ビルドシステムはソースから直接パッケージをインストールするときも呼び出されます。

ビルドシステムへのインターフェイスは、setup.py コマンドラインスクリプトを介して行われます。すべてのビルドアクションは、必要なアクションを呼び出すために実行される特定の setup.py コマンドラインによって定義されます。

Setuptoolsインジェクション

上記のように、サポートされているビルドシステムは setuptools です。ただし、すべてのパッケージがビルドスクリプトで setuptools を使用するわけではありません。"pure distutils" を使用するプロジェクトをサポートするため、pipは setup.py を呼び出す前に setuptoolssys.modules に注入(インジェクション)します。インジェクションは distutils ベースのプロジェクトに対して透過的でなければなりませんが、pipが必要なコマンドをエミュレートする setup.py を提供したいサードパーティ製のビルドツールは、インジェクションを実行することを意識する必要があります。

今後の展開

PEP426 notes that the intention is to add hooks to project metadata in version 2.1 of the metadata spec, to explicitly define how to build a project from its source. Once this version of the metadata spec is final, pip will migrate to using that interface. At that point, the setup.py interface documented here will be retained solely for legacy purposes, until projects have migrated.

Specifically, applications should not expect to rely on there being any form of backward compatibility guarantees around the setup.py interface.

ビルドオプション

pip installpip wheel--global-option 引数と --build-option 引数は、setup.py` コマンドに追加引数を挿入します。(--build-optionpip wheel でのみ使用できます)これらの引数は、次のようにコマンドに含まれています。:

python setup.py <global_options> BUILD COMMAND <build_options>

オプションは変更されずに渡され、現在はdistutilsのコマンドラインに直接アクセスできます。--global-option--build-option` の使用は、ビルドシステムに依存している必要があります。pipに別のビルドシステムのサポートが追加されていれば、現在の形式ではサポートされていない可能性があります。

一般オプション

-h, --help

Show help.

--isolated

Run pip in an isolated mode, ignoring environment variables and user configuration.

-v, --verbose

Give more output. Option is additive, and can be used up to 3 times.

-V, --version

Show version and exit.

-q, --quiet

Give less output. Option is additive, and can be used up to 3 times (corresponding to WARNING, ERROR, and CRITICAL logging levels).

--log <path>

Path to a verbose appending log.

--proxy <proxy>

Specify a proxy in the form [user:passwd@]proxy.server:port.

--retries <retries>

Maximum number of retries each connection should attempt (default 5 times).

--timeout <sec>

Set the socket timeout (default 15 seconds).

--exists-action <action>

Default action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup, (a)bort.

--trusted-host <hostname>

Mark this host as trusted, even though it does not have valid or any HTTPS.

--cert <path>

Path to alternate CA bundle.

--client-cert <path>

Path to SSL client certificate, a single file containing the private key and the certificate in PEM format.

--cache-dir <dir>

Store the cache data in <dir>.

--no-cache-dir

Disable the cache.

--disable-pip-version-check

Don't periodically check PyPI to determine whether a new version of pip is available for download. Implied with --no-index.