requirements.txt を使用する

requirements ファイルを作成する

プロジェクトにまだ requirements ファイルがない場合は、自分で作成できます。

1. 以下のいずれか 1 つを実行します:

   • プロジェクトツールウィンドウ (Alt+1) で、新しいファイルを作成するディレクトリまたはパッケージを選択し、メインメニューからファイル | 新規を選択します。

   • ディレクトリまたはパッケージを右クリックし、コンテキストメニューから新規を選択します。

   • ディレクトリを選択し、Alt+Insert を押します。

2. リストから ファイルを選択します。

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

4. OK をクリックします。新しいファイルが対象の場所に作成されます。

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

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

2. パッケージ requirements ファイルフィールドに requirements ファイルの名前を入力するか、参照ボタンをクリックしてファイルを見つけます。

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

要件を定義する

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

   requirements.txt ファイルが空で、プロジェクトにパッケージをインポートしている場合、PyCharm は requirements ファイルを更新するためのクイックフィックスを提供します。

2. インポートしたパッケージを要件に追加します ... リンクをクリックしてください:

   

3. 開いたダイアログで、requirements ファイルの名前を指定します。

   

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

   メソッド	サンプル
   完全一致	Django==3.0.3
   以上	Django>=3.0.3
   互換バージョン	Django~=3.0.3

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

   ポリシー	アクション
   未使用の要件を削除する	未使用のライブラリとパッケージに対応するレコードを削除します。
   ベースファイルの変更	基本 requirements ファイルの変更を許可します（requirements.txt ファイルで参照されている場合）。
   現在のバージョンと一致する場合、既存のバージョン指定子を保持します	選択したメソッドバージョンの処理を満たしている場合、バージョン番号は変更しません。

6. OK をクリックして、更新されたファイルを調べます。

requirements ファイルを更新する

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

  

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

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

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

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

   

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

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

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

   

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

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

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

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

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

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