Creating and Editing Template Variables
On this page:
- Configuring variables used in a template
- Predefined Functions to Use in Live Template Variables
After a template is expanded, its variables are presented in the editor as input fields. The values of these fields can be either filled in by the user or calculated by PyCharm.
To have it done automatically, for each variable you need to specify the following:
- Expression to be calculated in association with the variable.
- Default value to be entered in the input field if the calculation fails.
The order in which PyCharm will process input fields after the template expansion, is determined by the order of variables in the list.
Configuring variables used in a template
Open the template settings, and in the Template Text area
click the Edit Variables button.
The Edit Variables button is enabled only if the template body contains at least one user-defined variable, that is, a variable different from
The Edit Template Variables dialog box opens, where you can define how the variables will be processed when the template is used.
- In the Name text box, specify the variable name to be used in the template body.
- In the Expression drop-down list, specify the expression to be calculated by
PyCharm when the template is expanded. Do one of the following:
- Type a string constant in double quotes.
- Type a predefined function with possible arguments or select one from the drop-down list.
An argument of a function can be either a line constant or another predefined function. See the list of predefined functions below on this page.
- To enable PyCharm to proceed with the next input field, if an input field associated with the current variable is already defined, select the Skip if defined check box.
- To arrange variables in the order you want PyCharm to switch between associated input fields, use the Move Up and Move Down buttons.
Predefined Functions to Use in Live Template Variables
|Returns the string passed as a parameter, converted to camel case. For example,
|Capitalizes the first letter of the name passed as a parameter.|
|Capitalizes the all letters of a CamelCase name passed as a parameter, and inserts an underscore
between the parts. For example, if the string passed as a parameter is |
|This expression substitutes for the class name completion at the variable position.|
|Returns the contents of the system clipboard.|
|Returns CamelCase string out of snake_case string. For example, if the string passed as a parameter is
|This expression substitutes for the code completion invocation at the variable position.|
|This expression substitutes for the smart type completion invocation at the variable position.|
Returns the current system date in the specified format.
By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:
|Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter.|
|Shows completion popup for the available Django blocks.|
|Shows completion popup for the available Django filters.|
|Shows completion popup for the available Django template tags|
|Shows completion popup for the available Django variable.|
|List of comma-delimited strings suggested for completion at the template invocation.|
|Escapes the specified string.|
|Returns the type which is expected as a result of the whole template. Makes sense if the template is expanded in the right part of an assignment, after return, etc.|
|Returns file name with extension.|
|Returns file name without extension.|
|Returns the first word of the string passed as a parameter.|
|Returns the current line number.|
|Returns lower case separated by dashes, of the string passed as a parameter. For example, the string
|Returns snake_case string out of CamelCase string passed as a parameter.|
|Returns string separated with spaces out of CamelCase string passed as a parameter. For example, if the
string passed as a parameter is |
|Returns the name of the current Python class (the class where the template is expanded).|
|Returns the name of the current Python function.|
|Returns the current system time.|
|Returns the string passed as a parameter with CamelHump letters substituting for underscores.
For example, if the string passed as a parameter is |
|Returns the string passed as a parameter with spaces substituting for underscores.|
|Returns the name of the current user.|
|Returns a suggested name for an index.|
|Returns a suggested name for a variable.|