PyCharm 2020.3 ヘルプ

Pipenv 環境を構成する

Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介してプロジェクトパッケージが自動的に管理されます。

Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要な場合に、セキュリティに敏感なデプロイに特に役立ちます。pipenv の詳細については、pipenv.kennethreitz.org/(英語) のプロジェクトドキュメントを参照してください。

Pipenv と PyCharm を併用するには、いくつかの準備手順を実行する必要があります。

Pipenv をインストールする

  1. 次のコマンドを実行して、pip がシステムにインストールされていることを確認します。

    $ pip --version

    pip バージョンを示すシステム応答を受け取ることを期待するべきです。pip が見つからない場合は、インストール手順(英語)の説明に従ってインストールしてください。あるいは、http://python.org(英語) から Python をダウンロードしてインストールすることもできます。

  2. 次のコマンドを実行して pipenv をインストールします。

    $ pip install --user pipenv

    インストールが完了すると、次のメッセージが表示されます。

    System response on successful pipenv installation
  3. 便宜上、PATH 環境変数にユーザベースのバイナリディレクトリを追加することができます。この手順をスキップすると、PyCharm は pipenv 環境を追加するときに pipenv 実行可能ファイルへのパスを指定するよう指示します。

    1. 次のコマンドを実行します。

      $ py -m site --user-site

      出力例は次のとおりです。

      C:\Users\jetbrains\AppData\Roaming\Python\Python37\site-packages
    2. このパスの site-packagesScripts に置き換えて、PATH 変数に追加する文字列を受け取ります。たとえば、次のようになります。

      $ setx PATH "%PATH%;C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts"
    1. 次のコマンドを実行して、ユーザーベースのバイナリディレクトリを探します。

      $ python -m site --user-base

      出力の例は次のとおりです

      /Users/jetbrains/.local(masOS)または /home/jetbrains/.local (Linux)

    2. このパスに bin を追加して、~/.bashrc ファイルに追加する文字列を受け取ります。例:

      $ export PATH="$PATH:/Users/jetbrains/.local/bin"
    3. 次のコマンドを実行して、変更を有効にします。

      $ source ~/.bashrc
    4. bash_profilebashrc を有効にしたことを確認してください。

プロジェクトの設定で、指定したパスをいつでも pipenv 実行可能ファイルに変更できます。設定 / 環境設定ダイアログ Ctrl+Alt+Sツール | Python 統合ツールにナビゲートし、実行可能な Pipenv のパスフィールドにターゲットパスを入力します。

準備が完了したら、pipenv を使用して新規プロジェクトまたは既存プロジェクトの仮想環境を作成できます。

新しい Python プロジェクト用に pipenv を設定する

  1. 純粋な Python プロジェクトを作成するに従って、新しい Python プロジェクトの作成を開始します。

  2. 新規プロジェクトダイアログで、Expand をクリックして Python インタープリターノードを展開し、次の環境を使用を選択し、使用可能な仮想環境のリストから Pipenv を選択します。

    Select Pipenv when creating a new Python project
  3. ユーザベースのバイナリディレクトリを PATH 環境変数に追加した場合、追加のオプションを設定する必要はありません: pipenv 実行ファイルへのパスは自動検出されます。

    Path to the pipenve executable is autodetected
  4. タスクを完了するには、OK をクリックします。

  5. PATH 変数を変更していない場合、PyCharm はエラーメッセージ Pipenv 実行ファイルが見つかりませんを表示します。pipenv インストール手順の説明に従って適切な実行可能パスを見つけpipenv 実行可能ファイルフィールドにターゲット文字列を入力します(例: C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe(Windows)または /Users/jetbrains/.local/bin/pipenv(macOS))。

    OK をクリックして変更を保存し、タスクを完了します。

また、以前に作成したプロジェクトに対して pipenv を設定することもできます。

既存の Python プロジェクト用に pipenv を設定する

  1. Ctrl+Alt+S を押してプロジェクト設定 / 環境設定を開きます。

  2. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、プロジェクト <プロジェクト名> | Python インタープリターを選択します。The Configure project interpreter アイコンをクリックして、追加を選択します。

    Selecting the Add command to create a new Python interpreter
  3. このダイアログの左側のペインで、Pipenv 環境をクリックします。

    Adding a Pipenv environment
  4. ユーザベースのバイナリディレクトリを PATH 環境変数に追加した場合、追加のオプションを設定する必要はありません: pipenv 実行ファイルへのパスは自動検出されます。

    Pipenv 実行ファイルが見つかりませんエラーメッセージが表示された場合は、pipenv インストール手順に従って実行可能パスを見つけ、それを pipenv 実行可能ファイルフィールドに追加します。

  5. タスクを完了するには、OK をクリックします。

すべての手順が完了すると、あなたのプロジェクトに新しい pipenv 環境が設定され、Pipfile にリストされているパッケージがインストールされます。

Pipfile ファイルが追加されているが、インタープリターが設定されていないプロジェクトを開くと、PyCharm は Pipenv 環境を使用できるようにします。

Pipenv inspection

このオプションを選択すると、PyCharm によって自動的に pipenv が設定されます。または、Python インタープリターを構成するをクリックして標準ワークフローに従うこともできます。

同様に、PyCharm で Pipfile ファイルを使用しているプロジェクトを最初に開くと、たとえばバージョン管理からチェックアウトするなどして、Pipenv 仮想環境が自動的に設定されます。

Pipenv 仮想環境を Python インタープリターとして設定すると、使用可能なすべてのパッケージが Pipfile で定義されたソースから追加されます。パッケージは、pip ではなく pipenv を介して、パッケージのリストでインストール、削除、更新されます。

PyCharm は、Pipfile に記録されたプロジェクト要件に基づいて、プロジェクトの Pipenv 環境を作成できます。

Pipfile を使用して環境を作成する

  1. Pipenv ファイルを含むソースファイルで任意のディレクトリを開きます。メインメニューからファイル | 開くを選択し、ディレクトリを選択します。

  2. このプロジェクト用に環境が作成されていない場合、PyCharm はそれを作成することをお勧めします。

    Create a pipenv environment using the requirements.txt file

  3. PyCharm が pipenv 実行可能ファイルを自動検出できない場合は、その実行可能ファイルへのパスを指定します。OK をクリックしてタスクを完了します。

OK をクリックすると、PyCharm は環境を作成し、必要なすべてのパッケージをインストールします。

pipenv 環境を作成するという提案を無視すると、PyCharm はプロジェクトの Python インターパーターを作成しないことに注意してください。.py ファイルを開くと、プロジェクトインタープリターを構成するためのオプションを含む警告が表示されます。

Warning with options for configuring a project interpreter

構成済みの Python インタープリター(ただし Docker-based を除く)のいずれかについて、以下を行うことができます。

関連ページ:

Pipfile を使用する

Pipfile は、Pipenv 仮想環境がプロジェクトの依存関係を管理するために使用する専用ファイルです。このファイルは、Pipenv を使用するために不可欠です。新規または既存のプロジェクト用に Pipenv 環境を作成すると、Pipfile が自動的に生成されます。ファイルが現在のプロジェクトに追加され、プロジェクトツールウィンドウで確認できます。同様に、PyCharm で Pipfile ファイルを使用してプロジェクトを初めて開くと、Pipenv 仮想環境が自動的に構成されます。依存関係のリスト...

Python プロジェクトを作成する

純粋な Python プロジェクトは、Python プログラミングを対象としています。プロジェクトは、ソースコード、テスト、使用するライブラリ、個人設定を 1 つのユニットに整理できます。プロジェクトが必要ない場合は、LightEdit モードでファイルを編集できます。プロジェクトを作成するには、次のいずれかを実行します。メインメニューから、を選択します。ウェルカム画面で、新規プロジェクトをクリックします。新規プロジェクトダイアログが開きます。新規プロジェクトダイアログで、プロジェクト名とその場所...

インタープリターパスのインストール、アンインストール、アップグレード

PyCharm は、選択されたインタープリターにパスを追加することを可能にします。これらのパスは環境変数に追加されます。また、PyCharm はこれらのパスのインデックスを作成し、コードのオブジェクト(たとえば、パッケージのインポート)を解決します(潜在的に)。インタープリターのパスを表示するにはプロジェクト設定の Python インタープリターページで、ボタンをクリックします。一覧で、すべて表示... をクリックします。利用可能なインタープリターが Python インタープリターダイアログに表示され...

パッケージのインストール、アンインストール、アップグレード

PyCharm は、特定の Python インタープリターの Python パッケージをインストール、アンインストール、アップグレードする方法を提供します。デフォルトでは、PyCharm は pip を使用してプロジェクトパッケージを管理します。Conda 環境では、conda パッケージマネージャーを使用できます。Python インタープリターの Python パッケージを管理するには、プロジェクト設定 / 環境設定で Python インタープリターページを選択するか、ステータスバーの Pytho...

仮想環境を構成する

PyCharm を使用すると、virtualenv ツールを使用して、プロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenv ツールは PyCharm にバンドルされているため、ユーザーはインストールする必要はありません。Python 3.3+ の場合、サードパーティの virtualenv ユーティリティではなく、組み込みの venv モジュールが使用されます。仮想環...