PyCharm 2024.3 ヘルプ

プロンプトを使用してコードの説明、リファクタリング、変更の提案を行う

事前に作成されたプロンプトを使用して、コードの説明リファクタリング、コード内の問題の検出を行います。PyCharm は、プロジェクトで使用される言語やテクノロジーなど、プロジェクト固有のコンテキストを提供します。

独自のカスタムプロンプトを定義してAI アクションメニューまたは組み込みプロンプトを変更するに追加することもできます。

コードの説明

  1. コードフラグメントを選択し、右クリックしてコンテキストメニューを開きます。

    あるいは、コードフラグメントを選択して Alt+Enter を押します。

  2. AI アクションを選択し、次にコードの説明を選択します。

    AI Assistant ツールウィンドウが開き、説明が表示されます。

    PyCharm AI Assistant explains code

    付属要素をクリックすると、回答を生成するために必要なコンテキストを提供するファイルのリストが表示されます。

    Attached files that were analyzed to generate the answer

リファクタリングの提案

  1. コードフラグメントを選択し、右クリックしてコンテキストメニューを開きます。

    あるいは、コードフラグメントを選択して Alt+Enter を押します。

  2. AI アクションを選択し、次にリファクタリングの提案を選択します。

    AI チャットが開き、リファクタリングの提案が提供されます。

    PyCharm: AI Assistant suggests refactoring
  3. リファクタリングされたコードが含まれるフィールドで、差分の表示をクリックして差分ビューアーを開きます。差分表示の手順をスキップするには、差分の表示の横にあるリストを展開し、すぐに申し込むを選択します。

    差分ビューアーで、統合ビューまたは両面ビューを使用して、提案された変更を確認します。

    Diff tab with refactored code
  4. 結果が気に入った場合は、ガターの 受諾をクリックして、選択した AI 生成のコードスニペットをソースファイルに移動するか、すべて受諾をクリックして、最初に選択したコードフラグメントを完全に置き換えます。それ以外の場合は、差分ビューアーを閉じて、提案されたリファクタリングをスキップします。

問題の検索

  1. コードフラグメントを選択し、右クリックしてコンテキストメニューを開きます。

    あるいは、コードフラグメントを選択して Alt+Enter を押します。

  2. AI アクションを選択し、次に問題の検索を選択します。

    AI チャットが開き、調査が必要な潜在的な問題が表示されます。

    PyCharm: AI Assistant finds potential problems in the selected code

実行時エラーを説明する

コンソールに表示される Python ランタイムエラーの場合、PyCharm はインレイヒントを表示し、これらのエラーに関する AI の説明を取得できるようにします。

  1. コンソールで「AI で説明」をクリックします。

    Explain with AI option in console

    AI Assistant ツールウィンドウが開き、エラーの説明と修正方法が提案されます。

  2. 提案された修正を使用する場合は、リファクタリングされたコードが含まれるフィールドで Insert Snippet at Caret をクリックして、AI によって生成されたコードをエディターに入力します。

Django インテンションを提案する

  1. コードフラグメントを選択し、右クリックしてコンテキストメニューを開きます。

    あるいは、コードフラグメントを選択して Alt+Enter を押します。

  2. AI アクションを選択し、Django インテンションを選択します。

    Choosing the Django intention
    モデルの Django ビューの作成

    AI Assistant は、選択したモデルのクラスベースのビューのコードと、それをプロジェクトに実装するために必要な手順を提案します。

    このアクションは、Django モデルでのみ使用できます。

    カスタム Django インテンション

    AI Assistant は、選択したエンティティに対して可能なアクションを提供します。

    AI Assistant suggests Django intentions
    モデルの Django 管理者の作成

    AI Assistant は、選択したモデルを Django 管理インターフェースに登録するために必要なコードと、その他の必要な手順を提案します。

    モデルの Django シリアライザーの作成

    AI Assistant は、Serializer クラスのコードとその他の必要な手順を提案します。

    カスタム Django スマートチャットインテンション

    AI Assistant は、チャット内のアタッチ要素として提供されたプロジェクトのコンテキストを考慮して、選択したエンティティに対して可能なアクションを提供します。

    AI Assistant suggests Django intentions with context

独自のプロンプトをプロンプトライブラリに追加する

独自のプロンプトをプロンプトライブラリに追加し、AI アクションメニューから使用できます。

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

    • エディター内の任意の場所を右クリックしてコンテキストメニューを開き、AI アクション | プロンプトを追加するに移動します。

    • Alt+Enter を押し、AI アクションを選択し、プロンプトを追加するをクリックします。

    • Ctrl+Alt+S を押して設定を開き、ツール | AI Assistant | プロンプトライブラリを選択します。

  2. 」をクリックして新しいプロンプトを作成します。

    PyCharm: User prompts library settings
  3. テキストフィールドにプロンプトを入力します。

    必要に応じて、$SELECTION 変数をクリックして、現在のコード選択と言語名を含む Markdown 形式のコードブロックを新しいプロンプトに追加します。

  4. 新しいプロンプト名を編集します。

    プロンプトを呼び出した後、AI Assistant がチャットで追加入力を行うまで待機する場合は、最初のチェックボックスを選択します。

    新しいプロンプトを AI アクションメニューにリストする場合は、2 番目のチェックボックスをオンのままにします。

    PyCharm: Custom prompt parameters
  5. 適用をクリックします。

プロンプトを作成したら、いつでも編集または削除できます。

リストからプロンプトを選択し、それを上または下に移動して、プロンプトの表示順序を変更することもできます。

組み込みプロンプトを変更する

対応するアクションに使用されるプロンプトを変更することで、特定のシナリオでの AI Assistant の動作を調整できます。例: ドキュメントを生成するための特定のガイドラインを追加できます。

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

    • エディター内の任意の場所を右クリックしてコンテキストメニューを開き、AI アクション | プロンプトを追加するに移動します。

    • Alt+Enter を押し、AI アクションを選択し、プロンプトを追加するをクリックします。

    • Ctrl+Alt+S を押して設定を開き、ツール | AI Assistant | プロンプトライブラリを選択します。

  2. プロンプトを変更するアクションを選択します。

    PyCharm: Select the action
  3. 新しい指示を追加します。

  4. 適用をクリックします。

提供された指示はデフォルトのプロンプトに追加され、対応するアクションの機能が拡張されます。

関連ページ:

AI でドキュメントを生成

AI Assistant を使用すると、LLM(大規模言語モデル)を使用して申告用のドキュメントを生成できます。目的のコードフラグメントにキャレットを置き、右クリックしてコンテキストメニューを開きます。を押します。AI アクションを選択し、次にドキュメントを書くを選択します。AI Assistant がドキュメントを生成します。または、任意の関数またはクラスに移動し、新しい行を開始してと入力します。Enter を押して、AI Assistant で生成をクリックします。のドキュメントを書くアクショ...

AI とチャットする

AI Assistant ツールウィンドウを使用して、LLM (大規模言語モデル) と会話したり、プロジェクトについて質問したり、タスクを反復したりできます。AI Assistant は、プロジェクトで使用されている言語とテクノロジー、ローカルの変更、バージョン管理システムのコミットを考慮します。ファイル、クラス、要素の使用状況を検索できます。新しいチャットを始める右側のツールバーで AI Assistant をクリックして AI Assistant を開きます。入力フィールドに質問を入力します。エデ...

エディターで AI を使用する

プロンプトを使用してエディターでコードを生成する:コードを生成し、エディターでプロンプトを直接使用します。プロンプトを使用してエディターでコードを生成する変更したいコードの一部を選択するか、エディター内の任意の場所にキャレットを置いて、を押します。または、エディター内の任意の場所を右クリックしてコンテキストメニューを開き、AI アクションを選択してからコードの生成を選択します。入力フィールドにプロンプトを入力し、を押します。生成が完了するまで待ちます。生成されたコードは、入力フィールドを呼