PyCharm 2024.1 Help

Intention actions

As you work in the editor, PyCharm analyzes your code, searches for ways to optimize it, and detects potential and actual problems.

As soon as the IDE finds a way to alter your code, it displays a yellow bulb icon yellow bulb icon in the editor next to the current line. By clicking this icon, you can view the intention actions available in the current context. Intention actions cover a wide range of situations from warnings to optimization suggestions. You can view the full list of intentions and customize them in the Settings dialog Ctrl+Alt+S.

A red bulb with an exclamation mark the Quick-fix icon indicates that PyCharm has detected a problem, and prompts you to select an associated fix — a quick-fix. Quick-fixes and intention actions together are called context actions.

Apply intention actions

  1. Place the caret at the code element that you want to modify. Then click the light bulb icon (or press Alt+Enter) to open the list of suggestions.

    For example, PyCharm provides an intention that converts .format() calls and printf-style formatting to f-string literals.

    Intention preview opens automatically. If an intention is complex, and the preview cannot be generated, you will see the intention description. hover over available intentions on the suggestion list to preview them.

    Intention action preview
  2. Press Enter or click an intention on the list to apply it.

    Intention action is applied

    The way f-string literals appear in the Editor depends on the corresponding Color Scheme settings. In the Settings dialog (Ctrl+Alt+S) , navigate to Editor | Color Scheme | Python, select String | f-string in the list of components, and modify the available settings if needed.

You can toggle the preview off and on by pressing Ctrl+Q or by enabling Show preview for intention actions when available in Settings (Ctrl+Alt+S) | Editor | General | Appearance.

Assign a shortcut to an intention

If you want to apply intention actions quicker, you can assign shortcuts to them. Currently, you cannot assign shortcuts to fixes that belong to code inspections.

  1. In the editor, place the caret at the code that triggers the intention action for which you want to assign a shortcut, and click the bulb icon or press Alt+Enter.

    A list of available suggestions opens.

  2. In the list, click next to the necessary intention action and, from the menu that opens, select Assign shortcut.

    Assigning keyboard shortcut to intention action
  3. When the Keyboard Shortcut dialog opens, press the shortcut that you want to use for this action and click OK.

After that you won't need to open the list of suggestions to apply this intention action in the editor; you will be able to do it right away by pressing the configured shortcut.

You can find all your custom intention action shortcuts in settings: press Ctrl+Alt+S, click Keymap, and locate the Intentions category.

View all intention actions

You can view the full list of available intention actions, and disable actions that you don't need at the moment. To open the list of intention actions:

  1. Press Ctrl+Alt+S to open settings and then select Editor | Intentions.

  2. For each intention action, you can see a description and an example. To disable an intention, clear the checkbox next to it.

    Settings of intention actions
  3. Apply the changes and close the dialog.

Disable intention actions on the fly

  1. Place the caret at the code element that you want to modify. Then click the light bulb icon (or press Alt+Enter) to open the list of suggestions.

  2. Select the action you want to disable, click the right arrow next to it, and then click Disable <intention action name>.

    Disable intention action
Last modified: 26 May 2024