PyCharm 2016.3 Help

Save File as Template Dialog

PyCharm helps you create the file templates from the existing files.

ItemDescription
NameSpecify here the name under which the new template will appear in the Files tab of the File and Code Templates settings. By default, the name of the current file is used.
ExtensionSpecify here the extension of the file to be created by this new template. By default, the extension of the current file is used.
Template textEdit the template contents. You can use:
  • Plain text.
  • #parse directives to work with template includes.
  • Custom variables. Their names can be defined right in the template through the #set directive or will be defined during the file creation.
  • Variables to be expanded into corresponding values in the ${<variable_name>} format.

    The available predefined file template variables are:

    • ${PROJECT_NAME} - the name of the current project.
    • ${NAME} - the name of the new file which you specify in the New File dialog box during the file creation.
    • ${USER} - the login name of the current user.
    • ${DATE} - the current system date.
    • ${TIME} - the current system time.
    • ${YEAR} - the current year.
    • ${MONTH} - the current month.
    • ${DAY} - the current day of the month.
    • ${HOUR} - the current hour.
    • ${MINUTE} - the current minute.
    • ${PRODUCT_NAME} - the name of the IDE in which the file will be created.
    • ${MONTH_NAME_SHORT} - the first 3 letters of the month name. Example: Jan, Feb, etc.
    • ${MONTH_NAME_FULL} - full name of a month. Example: January, February, etc.

    Treating dollar sign

    • You can prevent treating dollar characters ($) in template variables as prefixes. If you need a dollar character ($ inserted as is, use the ${DS} file template variable instead. When the template is applied, this variable evaluates to a plain dollar character ($).

      Examples:

      • To use some version control keywords (such as $Revision$, $Date$, etc.) in your default class template, write ${DS} instead of the dollar prefix ($).
      • The template code ${DS}this will be rendered as $this.
Reformat according to styleSelect this check box, to have PyCharm reformat generated stub files according to the style defined on the Code Style page.

This option is only available in the Files tab.

Enable Live TemplatesSelect this check box to use a live template inside a file template. So doing, one has to put the live template fragments into Velocity escape syntax.

For example:

#[[ $MY_VARIABLE$ $END$ ]]#

Thus, one can specify the cursor position. Note that it is required to use the live template variables here!

DescriptionThis read-only field provides information about the template, its predefined variables, and the way they work.

See Also

Last modified: 23 November 2016