Python ツールサポート

ラフの設定

1. 設定 ダイアログ (Ctrl+Alt+S) の Python | Tools | Ruff に移動します。



2. Ruff 設定の構成を開始するには、 有効化 チェックボックスを選択します。

3. 実行モード 設定で、PyCharm が Ruff 実行可能ファイルを検索する方法を選択します：

   • インタープリター モード: PyCharm は、インタープリターにインストールされている Ruff 実行ファイルを検索します。 選択したインタープリター用の Ruff パッケージをインストールするには、 Ruff をインストールする をクリックします。

   • パス モード: PyCharm は $PATH 内の Ruff 実行ファイルを検索します。 実行ファイルが見つからない場合は、 参照… アイコンをクリックしてパスを指定できます。

4. 有効にする Ruff オプションを選択します。

   • Inspections(英語)

   • フォーマット

   • インポートオプティマイザー

   追加オプションを設定するには、 保存時のすべてのアクション ... をクリックします。 設定で Ruff 統合が有効になっている場合は、 コードの整形 または インポートの最適化 を実行する際に Ruff 統合が使用されます。

   

5. ラフ設定は、 pyproject.toml、 ruff.toml、 .ruff.toml ファイルを使用して設定することもできます。 詳細については、 ラフドキュメント(英語)を参照してください。

Pyrefly を設定する

1. 設定 ダイアログ (Ctrl+Alt+S) の Python | Tools | Pyrefly に移動します。



2. Pyrefly 設定の構成を開始するには、 有効化 チェックボックスを選択します。

3. 実行モード 設定で、PyCharm が Pyrefly 実行可能ファイルを検索する方法を選択します：

   • インタープリター モード: PyCharm は、インタープリターにインストールされている Pyrefly 実行ファイルを検索します。 選択したインタープリター用の Pyrefly パッケージをインストールするには、 Pyrefly をインストールする をクリックします。

   • パス モード: PyCharm は $PATH 内の Pyrefly 実行ファイルを検索します。 実行ファイルが見つからない場合は、 参照… アイコンをクリックしてパスを指定できます。

4. 有効にする Pyrefly オプションを選択します。

   • Inspections(英語)

   • 補完

   • インレイヒント

   • ドキュメント

5. Pyrefly の設定は、 pyrefly.toml または pyproject.toml ファイルを使用して行うことができます。 詳細については、 Pyrefly ドキュメント(英語)を参照してください。

Pyright の設定

1. 設定 ダイアログ (Ctrl+Alt+S) の Python | Tools | Pyright に移動します。



2. Pyright 設定の構成を開始するには、 有効化 チェックボックスをオンにします。

3. 実行モード 設定で、PyCharm が Pyright 実行可能ファイルを検索する方法を選択します：

   • インタープリター モード: PyCharm は、インタープリターにインストールされている Pyright 実行ファイルを検索します。 選択したインタープリター用の basedpyright パッケージをインストールするには、 basedpyright をインストールする をクリックします。

     プレーンな Pyright を使用する場合は、 pyright[nodejs] をインストールしてください。

   • パス モード: PyCharm は $PATH 内の Pyright 実行ファイルを検索します。 実行ファイルが見つからない場合は、 参照… アイコンをクリックしてパスを指定できます。

4. 有効にする Pyright オプションを選択します。

   • Inspections(英語)

   • 補完

   • インレイヒント （basedpyright のみ利用可能）

5. Pyright 設定は pyrightconfig.json または pyproject.toml ファイルを使用して設定できます。 詳細については、 コピーライト(英語)および basedpyright(英語) のドキュメントを参照してください。

新しいエラーをベースラインに書き込む

ベースライン(英語)は、現在の型チェックエラーのセットを保存して、型カバレッジを徐々に改善しながら新しいエラーが導入されるのを防ぐ方法です。

PyCharm でベースラインを使用するには：

1. basedpyright を有効にします。

2. プロジェクト内で、basedpyright 型チェックエラーが含まれるファイルを開きます。

3. ヘルプ | アクションの検索 に移動し (または Ctrl+Shift+A を押して)、 ベースコピーライト: 新しいエラーをベースラインに書き込む を検索して選択します。

   .basedpyright ディレクトリに baseline.json ファイルが作成され、basedpyright はそこにリストされているエラーを無視しながら、新しいタイプのエラーを報告し続けます。

ty を設定する

1. 設定 ダイアログ (Ctrl+Alt+S) の Python | Tools | ty に移動します。



2. ty 設定の構成を開始するには、 有効化 チェックボックスをオンにします。

3. 実行モード 設定で、PyCharm が ty 実行可能ファイルを検索する方法を選択します：

   • インタープリター モード: PyCharm は、インタープリターにインストールされている ty 実行ファイルを検索します。 選択したインタープリター用の ty パッケージをインストールするには、 インストール ty をクリックします。

   • パス モードでは、PyCharm は $PATH 内の ty 実行ファイルを検索します。 実行ファイルが見つからない場合は、 参照… アイコンをクリックしてパスを指定できます。

4. 有効にする ty オプションを選択します。

   • Inspections(英語)

   • 補完

   • インレイヒント

   • ドキュメント

5. ty の設定は、 pyproject.toml または ty.toml ファイルを使用して行うことができます。 詳細については、 ty のドキュメント(英語)を参照してください。

黒の構成

1. 設定 ダイアログ (Ctrl+Alt+S) の Python | Tools | Black に移動します。

2. 実行モード ドロップダウンで、PyCharm が Black フォーマッターを実行する方法を選択します：

   • バイナリ モード: PyCharm はシステムにインストールされている Black 実行ファイルを使用します。 実行ファイルが見つからない場合は、 参照… アイコンをクリックしてパスを指定できます:

     

   • パッケージ モード: PyCharm はプロジェクトインタープリターにインストールされている Black パッケージを使用します。 選択したインタープリターに Black パッケージをインストールするには、 Black をインストール をクリックします:

     

3. ブラックフォーマッタをいつ実行するかを選択します:

   • Ctrl+Alt+L を押すか、メインメニューから コード | コードの整形 を選択するときに、組み込みフォーマッタの代わりに黒を使用するには、 コード整形時に実行 チェックボックスを有効にします。

   • 変更を保存したときにブラックフォーマッタを自動的に実行したい場合は、 On save を選択してください。 追加のアクションを設定するには、 保存時のすべてのアクション ... をクリックしてください。

4. ブラックフォーマッタの設定は pyproject.toml ファイルで設定できます。 ブラック v21.4.0 以上の場合は、設定が自動的に適用されます。 詳細については、 黒のドキュメント(英語)を参照してください。

   設定 フィールドを使用して、追加のオプションを指定したり、 pyproject.toml の設定を上書きしたりすることもできます。

   

   詳細については、 ブラック CLI リファレンス(英語)を参照してください。