PyCharm 2017.2 Help

Edit Template Variables Dialog

File | Settings | Live Templates - Edit Variables for Windows and Linux
PyCharm | Preferences | Live Templates - Edit Variables for macOS
Ctrl+Alt+S
/help/img/idea/2017.2/settings.png


The dialog opens when you click the Edit Variables button in the Template Text area on the Live Templates page.

The Edit Variables button is enabled only if the template body contains at least one user-defined variable, that is, a variable different from $END$ or $SELECTION$.

Use this dialog box to create and edit expressions for variables in the selected live template.

On this page:

Controls

ItemDescription
NameIn this text box, view or edit the variable name in the format $<variable_name>$.
ExpressionIn this text box, specify the expression to have the value of the corresponding template input field calculated automatically.

This expression may contain constructs of the following basic types:

  • String constants in double quotes.
  • The name of another variable defined in a live template.
  • Predefined functions with possible arguments.

Type an expression manually or select a predefined function from the drop-down list. The list shows also the number and type of parameters, if any, for the selected function. The available functions are listed alphabetically in the Functions table.

Default valueIn this text box, specify the default string to be entered in the corresponding input field of the expanded template, if the expression does not give any result after calculation.

Note that a default value of a variable is an expression that can refer to other live template variables. To define the default value as a literal, enclose it in quotation marks.

Skip if definedSelect this check box to have PyCharm proceed with the next input field, if the value of the current input field is defined.
Move Up / Move DownUse these buttons to change the order of variables in the list. The order of variables in the table determines the order in which PyCharm will switch between the corresponding input fields when the template is expanded.
Last modified: 26 October 2017

See Also