【Pycharm】Pycharm创建.py文件时自动生成文件头

引言

在大家平常创建.py文件时可能会需要生成文件头以注释编写该文件的时间和作者等内容，大致分为两种办法：自己编写 | 套用模板

自己编写

这里的自己编写指的是在想要创建一个新的文件时通过纯手敲或者编写一个python脚本来实现生成文件头的过程。
读者可参考此文章：【Python】使用Python脚本生成文件头注释
笔者在此不再赘述

套用模板

Pycharm中可以让用户自定义模板来实现创建某个文件（.py or .html等）时自动生成定义的模板中的内容来偷懒减轻工作量（DRY原则）。

还记得使用Pycharm创建.html文件时代码中会自动给你生成必要的html结构么？

没错，那就是安装Pycharm时自带的模板（Apache Velocity 模板语言）

接下来让我们尝试创建自己创建文件时想要的文件模板（笔者的Pycharm经过汉化，汉化教程请笔者自行搜索，模板创建步骤与未汉化之前一样）：
以.py文件模板创建为例

步骤一

文件 ➡设置 # 中文版步骤
File ➡ Settings # 英文版步骤

步骤二

编辑器 ➡ 文件和代码模板
Editor ➡ File and Code Templates

步骤三

Python Script ➡ 模板框内输入想要的模板 ➡ 确定

上述设置完成后再次新建.py文件就会默认出现笔者设置的默认模板
如下：

参考变量

其中的参考变量可在创建模板时的描述上查看：

笔者在此复制到此：

在文件模板中，您可以使用文本、代码、注释和预定义变量。 以下提供了预定义变量的列表。 当您在模板中使用这些变量时，它们稍后会在编辑器中扩展为相应的值。
您也可以指定自定义变量。 自定义变量使用以下格式：${VARIABLE_NAME}，其中 VARIABLE_NAME 是变量的名称（例如，${MY_CUSTOM_FUNCTION_NAME}） 。 在 IDE 创建包含自定义变量的新文件之前，您会看到一个对话框，您可以在其中定义模板中自定义变量的值。
通过使用 #parse 指令，可以包括 包含 标签页中的模板。 要包含模板，请在引号中将模板的全名指定为形参（例如，#parse(“File Header”)）。
预定义变量列表

变量名	描述
${DATE}	当前系统日期
${DAY}	当前月份的日期
${DAY_NAME_SHORT}	当前日期名称的前 3 个字母（例如，Mon、Tue 等）
${DAY_NAME_FULL}	当前日期的全名（Monday、Tuesday 等）
${DIR_PATH}	新文件的目录路径（相对于项目根目录）
${DS}	美元符号 （$）。 此变量用于转义美元字符，因此不会将其视为模板变量的前缀。
${FILE_NAME}	新文件名称
${HOUR}	当前小时
${MINUTE}	当前分钟
${SECOND}	当前秒
${MONTH}	当前月份
${MONTH_NAME_SHORT}	当前月份名称的前 3 个字母（Jan、Feb 等）
${MONTH_NAME_FULL}	当前月份的全名（January、February 等）
${NAME}	新实体的名称（文件、类型、接口等）
${ORGANIZATION_NAME}	在项目设置中指定的组织名称
${PRODUCT_NAME}	IDE 名称
${PROJECT_NAME}	当前项目名称
${TIME}	当前系统时间
${USER}	当前用户的系统登录名
${YEAR}	当前年度