PyCharm 2024.1 ヘルプ

requirements.txt を使用する

PyCharm は、要件管理の主要な手段との統合を提供し、プロジェクト内の満たされていない要件を追跡し、requirements.txt ファイルに基づいて仮想環境を作成することを可能にします。

要件を定義する

  1. ツールメニューから同期 Python 要件を選択します。

  2. 開いたダイアログで、要件ファイルの名前を指定します。要件ファイルの推奨名は requirements.txt です。この名前のファイルがルートプロジェクトディレクトリに追加されると、Python 統合ツールによって自動的に検出されます。

    Define requirements.txt
  3. 必要なライブラリのバージョンを処理する方法を選択します。バージョン番号を定義できます。

    メソッド

    サンプル

    強い等価

    Django==3.0.3

    より大か等しい

    Django>=3.0.3

    対応バージョン

    Django~=3.0.3

  4. 要件管理ポリシーを定義します。

    ポリシー

    アクション

    未使用の要件を削除する

    未使用のライブラリとパッケージに対応するレコードを削除します。

    基本ファイルを変更する

    基本要件ファイルの変更を許可します(requirements.txt ファイルで参照されている場合)。

    現在のバージョンと一致する場合、既存のバージョン指定子を保持します

    選択したメソッドバージョンの処理を満たしている場合、バージョン番号は変更しません。

  5. OK をクリックして、生成されたファイルをインスペクションします。

    Generate requirements.txt file

プロジェクト用の requirements.txt ファイルを生成するためにコマンドラインで pip freeze > requirements.txt を実行することもできます。詳しくは https://pip.pypa.io/en/stable/reference/pip_freeze/(英語) を参照してください。

要件ファイルの名前が requirements.txt と異なる場合、または 1 つのプロジェクトに複数の要件ファイルがある場合は、適用する要件ファイルについて PyCharm に通知する必要があります。

デフォルトの要件ファイルを構成する

  1. Ctrl+Alt+S を押して設定を開き、ツール | Python 統合ツールを選択します。

  2. パッケージ要件ファイルフィールドに、要件ファイルの名前を入力するか、参照ボタンをクリックして目的のファイルを探します。

  3. 変更を保存するには、OK をクリックします。

同期 Python 要件を実行して要件ファイルを更新することはいつでも可能ですが、PyCharm はこのファイルを生成できるようにする迅速な修正を提供します。

要件ファイルを更新する

  • Python ファイルの import ステートメントで、ハイライトされたパッケージにキャレットを置き、Alt+Enter を押します。PyCharm が提案するクイックフィックスを使用します。

    Quick fix to add a requirement to the requirement.txt file

プロジェクトの依存関係を指定する

  1. エディターで requirements.txt を開きます。

  2. 必要なパッケージの名前とそのバージョンを指定します。

    パッケージ名の入力を開始すると、PyCharm には補完オプションが表示されます。

    Code completion for packages names in requirements.txt

    Enter を押して提案を挿入します。

PyCharm は、満たされていない依存関係に関連するクイックフィックスと通知を提供します。

必要なパッケージを requirements.txt からインストールする

  1. requirements.txt を含むプロジェクトで requirements.txt または Python ファイルを開くと、PyCharm は requirements.txt で指定されたすべてのパッケージが現在の Python インタープリターにインストールされているかどうかを確認します。

    Notification on the requirements
  2. 不足しているパッケージがある場合は、エディターの上部に通知バーが表示されます。インストール要件をクリックします。

要件を無視するをクリックすることもできます。この場合、無視されるパッケージのリストからパッケージを削除できます。

無視された依存関係を管理する

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

  2. メインメニューで、エディター | インスペクションに移動します。

  3. インスペクションのリストで、満たされていないパッケージ要件を選択します。

  4. 無視された要件のリストをプレビューし、追加アイコン (Add a package) をクリックして追加します。

    Adding an ignored package

関連ページ:

仮想環境を構成する

PyCharm を使用すると、virtualenv ツールを使用して、プロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenv ツールは PyCharm にバンドルされているため、ユーザーはインストールする必要はありません。virtualenv 環境を作成する以下のいずれか 1 つを実行します:Python インタープリターセレクターをクリックして、新しいインタープ...

Python 統合ツール

このページを使用して、要件管理ファイル、デフォルトのテストランナー、ドキュメント文字列処理を構成します。パッケージ要件ファイル要件ファイルの名前を入力するか、参照ボタンをクリックし、パスの選択ダイアログを使用してファイルシステムから目的の要件ファイルを選択します。Pipenv 実行可能ファイルのパスこのパスは、Python プロジェクトに Pipenv 環境を追加するために必要です。パスは、環境変数に追加された場合、システムによって自動検出できます。パスを見つけるには、OS 固有の pipenv...

Pipfile を使用する

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