PyCharm 2017.2 Help

Creating Code Constructs by Live Templates

Introduction

This page describes how to generate source code using live templates.

Using Live Templates enables you to create such code constructs as Django templates, JavaScript iterations, Zen coding, HTML and XML tags.

To explore the list of available live templates, in the Settings/Preferences dialog, open the Live Templates page.

Inserting a live template

  1. Place the caret at the desired position, where the new construct should be added.
  2. Do one of the following:
    • On the main menu, choose Code | Insert Live Template.
    • Press Ctrl+J.
    • Type some initial letters of the template abbreviation to get the matching abbreviations in the suggestion list. Note that the suggestion list may contain same abbreviations for different templates.
  3. From the suggestion list, select the desired template. While the suggestion list is displayed, it is possible to view Quick Documentation for the items at caret, by pressing Ctrl+Q.
    /help/img/idea/2017.2/py_qdoc_live_template.png
  4. Press the template invocation key (this may be Space, Tab or Enter, depending on the template definition). The new code construct is inserted in the specified position.
  5. If the selected template is parametrized and requires user input, the editor enters the template editing mode and displays the first input field highlighted with the red frame. Type your value in this frame and press Enter or Tab to complete input and pass to the next input field. After completing the last input field, the caret moves to the end of the construct, and the editor returns to the regular mode of operation.

It is also possible to type a template abbreviation, and then press Ctrl+J.

Last modified: 26 October 2017