ファイルテンプレート
ファイルテンプレートは、プロジェクトツリーのコンテキストメニューの メニューまたは 新規 セクションを使用して作成する新しいファイルの既定の内容の仕様です。
作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。
PyCharm は、新しいファイルを作成する際に提案される、サポートされているすべてのファイル型の定義済みテンプレートを提供します。 推奨されるファイルタイプのセットは、モジュールと構成、 Project ツールウィンドウの現在の場所のプロパティによって異なります。 例えば、PyCharm は Python ソースまたはテストディレクトリの外で Python ファイルを作成することを提案しません。
ファイルテンプレートの管理と構成
Ctrl+Alt+S を押して設定を開き、 を選択します。
詳細については、 ファイルおよびコードテンプレート を参照してください。
デフォルトでは、テンプレート一覧には PyCharm が提供するあらかじめ定義されたテンプレートのみが含まれています。 その一部は内部テンプレートであり、削除や名前の変更はできません。 PyCharm は内部テンプレートの名前を太字で表示します。 変更したテンプレート名や手動で作成したカスタムテンプレート名は青色で表示されます。
次の手順では、ファイルテンプレートを作成する方法について説明します。 インクルードテンプレートの作成にも同様の手順を使用できます。
新しいファイルテンプレートを作成する
Ctrl+Alt+S を押して設定を開き、 を選択します。
スキーム リストを使用して、ファイルテンプレートが適用されるスコープを選択します。
デフォルト: IDE レベルで作成されたファイルテンプレート。 これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。 特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。 PyCharm は、グローバル テンプレートを IDE 構成ディレクトリ の fileTemplates に保存します。
Project: 現在のプロジェクトに固有のファイルテンプレート。 これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。 PyCharm は、 .idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイル タブで、
をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。変更を適用して、ダイアログを閉じます。
既存のファイルテンプレートをコピーする
Ctrl+Alt+S を押して設定を開き、 を選択します。
ファイル タブで、
をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。変更を適用して、ダイアログを閉じます。
ファイルをテンプレートとして保存する
エディターでファイルを開きます。
メインメニューで へ移動します。
ファイルをテンプレートとして保存 ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。 ファイルテンプレートで使用される構文の詳細については、「構文 」を参照してください。
ファイル名: 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。 デフォルトでは、PyCharm はファイルを追加するときにユーザーに名前の入力を促します。 特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。 例えば、指定した名前を使用して、ファイル作成時に選択したディレクトリの上位ディレクトリに配置する方法は次のとおりです:
../${NAME}Reformat according to style: このファイルタイプに定義された コードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
Enable Live Templates: ファイルテンプレート内に ライブテンプレートを挿入します。 Velocity エスケープ構文を使用して、ファイルテンプレート内に ライブテンプレート変数を含めます。たとえば:
#[[ $MY_VARIABLE$ $END$ ]]#
変更を適用して、ダイアログを閉じます。
構文
ファイルテンプレートは Velocity Template Language (VTL) を使用しており、以下の構文が含まれています：
プレーンテキストはそのままレンダリングされます。
値に置き換えられる 変数。 例:
${NAME}は、ファイルを追加するときにユーザーが指定した名前を挿入します。#parse、
#set、#ifなどを含むさまざまなディレクティブ。
$ または # の入力を開始して、使用可能な変数およびディレクティブの 補完候補を参照します。
詳細については、 VTL リファレンスガイド(英語)を参照してください。