pyproject.toml を使用する

プロジェクトの依存関係は、プロジェクトディレクトリ内の pyproject.toml ファイルで指定できます。 pyproject.toml を手動で作成するか、 Poetry 環境を設定して自動的に作成できます。

PyCharm はパッケージ名のコード補完と、不足している依存関係をインストールするためのクイックフィックスを提供します。

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

エディターで pyproject.toml を開きます。
[project] セクションを検索または作成します。
必要なパッケージの名前を dependencies 配列内の文字列として指定します。
パッケージ名を入力し始めると、PyCharm が補完オプションを表示します：
Enter を押して提案を挿入します。

プロジェクトのオプションの依存関係(英語)を [project.optional-dependencies] セクションで指定したり、 [build-system.requires] でビルド時の依存関係(英語)を指定したりすることもできます。

パッケージの名前がハイライトされている場合は、このパッケージが現在の Python インタープリターにインストールされていないことを意味します。

不足しているパッケージをインストールする

ハイライトされたパッケージ名にキャレットを置き、 Alt+Enter を押します。
パッケージをインストールをクリックしてください。

pyproject.toml にパッケージをインストールするためのクイックフィックス

パッケージのバージョンと詳細を表示

パッケージ情報ページを別のエディタータブで開くには、 Ctrl を押したままパッケージ名にマウスオーバーします。パッケージ名がハイパーリンクになったら、キーを離さずにクリックします。
クイックドキュメントポップアップですばやくパッケージ詳細を表示するには、依存関係にマウスオーバーします。または、依存関係の位置にキャレットを置き、 Ctrl+Q を押します。
パッケージ名、エキストラ、バージョン指定子、または環境マーカーなど、依存関係宣言のさまざまな部分からポップアップを開くことができます。

.lock ファイルを更新する

エディターで pyproject.toml を開きます。
依存関係を追加、削除、変更するには、 pyproject.toml を編集します。
.lock ファイルが古くなった場合、エディターの右上隅に利用可能なアクションを示すポップアップが表示されます。ポップアップが表示されない場合は、その領域にマウスを移動するとポップアップが表示されます。
利用可能なアクションは環境の種類によって異なります。
- Poetry ロック: pyproject.toml の依存関係と一致するように詩 .lock ファイルを更新します。
- Poetry アップデート: pyproject .toml に基づいて依存関係をインストールまたは更新し、それに応じて poetry.lock ファイルを更新します。
詳細は、 Poetry のドキュメント(英語)を参照してください。
- uv ロック: すべての依存関係を許可された最新バージョンにアップグレードし、 uv.lock ファイルを更新します。
- uv 同期: プロジェクトの環境を更新して、すべての依存関係が uv.lock ファイルと最新であることを確認します。
Python パッケージツールウィンドウから uv.lock ファイルを更新し、インストールされたパッケージを管理できます。
1. Python パッケージツールウィンドウを開きます。
2. uv.lock ファイルが同期されていない場合は、 uv ロックを更新をクリックして最新の状態にします。
3. インストールしたパッケージをアンインストール、アップグレード、レビューすることもできます。
詳細については、 uv のドキュメント(英語)を参照してください。
- ハッチラン: デフォルトの Hatch 環境を実行し、 pyproject.toml ベースのパッケージをインストールまたは更新します。依存関係が変更された場合、環境は自動的に更新され、それらの変更が反映されます。
詳細は、ハッチドキュメント(英語)を参照してください。