PyCharm 2024.1 ヘルプ

Pipfile を使用する

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

依存関係のリストを最初から作成する作業を考えてみましょう。

Pipfile を使用してプロジェクトの依存関係を管理する

  1. PyCharm が新しい Pipenv 仮想環境用に Pipfile を作成すると、ファイルは次のようになります。

    autogenerated Pipfile

    python_version パラメーターは、新しい Pipenv 仮想環境の作成時に指定した基本インタープリターのバージョンです。packages セクションは、プロジェクトに必要なパッケージをリストできる場所です。

  2. packages セクションを変更して、新しいパッケージ依存関係を追加します。

    [packages] django = "*"
  3. Pipfile ファイルを変更するたびに、PyCharm は次のいずれかのアクションを提案します。

    Run the pipenv update or pipenv lock commands
    • pipenv lock — 新しい要件を Pipfile.lock ファイルに記録します。

    • pipenv update — 新しい要件を Pipfile.lock ファイルに記録し、不足している依存関係を Python インタープリターにインストールします。

    pipenv update をクリックして、Django パッケージをインストールします。

  4. Python パッケージツールウィンドウを開いて、Django がインストールされていることを確認します。

    Django package is added

PyCharm は、Pipfile にリストされている要件のいずれかが満たされていない場合を追跡し、影響を受ける依存関係を適用することを提案します。

依存関係を適用する

  1. プロジェクトのソースファイルをチェックアウトまたは更新し、次のメッセージが表示された場合を考えてみましょう。

    Packages that are listed in the Pipfile are missing

    これは、仮想環境が Pipfile の現在のバージョンにリストされている要件を満たしていないことを意味します。

  2. Pipfile.lock から要件をインストールするをクリックして、不足しているパッケージをインストールします。

Pipfile と一緒に、Pipfile.lock ファイルが pipenv プロジェクト要件を管理する上で重要な重要なロールを果たすことに気づいたかもしれません。pipenv lock または pipenv update を実行するたびに、仮想環境の現在のスナップショットが取得されます。次の断片を調べましょう。

a fragment of the Pipfile.lock

このファイルには、プロジェクト用にインストールされたパッケージの正確なバージョンが記録されています。また、アプリケーションの安全なデプロイを容易にするためにハッシュコードを生成しました。信頼できないソースから依存関係をダウンロードするときは、プロジェクトファイルが確実に信頼されるようにハッシュコードが使用されます。

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

  1. Pipfile を含むプロジェクトを開いたものの、プロジェクトインタープリターが構成されていない場合、PyCharm は Pipenv 環境を作成することを提案します。

    Pipfile detected
  2. PyCharm に Pipenv を自動的に構成させたい場合は、Pipfile を使用して Pipenv 環境を作成するをクリックします。または、「Python インタープリターを構成する」をクリックして標準ワークフローに従うこともできます。

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

新しい Pipenv 環境がプロジェクト用に構成され、Pipfile にリストされているパッケージがインストールされます。

関連ページ:

Pipenv 環境を構成する

Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介して自動的にプロジェクトパッケージが管理されます。Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要である場合、セキュリティに敏感なデプロイにとって特に役立つ可能性が...

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

PyCharm は、特定の Python インタープリター用の Python パッケージをインストール、アンインストール、アップグレードするための方法を提供します。これは、各プロジェクトに独自のパッケージセットがあることを意味し、これが Python 依存関係管理のベストプラクティスと考えられます。デフォルトでは、PyCharm は pip を使用してプロジェクトパッケージを管理します。conda 環境の場合は、conda パッケージマネージャーを使用できます。PyCharm では、Python パ...

requirements.txt を使用する

PyCharm は、要件管理の主要な手段との統合を提供し、プロジェクト内の満たされていない要件を追跡し、requirements.txt ファイルに基づいて仮想環境を作成することを可能にします。要件を定義するメニューから同期 Python 要件を選択します。開いたダイアログで、要件ファイルの名前を指定します。要件ファイルの推奨名は requirements.txt です。この名前のファイルがルートプロジェクトディレクトリに追加されると、Python 統合ツールによって自動的に検出されます。必要なライブ...

pyproject.toml を使用する

プロジェクトの依存関係は、プロジェクトディレクトリ内の pyproject.toml ファイルで指定できます。pyproject.toml を手動で作成することも、自動的に作成されるように Poetry 環境を構成することもできます。PyCharm は、パッケージ名としてコード補完を提供し、不足している依存関係をインストールするためのクイックフィックスを提供します。プロジェクトの依存関係を指定するエディターで pyproject.toml を開きます。セクションを検索または作成します。必要なパッケージの名前...