PyCharm 2023.3 Help

Use prompts to explain, refactor, and suggest changes to your code

Use pre-written prompts to explain code, find problems, and refactor your code. PyCharm provides project-specific context, such as the languages and technologies used in your project.

You can also define your own custom prompts and add them to the AI Actions menu.

Explain code

  1. Select a code fragment and right-click it to open the context menu.

    Alternatively, select a code fragment and press Alt+Enter.

  2. Select AI Actions and then Explain Code.

    The AI Assistant tool window will open to provide you with an explanation.

    PyCharm AI Assistant explains code

    Click Ml llm icons expui attached Attached elements to see the list of files that provided the necessary context for generating the answer.

    Attached files that were analyzed to generate the answer

Suggest refactoring

  1. Select a code fragment and right-click it to open the context menu.

    Alternatively, select a code fragment and press Alt+Enter.

  2. Select AI Actions and then Suggest Refactoring.

    The AI chat will open to offer you refactoring suggestions.

    PyCharm: AI Assistant suggests refactoring

  3. In the field with the refactored code, click See Diff and Apply to open the diff viewer. To skip the diff viewing step, expand the list next to See Diff and Apply and select Apply Immediately.

    In the diff viewer, use Unified or Two-Side view to review the suggested changes.

    Diff tab with refactored code

  4. If you like the result, click App client expui diff arrow 14x14 Accept in the gutter to move the selected AI-generated code snippets to the source file, or click Accept all to fully replace the originally selected code fragment. Otherwise, close the diff viewer to skip the suggested refactoring.

Find problems

  1. Select a code fragment and right-click it to open the context menu.

    Alternatively, select a code fragment and press Alt+Enter.

  2. Select AI Actions and then Find Problems.

    The AI chat will open to show the potential issues you may want to look into.

    PyCharm: AI Assistant finds potential problems in the selected code

Explain runtime error

For Python runtime errors shown in the console, PyCharm shows inlay hints, allowing you to get AI explanations for those errors.

  1. Click Explain with AI in the console.

    Explain with AI option in console

    The AI Assistant tool window will open to give you an explanation of the error and suggest a fix.

  2. If you want to use the suggested fix, click Insert Snippet at Caret in the field with the refactored code to put the AI-generated code into the editor.

    Put the corrected code into the editor

Suggest Django intentions

  1. Select a code fragment and right-click it to open the context menu.

    Alternatively, select a code fragment and press Alt+Enter.

  2. Select AI Actions and choose the Django intention.

    Choosing the Django intention
    Create Django View For Model

    AI Assistant suggests the code of a class-based view for the selected model along with the steps required to implement it in your project.

    This action is available only for Django models.

    Custom Django Intention

    AI Assistant provides the possible actions for the selected entity.

    AI Assistant suggests Django intentions
    Create Django Admin For Model

    AI Assistant suggests the code required to register the selected model in the Django admin interface along with other necessary steps.

    Create Django Serializer For Model

    AI Assistant suggests the code of a Serializer class along with other necessary steps.

    Custom Django Smart Chat Intention

    AI Assistant provides the possible actions for the selected entity taking into account the context of your project provided as attached elements in the chat.

    AI Assistant suggests Django intentions with context

Add your own prompts to prompts library

You can add your own prompts to the prompts library and use them via the AI Actions menu.

  1. Do one of the following:

    • Right-click anywhere in the editor to open the context menu, then go to AI Actions | Add Your Prompts.

    • Press Alt+Enter, select AI Actions, and click Add your prompts.

    • Press Control+Alt+S to open the IDE settings and then select Tools | AI Assistant | User Prompts Library.

  2. Click App client expui general add to create a new prompt.

    PyCharm: User prompts library settings
  3. In the text field, write the prompt.

    If needed, click the $SELECTION variable to add a Markdown-formatted code block with current code selection and language name to the new prompt.

  4. Edit the new prompt name.

    Select the first checkbox if you want AI Assistant to wait for you to make additional input in the chat after invoking the prompt.

    Keep the second checkbox if you want your new prompt to be listed in the AI Actions menu.

    PyCharm: Custom prompt parameters
  5. Click Apply.

Once you create a prompt, you can edit or delete it at any time.

Last modified: 11 December 2023