PyCharm 2020.2 Help

Macros

Macros provide a convenient way to automate repetitive procedures you do frequently while writing code. You can record, edit and play back macros, assign a shortcut to them, and share them.

  • Macros can be used to combine a sequence of editor-related actions within a file.

  • You cannot record button clicks, navigating to popups, and accessing tool windows, menus, and dialogs.

A temporary macro can be used without a name. For permanent macros, assign unique names.

Record a macro

  1. Open the Edit menu, point to Macros, and click Start Macro Recording.

  2. Perform necessary actions that you want to be recorded.

  3. Press the Stop button or select Edit | Macros | Stop Macro Recording.

  4. In the Enter Macro Name dialog, specify the name for the new macro and click OK.

    If the macro is intended for temporary use only, you can leave the name blank.

Play back a macro

  • To play back a temporary macro, open the Edit menu, point to Macros, and click Play Back Last Macro.

  • To play back a named macro, open the Edit menu, point to Macros, and click the necessary macro name.

Edit macros

  • Open the Edit menu, point to Macros, and click Edit Macros.

Bind a keyboard shortcut to a macro

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Keymap.

  2. Create a new keymap or select an existing keymap from the list of keymaps.

  3. Expand the Macros node and select the macro for which you want to create a keyboard shortcut.

  4. Right-click the macro and choose Add Keyboard Shortcut in the context menu.

  5. In the Enter Keyboard Shortcut dialog, press the key combination to be used as a shortcut.

    The keystrokes are immediately reflected in the First Stroke field. Optionally, select the Second stroke checkbox and specify the second stroke. As you press the keys, the Preview field displays the keystrokes you pressed, and the Conflicts field displays warnings, if the keystrokes are already in use.

  6. Click OK using the mouse pointer to assign the shortcut to the macro.

  7. Apply the changes.

Add a macro to a run/debug configuration

  1. Do one of the following:

    • From the main menu, choose Run | Edit Configurations.

    • With the Navigation Bar visible (View | Appearance | Navigation Bar), choose Edit Configurations from the run/debug configurations selector.

    • Press Alt+Shift+F10, then press 0 to display the Edit Configuration dialog, or select the configuration from the popup and press F4.

  2. In the Run/Debug Configurations dialog, select the target configuration from the list of the Python run/debug configurations.

  3. Click + in the Parameters field and select a macro from the list of the available macros.

  4. Click Insert to add the selected macro.

    See Pass parameters to the running script for an example of using a macro in a run/debug configuration.

Last modified: 19 August 2020