PyCharm 2024.3 ヘルプ

使用箇所の検索

コードを記述または編集するときに、変更または削除するコード要素に遭遇する場合があります。変更を行う前に、コード要素がどこで使用され、アプリケーションにどのように影響するかを確認することをお勧めします。使用箇所の検索アクションを使用すると、コードベース全体でコード要素の参照を検索できます。

検索プロセスを管理し、単一のファイルのみを検索したり、検索範囲をプロジェクト全体に拡張したり、特定の検索範囲を作成したりできます。さらに、使用箇所のハイライトの色を設定したり、使用箇所の自動ハイライトを完全に無効にしたりすることもできます。

ファイル内の使用箇所を検索する

  • エディターで検索する要素をクリックすると、PyCharm はファイル内で見つかったすべての使用箇所を自動的にハイライトします。使用箇所のハイライトが無効になっている場合は、Ctrl+Shift+F7 を押すとファイル内のすべての使用箇所がハイライトされます。

    Highlight usages in file
  • テキスト文字列を検索するには、エディターで選択し、編集 | 使用箇所の検索 | ファイル内で使用箇所の検索 Ctrl+F7 に移動します。PyCharm は、ファイル内のすべての使用箇所を選択します。

    Highlighted symbols in a file

F3 および Shift+F3 ショートカットを使用して、ハイライトされたシンボル間を移動します。

プロジェクトの使用箇所を検索する

  • 使用箇所を検索するシンボルを選択し、シンボルを右クリックして、コンテキストメニューから使用箇所の検索を選択するか、Alt+F7 を押します。

    検索ツールウィンドウで結果を確認します。

    必要に応じて、結果をファイル、パッケージ、ディレクトリなどでグループ化(the Group By icon)できます。

    使用箇所の検索ダイアログを開くには、検索ツールウィンドウのツールバーの Settings icon をクリックするか、Ctrl+Alt+Shift+F7 を押します。

    PyCharm は検索結果を分析し、最も一般的な使用パターンを検出し、見つかったすべての使用を構造上の類似性に基づいてグループに分類します。これらの使用クラスタは、プレビュータブに表示されます。

    リストから任意のグループノードを選択し、類似の使用箇所を表示をクリックして結果を確認できます。

    この機能を無効にするには、詳細設定使用箇所の検索ビューで類似した使用箇所のクラスター化を有効化の選択を解除します。

    検索ツールウィンドウでは、プレビュー領域を使用して、使用箇所が見つかった場所を確認したり、メソッドの呼び出し階層やフィールドのデータフローなどを表示したりすることもできます。

    Find tool window preview area

見つかった使用箇所のソースコードをプレビューする

見つかった使用箇所のコードソースを表示するには、いくつかのオプションがあります。

  1. 使用箇所を検索するシンボルを選択し、シンボルを右クリックして、コンテキストメニューから使用箇所の検索を選択するか、Alt+F7 を押します。

  2. 検索ツールウィンドウで、Preview Source ソースのプレビューアイコンをクリックします。

    別の方法として、見つかった使用箇所でコンテキストメニューを呼び出す場合はソースに移動を選択するか、分割して表示を選択できます。この場合、結果の使用箇所を含むファイルがエディターで開かれます。

別のウィンドウに使用箇所を表示する

選択したシンボルの使用箇所を別のウィンドウで表示できます。このウィンドウは、画面のさまざまな部分に移動して、クイックナビゲーションに使用できます。

  1. エディターで、使用箇所を表示するシンボルを選択します。

  2. 編集 | 使用箇所の検索 | コードでの使用箇所を表示 Ctrl+Alt+F7 に進みます。

    Show Usages popup

    使用箇所ウィンドウには、現在のスコープと使用箇所の総数が表示されます。デフォルトのスコープにすばやく切り替えたい場合は、Ctrl+Alt+F7 を押します。

    検索結果のエントリが多すぎる場合、PyCharm は最初に見つかった 100 の使用箇所と、ウィンドウの下部にクリックしてさらに 100 の使用箇所を表示できる追加の使用箇所オプションを表示します。

    ウィンドウ上部のフィルターを使用して、特定の検索エントリを表示または非表示にします。

最近の使用箇所の検索結果を表示する

PyCharm は使用箇所の検索の結果を記憶しているため、アクションを再度実行する必要はありません。

  • メインメニューで編集 | 使用箇所の検索 | 最近の使用箇所を検索に移動し、使用箇所クエリを選択します。

使用箇所の検索のスコープを管理する

場合によっては、プロジェクトの特定のファイルまたはライブラリでのみ使用箇所を見つけたい場合があります。

  1. Ctrl+Alt+Shift+F7 を押して使用箇所の検索ダイアログを開きます。

  2. 使用箇所の検索ダイアログのスコープフィールドで、検索の範囲を選択します。例: 開いているファイルまたはプロジェクトテストファイルのみで使用箇所を検索できます。

    Find Usages dialog (Change Scope)

    the ellipsis icon をクリックして、カスタムスコープを設定することもできます。例: カスタムスコープを作成して、テストファイルなどの特定のファイルを使用箇所の検索から除外できます。新しいスコープの設定が完了したら、検索をクリックします。

    PyCharm が結果を返さない場合、より多くのオプションを選択することを提案するメッセージが表示されます。

    No usages found popup

    リンクをたどるか、Ctrl+Alt+Shift+F7 を押して使用箇所の検索ダイアログを再度開き、検索の新しいスコープを設定できます。

使用箇所の自動ハイライトを無効にする

キャレットをシンボルに配置すると、IDE は現在のファイルでこのシンボルのすべての使用箇所をハイライトします。

必要に応じて、自動ハイライトを無効にすることができます。

  1. Ctrl+Alt+S を押して設定を開き、エディター | コード編集を選択します。

  2. キャレット移動のハイライトセクションのキャレット上の要素の使用箇所チェックボックスをオフにします。

自動ハイライトが無効になっていて、現在のファイル内のシンボルの使用箇所をハイライトする場合は、この記号を選択して Ctrl+Shift+F7 を押します。これにより、現在のファイル内のシンボルのすべての使用箇所がハイライトされます。

ハイライトされた使用箇所の背景色を変更する

  1. 設定ダイアログ(Ctrl+Alt+S)で、エディター | カラースキームの切り替え | 一般に移動します。

  2. 右側のオプションから、コードノードを開き、キャレットの識別子を選択します。

  3. バックグラウンドフィールドで、必要な色を指定し、変更を保存します。

関連ページ:

ファイル内で検索して置き換える

現在のドキュメント内のテキスト文字列をすばやく検索して置換することができます。さまざまなオプションを使用して、検索プロセスを絞り込み、検索で正規表現を使用し、検索結果を管理できます。エディターでファイルを開きます。を押すか、メインメニューからを選択します。開いた検索フィールドに、検索文字列を入力します。PyCharm は、ファイル内の検索結果をハイライトします。または、エディターで、検索する文字列をハイライトしてを押します。PyCharm は、ハイライトされた文字列を検索フィールドに配置する...

検索ツールウィンドウ

検索ツールウィンドウには、次の検索結果が表示されます。パス内検索 / 置換、使用箇所の検索、構造検索と置換、リファクタリングプレビュー、データソース、テーブル、列の使用箇所の検索。検索ツールウィンドウには複数のタブを含めることができます。デフォルトでは、検索ごとに現在のタブで検索結果が更新されます。各検索の結果を別のタブに表示するには、ツールウィンドウのヘッダーを右クリックし、を選択します。デフォルトでは、検索ツールウィンドウが画面の下部に表示されます。これには、一連のボタン、結果のペイン、パス...

スコープ

この設定ページを使用してスコープ、つまりさまざまな操作を適用するファイルのセットを定義します。メインツールバー:スコープの追加新しいローカルスコープまたは共有スコープを追加します。削除リストから選択したスコープを削除します。構成のコピー選択したスコープのコピーを作成してください。名前を付けて保存選択したローカルスコープを共有として、または選択した共有スコープをローカルとして保存します。

正規表現構文リファレンス

このセクションは、検索と置換の作成、およびナビゲーションパターンの発行に使用できる正規表現構文の概要です。RegEx 構文リファレンス:次の文字を特殊文字またはリテラルとしてマークします。例:n は文字 n と一致します。「\n」は改行文字と一致します。シーケンスはと一致し、はと一致します。入力の始めに一致します。入力の終わりに一致します。直前の文字と 0 回以上一致します。例:

構造検索と置換

従来の検索プロセスでは、ソースコードの構文とセマンティクスが考慮されていません。正規表現を使用している場合でも、PyCharm はコードを正規表現として扱います。構造検索および置換(SSR)アクションを使用すると、コード構造を考慮して、コード内の特定のコードパターンまたは文法構造を検索できます。PyCharm は、作成した検索テンプレートと適用した条件に基づいて、ソースコードのフラグメントを見つけて置き換えます。ターゲットを構造的に検索するに移動して、構造検索ダイアログを開きます。構造検索ダイア...