PyCharm 2.7.2 Web Help

File | Settings | IDE Settings | Live Templates

settings

PyCharm | Preferences | IDE Settings | Live Templates

settings

Use this page to create, manage, and edit live templates.

In this topic:

List of available live templates

ItemTooltip and shortcutDescription
By default expand withUse this drop-down list to specify the default invocation key for all templates. Individual invocation keys for particular templates are defined in the editing area below.
Live TemplatesThis list shows all currently available template abbreviations supplied with their descriptions. The abbreviations are grouped below nodes and sorted alphabetically within each group. To activate a template or an entire group, select the check box to its left.

Note

  • Only active templates are displayed upon pressing Ctrl+JCtrl+J in the editor.
  • If a template is active, the editor is sensitive to its abbreviation. Otherwise, the abbreviation is considered merely a set of characters.
add,pngAdd
Alt+InsertAlt+Insert 		Click this button to have a new template item added to the current group of template. You can define the template abbreviation, description, text, variables, expansion key, and context in the editing area below.
delete.pngRemove
DeleteDelete 		Click this button to have the selected live template removed from the list.
copy.gifCopyClick this button to create a new template based on the selected template. A new template item is added to the current node and the fields in the Template Text area show the definition of the selected template.

Template editing area

The focus is moved to this area in the following cases:

  • When you click the Add add,png or Copy copy.gif button.
  • When you select a live template in the list.
  • When you select a fragment of code in the editor and choose Tools | Save as Live Template.

Use controls of this area to create new live templates and edit settings of the existing ones.

Tip

You can navigate through the Template Text Area using the hot keys that are marked in the field labels.

ItemDescription
Abbreviation In this text box, specify the template abbreviation.
DescriptionIn this text box, provide optional description of a template or an example of its usage.
Template TextIn this text box, type the template body that may contain plain text and variables in the format $<variable name>$.

When editing the live template variables, mind the following helpful hints:

  • If you need a dollar sign ($) in the template text, escape it by duplicating this character ($$).
  • To change variables in a template, click the Edit Variables button.

Note

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$.

PyCharm supports two predefined live template variables: $END$ and $SELECTION$.

Note

You cannot edit the predefined live template variables $END$ and $SELECTION$.

  • $END$ indicates the position of the cursor after the template is expanded. For example, the template return $END$ will be expanded into

    return ;

    with the cursor positioned right before the semicolon.

  • $SELECTION$ is used in surround templates and stands for the code fragment to be wrapped. After the template is expanded, the selected text is wrapped as specified in the template.

    For example, if you select EXAMPLE in your code and invoke the "$SELECTION$" template via the assigned abbreviation or by pressing Ctrl+Alt+TCtrl+Alt+T and selecting the desired template from the list, PyCharm will wrap the selection in double quotes as follows:

    "EXAMPLE".

Applicable in:This read-only field shows the languages and/or pieces of code where the editor should be sensitive to the template. Upon pressing Ctrl+JCtrl+J in such context, PyCharm displays a list of templates that are valid for this context.
Change Click this link to modify the set of contexts where the current template is enabled. Upon clicking the link, displays a list of supported language contexts is displayed. To make PyCharm consider a context sensitive to the template, select a check box next to the context name.

The available context types depend on the enabled plugins.

Edit Variables Click this button to open the Edit Template Variables dialog box, where you can define how PyCharm should process template variables upon template expansion.

Note

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$.

OptionsIn this area, define the behavior of the editor when a template is expanded.
  • Expand with - from this drop-down list, choose the key to invoke the template.
  • Reformat according to style - select this check box to have PyCharm automatically reformat the expanded text according to the current style settings, defined in the Code Style dialog box.

See Also

Concepts:

Procedures:

Reference:

Web Resources: