ファイルテンプレート変数

ファイルテンプレートには変数を含めることができます。変数は、テンプレートが適用されるときに値に置き換えられます。変数は、ドル記号 $ で始まり、その後に変数名が続く文字列です。変数名は、オプションで波括弧で囲むことができます。たとえば、$MyVariable と ${MyVariable} は同じ変数の異なる表記法です。

事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。例: テンプレートのファイル名フィールドに MyFile_${MONTH_NAME_FULL} と入力した場合、4 月に作成すると、結果のファイルの名前は 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}`	現在の月名の最初の 3 文字 (Jan、Feb など)
`${NAME}`	新しいエンティティの名前 (ファイル、クラス、インターフェースなど)
`${PRODUCT_NAME}`	IDE の名前 (たとえば、PyCharm)
`${PROJECT_NAME}`	現在のプロジェクトの名前
`${TIME}`	現在のシステム時刻
`${USER}`	現在のユーザーのログイン名
`${YEAR}`	現在の年

変数メソッド

PyCharm はファイルテンプレートのテンプレートエンジンとして Velocity(英語) を使用するため、テンプレート内でメソッドを適用したりロジック構造を使用したりできます。

Java の文字列メソッド

テンプレート変数は Java 文字列メソッドをサポートします。例: 次のことが可能です。

${NAME.toUpperCase()} : 新しいエンティティ (ファイル) の名前を大文字に変換します。
${PROJECT_NAME.length()} : プロジェクト名の長さを出力します。
${PRODUCT_NAME.substring(0,5)} : 使用している IDE の名前の最初の 5 文字を出力します。

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 年 9 月 09 日

PyCharm 2025.3 ヘルプ