Pipenv 環境を構成する
Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介して自動的にプロジェクトパッケージが管理されます。
Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要である場合、セキュリティに敏感なデプロイにとって特に役立つ可能性があります。Pipenv の詳細については、pipenv.pypa.io(英語) にあるプロジェクトのドキュメントを参照してください。
PyCharm で Pipenv を使用するには、いくつかの準備手順を実装する必要があります。
Pipenv をインストールする
次のコマンドを実行して、pip がシステムにインストールされていることを確認します。
$ pip --versionpip バージョンを示すシステム応答を受け取ることを期待するべきです。pip が見つからない場合は、インストール手順(英語)の説明に従ってインストールしてください。あるいは、http://python.org(英語) から Python をダウンロードしてインストールすることもできます。
次のコマンドを実行して
pipenvをインストールします。$ pip install --user pipenvインストールが完了すると、次のメッセージが表示されます。
便宜上、ユーザーベースのバイナリディレクトリを
PATH環境変数に追加できます。この手順をスキップすると、pipenv 環境を追加するときに、pipenv 実行可能ファイルへのパスを指定するように PyCharm から求められます。次のコマンドを実行します。
$ py -m site --user-site出力例は次のとおりです。
C:\Users\jetbrains\AppData\Roaming\Python\Python37\site-packages
このパスの
site-packagesをScriptsに置き換えて、PATH変数に追加する文字列を受け取ります。たとえば、次のようになります。$ setx PATH "%PATH%;C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts"
次のコマンドを実行して、ユーザーベースのバイナリディレクトリを探します。
$ python -m site --user-base出力の例は次のとおりです
/Users/jetbrains/.local (macOS) または /home/jetbrains/.local (Linux)
このパスに bin を追加して、~/.bashrc ファイルに追加する文字列を受け取ります。例:
$ export PATH="$PATH:/Users/jetbrains/.local/bin"次のコマンドを実行して、変更を有効にします。
$ source ~/.bashrcbash_profile で bashrc を有効にしたことを確認してください。
プロジェクト設定でいつでも、pipenv 実行可能ファイルへの指定されたパスを変更できます。設定ダイアログ (Ctrl+Alt+S) で、に移動し、Pipenv 実行可能ファイルのパスフィールドにターゲットパスを入力します。
準備が完了したら、pipenv を使用して新規プロジェクトまたは既存プロジェクトの仮想環境を作成できます。
また、以前に作成したプロジェクトに対して pipenv を設定することもできます。
既存の Python プロジェクト用に pipenv を設定する
以下のいずれか 1 つを実行します:
Python インタープリターセレクターをクリックして、新しいインタープリターを追加を選択します。
Ctrl+Alt+S を押して設定を開き、に移動します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
Python インタープリターセレクターをクリックしてインタープリターの設定を選択します。利用可能なインタープリターのリストの横にあるインタープリターの追加リンクをクリックします。
ローカルインタープリターを追加するを選択します。
Python インタープリターの追加ダイアログの左側のペインで Pipenv 環境を選択します。
リストから基本インタープリターを選択するか、
をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。プロジェクトに Pipfile が含まれている場合は、Pipfile からパッケージをインストールするチェックボックスを有効または無効にすることで、プロジェクトにリストされているパッケージをインストールするかどうかを選択できます。デフォルトでは、チェックボックスは有効になっています。
ベースバイナリディレクトリを
PATH環境変数に追加した場合、追加のオプションを設定する必要はありません。pipenv 実行可能ファイルへのパスは自動検出されます。Pipenv 実行可能ファイルが見つからない場合は、pipenv インストール手順に従って実行可能ファイルのパスを見つけ、ダイアログでそれを指定します。
タスクを完了するには、OK をクリックします。
Pipenv 仮想環境を Python インタープリターとして設定すると、利用可能なすべてのパッケージが Pipfile で定義されたソースから追加されます。パッケージのインストール、削除、パッケージのリスト内の更新は、pip ではなく Pipenv を介して行われます。
PyCharm は、Pipfile に記録されたプロジェクト要件に基づいて、プロジェクトの Pipenv 環境を作成できます。
Pipfile を使用して環境を作成する
Pipfile を含むプロジェクトを開いたものの、プロジェクトインタープリターが構成されていない場合、PyCharm は Pipenv 環境を作成することを提案します。
PyCharm に Pipenv を自動的に構成させたい場合は、Pipfile を使用して Pipenv 環境を作成するをクリックします。または、「Python インタープリターを構成する」をクリックして標準ワークフローに従うこともできます。
PyCharm が Pipenv 実行可能ファイルを自動検出できない場合は、その実行可能ファイルへのパスを指定して、「OK」をクリックします。
新しい Pipenv 環境がプロジェクト用に構成され、Pipfile にリストされているパッケージがインストールされます。
構成済みの Python インタープリター（ただし Docker ベース）の場合、次のことができます。
関連ページ：
Pipfile を使用する
Pipfile は、Pipenv 仮想環境がプロジェクトの依存関係を管理するために使用する専用ファイルです。このファイルは、Pipenv を使用するために不可欠です。新規または既存のプロジェクト用に Pipenv 環境を作成すると、Pipfile が自動的に生成されます。ファイルが現在のプロジェクトに追加され、プロジェクトツールウィンドウで確認できます。同様に、PyCharm で Pipfile ファイルを使用してプロジェクトを初めて開くと、Pipenv 仮想環境が自動的に構成されます。依存関係のリスト...
Python インタープリターを構成する
PyCharm の Python インタープリター：PyCharm で Python コードを操作するには、少なくとも 1 つの Python インタープリターを構成する必要があります。Python インストールで利用可能なシステムインタープリターを使用できます。Virtualenv、pipenv、Poetry、conda 仮想環境を作成することもできます。仮想環境は、基本インタープリターとインストールされたパッケージで構成されます。PyCharm Professional では、SSH、Vagr...
インタープリターのパスを管理する
PyCharm は、選択されたインタープリターにパスを追加することを可能にします。これらのパスは環境変数に追加されます。また、PyCharm はこれらのパスのインデックスを作成し、コードのオブジェクト（たとえば、パッケージのインポート）を解決します（潜在的に）。インタープリターのパスを表示以下のいずれか 1 つを実行します: を押して設定を開き、を選択します。Python インタープリターセレクターをクリックして、インタープリターの設定を選択します。、利用可能なインタープリターのリストを展開し、す...
パッケージのインストール、アンインストール、アップグレード
PyCharm は、特定の Python インタープリター用の Python パッケージをインストール、アンインストール、アップグレードするための方法を提供します。これは、各プロジェクトに独自のパッケージセットがあることを意味し、これが Python 依存関係管理のベストプラクティスと考えられます。デフォルトでは、PyCharm は pip を使用してプロジェクトパッケージを管理します。conda 環境の場合は、conda パッケージマネージャーを使用できます。PyCharm では、Python パ...
仮想環境を構成する
PyCharm を使用すると、virtualenv ツールを使用して、プロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenv ツールは PyCharm にバンドルされているため、ユーザーはインストールする必要はありません。virtualenv 環境を作成する以下のいずれか 1 つを実行します:Python インタープリターセレクターをクリックして、新しいインタープ...
Poetry 環境を構成する
Poetry は、プロジェクトの依存関係に基づいて Python 仮想環境を簡単に作成できるツールです。プロジェクトが依存するライブラリを宣言でき、Poetry がインストールして更新します。プロジェクトの依存関係は、必要なパッケージ、スクリプト、プラグイン、URL を指定する pyproject.toml ファイルに記録されます。その構造と形式の詳細については、pyproject リファレンスを参照してください。PyCharm で Poetry を使用するには、Poetry をマシンにインストールして...