文件模板变量

一个文件模板可以包含变量，应用模板时会用其值替换这些变量。变量是以美元符号 $ 开头、后跟变量名称的字符串。变量名称可以选择用花括号括起来。例如： $MyVariable 和 ${MyVariable} 是同一变量的不同表示法。

在模板正文和文件名中都可以使用预定义变量和自定义变量。例如，如果在模板的文件名字段中键入 MyFile_${MONTH_NAME_FULL} ，且是在四月创建，则生成的文件将被命名为 MyFile_April。此处， ${MONTH_NAME_FULL} 是一个预定义变量。如果改用自定义变量，PyCharm 会在基于此模板创建文件时提示您输入变量值。

预定义模板变量

文件模板中可以使用以下预定义变量：

变量	说明
`${DATE}`	当前系统日期
`${DAY}`	当前月份中的日
`${DIR_PATH}`	新文件所在目录的路径（相对于项目根目录）
`${DS}`	美元符号 `$`。此变量用于转义美元符号，使其不会被视为模板变量的前缀。
`${FILE_NAME}`	新文件的名称
`${HOUR}`	当前小时
`${MINUTE}`	当前分钟
`${SECOND}`	当前秒
`${MONTH}`	当前月份
`${MONTH_NAME_FULL}`	当前月份的完整名称（ January、February 等）
`${MONTH_NAME_SHORT}`	当前月份名称的前三个字母（ Jan、Feb 等）
`${NAME}`	新实体（文件、类、接口等）的名称
`${PRODUCT_NAME}`	IDE 的名称（例如，PyCharm）
`${PROJECT_NAME}`	当前项目的名称
`${TIME}`	当前系统时间
`${USER}`	当前用户的登录名
`${YEAR}`	当前年份

变量方法

由于 PyCharm 使用 Velocity 作为文件模板的模板引擎，您可以在模板中应用方法并使用逻辑结构。

Java String 方法

模板变量支持 Java String 方法。例如，可以执行以下操作：

${NAME.toUpperCase()} ：将新实体（文件）的名称转换为大写字母。
${PROJECT_NAME.length()} ：输出项目名称的长度。
${PRODUCT_NAME.substring(0,5)} ：输出您所用 IDE 名称的前五个字符。

VTL 指令

除了变量方法，PyCharm 还支持一些 VTL 指令，例如：

#set ：定义自定义变量。
#if、 #else ：条件语句。
#foreach ：迭代。

例如，您可以使用条件语句根据变量值调整模板的输出：

                #if (${PROJECT_NAME.length() > 10})
                    Long project: ${PROJECT_NAME}
                #else
                    Short project: ${PROJECT_NAME}
                #end
            
   

自定义模板变量

除了预定义模板变量之外，还可以指定自定义变量。如有必要，您可以在模板中使用 #set 指令直接定义自定义变量的值。请在使用相应变量之前编写该指令：

            #set( $MyName = "John Smith" )
            Created by: $MyName

如果模板中未定义变量的值，PyCharm 会在应用模板时要求您进行指定。

最后修改日期： 2025年 12月 2日