PyCharm 2020.2ヘルプ

ファイル・テンプレート

ファイルテンプレートは、新しいファイルを作成するときに生成されるデフォルトのコンテンツの仕様です。作成しているファイルのタイプに応じて、テンプレートは、そのタイプのすべてのファイル(業界標準、企業ポリシー、またはその他の理由による)に含まれると予想される初期コードとフォーマットを提供します。

Example of using code and file templates in PyCharm

PyCharmは、サポートされているすべてのファイルタイプに対して事前定義されたテンプレートを提供します。これは、新しいファイル(Ctrl+Alt+Insert)を作成するときに推奨されます。推奨されるファイルタイプのセットは、モジュールと構成、およびプロジェクトツールウィンドウでの現在の場所のプロパティによって異なります。例:PyCharmは、Pythonソースまたはテストディレクトリの外部にPythonファイルを作成することを提案しません。

ファイルテンプレートは、設定/環境設定 Ctrl+Alt+Sエディター | ファイルおよびコード・テンプレートページで管理されます。この設定ページは、次の2つのスコープのいずれかで構成できます。

  • デフォルトスコープは、ワークスペース全体に関連するテンプレートを制御します。これらはfileTemplatesIDE構成ディレクトリに格納されています。

  • プロジェクトスコープは、プロジェクトごとにテンプレートを制御します。それらは.idea/fileTemplatesのプロジェクトフォルダーに保存されます。これらのテンプレートは、チームメンバー間で共有することができます。

デフォルトでは、テンプレートのリストにはPyCharmが提供する定義済みのテンプレートのみが含まれています。そのうちのいくつかは内部的なものです。つまり、削除や名前の変更はできません。内部テンプレートの名前は太字で示されています。手動で作成したカスタムテンプレートだけでなく、変更したテンプレートの名前も青色で表示されます。

PyCharmはいくつかのタイプのテンプレートを使用し、以下のタブに分かれています:

  • ファイルタブには、新しいファイルを作成するために使用できるファイルテンプレートが含まれています。

  • インクルードタブには、ファイルテンプレートに挿入できる再利用可能なコンテンツのテンプレート(ヘッダーなど)が含まれています。

  • コードタブには、さまざまな構文を生成するためにPyCharmが使用するコードフラグメント(スニペット)の内部テンプレートが含まれています。このタブでは利用可能なスニペットを編集できますが、新しいスニペットを作成することはできません。

    カスタムコードスニペットを作成するには、ライブ・テンプレートを使用します。

  • その他タブには、さまざまなアプリケーションサーバーおよびフレームワークで使用されるテンプレートが含まれています。このタブで既存のビルトインテンプレートを編集できますが、新しいテンプレートは作成できません。

次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。

新しいファイルテンプレートを作成する

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | ファイルおよびコード・テンプレートを選択します。

  2. ファイルタブで、the Create Template button をクリックして、テンプレートの名前、ファイル拡張子、および本文を指定します。

  3. 変更を適用し、ダイアログを閉じます。

既存のファイルテンプレートをコピーする

  1. 設定/環境設定ダイアログ Ctrl+Alt+Sで、エディター | ファイルおよびコード・テンプレートを選択します。

  2. ファイルタブで、the Copy Template button をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、および本文を変更します。

  3. 変更を適用し、ダイアログを閉じます。

ファイルをテンプレートとして保存する

  1. エディターでファイルを開きます。

  2. メニューからツール | ファイルをテンプレートとして保存を選択してください。

  3. 表示されるファイルをテンプレートとして保存ダイアログで、新しいテンプレート名を指定し、必要に応じて本文を編集します。

  4. 変更を適用し、ダイアログを閉じます。

構文

ファイルとコードのテンプレートはVelocityテンプレート言語(英語)(VTL)に書き込まれています。これにより、次の構文を使用できます。

  • そのままレンダリングされる固定テキスト(マークアップ、コード、コメントなど)。

  • 変数の値に置き換えられます。

  • #parse#set , #ifなどを含むさまざまなディレクティブ。

詳細は、VTLリファレンスガイド(英語)を参照してください。

次の例は、PyCharmでGherkin機能ファイルを作成するためのデフォルトテンプレートを示しています。

# Created by ${USER} at ${DATE} Feature: #Enter feature name here # Enter feature description here Scenario: # Enter scenario name here # Enter steps here

このテンプレートでは、${USER}${DATE} はテンプレート変数です。新しいGherkinファイルを作成すると、このテンプレートは次のような内容のフィーチャファイルを生成します。

# Created by jetbrains at 25.06.2018 Feature: #Enter feature name here # Enter feature description here Scenario: # Enter scenario name here # Enter steps here
最終更新日: 2020年9月14日