Edit Template Variables Dialog
Use this dialog box to create and edit expressions for variables in the selected live template.
|Name||In this text box, view or edit the variable name in the format |
|Expression|| In 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:
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 value||In 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 defined||Select this checkbox to have PyCharm proceed with the next input field, if the value of the current input field is defined.|
|Move Up / Move Down||Use 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.|
Predefined Functions to Use in Live Template Variables
| Converts a string into camelCase. For example, |
|Capitalizes the first letter of the parameter.|
| Capitalizes all the letters of a CamelCase name passed as the parameter, and inserts an underscore between the parts. For example, |
|This expression substitutes for the class name completion at the variable position.|
|Returns the contents of the system clipboard.|
|Invokes code completion at the position of the variable.|
|Invokes smart type completion at the position of the variable.|
| ||Returns a concatenation of all the strings passed to the function as parameters.|
Returns the current system date in the specified format.
Without a parameter, the current date is returned in the default system format.
|Replaces the first letter of the 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.|
|Returns a list of comma-separated strings suggested for completion when the template is expanded.|
|Escapes the string specified as the parameter.|
|Returns the expected type of the expression into which the template expands. Makes sense if the template expands in the right part of an assignment, after |
|Returns the name of the current file with its extension.|
|Returns the name of the current file without its extension.|
|Returns the first word of the string passed as the parameter.|
| || Based on the name of the module, returns the parameter from |
| Returns a suggested name for an index variable from most commonly used ones: |
| Returns the suggested name for a variable based on its variable type and initializer expression, according to your code style settings that refer to the variable naming rules.|
For example, if it is a variable that holds an element within an iteration, PyCharm makes a guess on the most reasonable name, taking into account the name of the container that is iterated.
| || The Boolean parameter determines whether constants are allowed or not in the current context. If no parameter is specified, constants are allowed. When the templates expands, a drop-down list is shown with |
| || Suggests the name for import statements of the type |
|Returns the current line number.|
| Converts a camelCase string into lower case and inserts n-dashes as separators. For example, |
|Returns the name of the current Python class (the class where the template is expanded).|
|Returns the name of the current Python function.|
| Converts a string into snake_case. For example, |
| Converts a string into lowercase and inserts spaces as separators. For example, |
| Removes the extension after the specified delimiter and returns only the file name. This is helpful for test file names (for example, |
|Returns the current system time in the specified format.|
| Replaces underscores with camelCase letters in the string passed as the parameter. For example, |
| Replaces underscores with spaces in the string passed as the parameter. For example, |
|Returns the name of the current user.|