Live template variables
When you expand a live template abbreviation, its variables either appear as input fields where you can type values or are replaced with values. These may be default values that you can modify or values calculated using functions.
To declare variables within templates, use the following format:
Define each variable using an expression and provide a default value for cases when the expression fails to evaluate.
This expression may contain the following constructs:
String constants in double quotes
Names of other variables defined in a live template
Predefined functions with possible arguments
Configure template variables
In the Settings/Preferences dialog Ctrl+Alt+S, go to .
Select a template where you want to configure variables.
Specify variables in the template text and click Edit variables.
In the Edit Template Variables dialog, you can do the following for each variable:
Change the variable name
Define the expression using predefined functions
Specify the default value for cases when the expression fails to evaluate
Specify whether you want to skip the variable when prompting the user for input if the expression evaluated successfully
Predefined template variables
PyCharm supports the following predefined live template variables that cannot be modified:
$END$indicates the position of the cursor when the code snippet is complete, and you can no longer press Tab to jump to the next variable.
$SELECTION$is used in surround templates and denotes the code fragment to be wrapped. After the template expands, it wraps the selected text as specified in the template. For example, if you select
EXAMPLEin your code and invoke the
"$SELECTION$"template via the assigned abbreviation or by pressing Ctrl+Alt+T and selecting the desired template from the list, PyCharm will wrap the selection in double quotes as follows:
Functions used in live template variables
The following functions can be used to define live template variables:
Returns the characters that indicate the end of a block comment in the current language context.
Returns the characters that indicate the start of a block comment in the current language context.
Converts a string into camelCase.
Capitalizes the first letter of a string.
Capitalizes all the letters of a string, and inserts an underscore between the parts.
|Returns the contents of the system clipboard.|
|Returns the characters that indicate the end of a comment in the current language context. For languages with line comments, the return value is empty.|
|Returns the characters that indicate the start of a comment in the current language context. For languages with line comments, the return value is the start of a line comment, same as lineCommentStart().|
|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.
By default, without a parameter, it returns the date in the current system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the
Replaces the first letter of a string with the corresponding lowercase letter.
|Returns the default value if the expression is used in the return statement. Uses the |
|Shows completion popup for the available Django blocks.|
|Shows completion popup for the available Django filters.|
|Shows comFpletion popup for the available Django template tags|
|Shows completion popup for the available Django variable.|
Returns a list of strings suggested for completion when the template expands.
Escapes special characters so that the result can be used in a Java string.
For example, it replaces the tab character with
| Returns the expected type of the expression where 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 absolute path to the current file.|
|Returns the current file path relative to the current project. To check what the relative path is for a given file, right-click it and select Copy Reference, or press Ctrl+Alt+Shift+C.|
Returns the first word of the string passed as the parameter.
Executes the Groovy script passed as a string.
The first argument is a string with either the text of the script or the path to the file that contains the script. The function passes other optional arguments to the script as values for
| Based on the name of the module, returns the parameter from |
| 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 list is shown with |
| Suggests the name for import statements of the type |
| 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.
|Returns the characters that indicate the start of a line comment in the current language context.|
|Returns the current line number.|
| Converts a 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.|
Enables scope specific completion for the iterable variables.
| Finds all occurrences of |
Returns the parameter details when adding a parameter to a function or method.
Example of usage:
| Converts a string into snake_case. For example, |
| Returns the specified string with spaces as separators. For example, |
| Replaces spaces with underscores in the string passed as the parameter. For example, |
| Returns the substring up to the specified delimiter. This is helpful for removing the extensions in test file names. For example, |
Returns the current system time.
By default, without a parameter, it returns the time in the current system format. To use a different format, provide a parameter according to the SimpleDateFormat specification. For example, the
| Transforms a string with underscores (like snake_case) into camelCase. For example, |
| Transforms underscores in a string to spaces. For example, |
|Returns the name of the current user.|