ファイルテンプレート
ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのメニューまたは新規セクションを使用して作成する新しいファイルの既定の内容の仕様です。
作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由に従って)。
PyCharm は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。推奨されるファイルタイプのセットは、モジュールと構成、プロジェクトツールウィンドウの現在の場所のプロパティによって異なります。例: PyCharm は、Python ソースまたはテストディレクトリの外部に Python ファイルを作成することを提案しません。
ファイルテンプレートの管理と構成
Ctrl+Alt+S を押して設定を開き、を選択します。
詳細は、ファイルおよびコードテンプレートを参照してください。
デフォルトでは、テンプレートのリストには、PyCharm によって提供される事前定義されたテンプレートのみが含まれています。それらのいくつかは内部的なものです。つまり、削除したり名前を変更したりすることはできません。PyCharm は、内部テンプレートの名前を太字で示しています。変更したテンプレートの名前、および手動で作成したカスタムテンプレートは、青色で表示されます。
次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。
新しいファイルテンプレートを作成する
Ctrl+Alt+S を押して設定を開き、を選択します。
スキームリストを使用して、ファイルテンプレートが適用されるスコープを選択します。
デフォルト : IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。PyCharm は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに保存します。
プロジェクト : 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。PyCharm は、.idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイルタブで、
をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。変更を適用し、ダイアログを閉じます。
既存のファイルテンプレートをコピーする
Ctrl+Alt+S を押して設定を開き、を選択します。
ファイルタブで、
をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。変更を適用し、ダイアログを閉じます。
ファイルをテンプレートとして保存する
エディターでファイルを開きます。
メインメニューで、に移動します。
「ファイルをテンプレートとして保存」ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。
ファイル名 : 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、PyCharm はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します:
../${NAME}スタイルに応じて整形 : このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
ライブテンプレートを使用可能にする : ファイルテンプレート内にライブテンプレートを挿入します。Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます（例:
#[[ $MY_VARIABLE$ $END$ ]]#）。
変更を適用し、ダイアログを閉じます。
構文
ファイルテンプレートは Velocity テンプレート言語 (英語)(VTL) を使用します。これには、次の構成が含まれます。
プレーンテキストはそのままレンダリングされます。
値に置き換えられる変数。例:
${NAME}は、ファイルを追加するときにユーザーが指定した名前を挿入します。#parse、
#set、#ifなどを含むさまざまなディレクティブ。
$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を参照します。
詳細については、VTL リファレンスガイド(英語)を参照してください。
関連ページ：
プロジェクトを開く、再開、閉じる
初めてプロジェクトを開くと、ウェルカム画面が表示されます。ディスクからプロジェクトを開くか、バージョン管理システムからダウンロードできます。プロジェクトを開く：ディスクからプロジェクトを開く以下のいずれか 1 つを実行します: に移動します。ウェルカム画面で、オープンをクリックします。、開いたファイルまたはプロジェクトを開くダイアログで、目的のプロジェクトディレクトリの場所を見つけます。PyCharm プロジェクトはでマークされ、他の IDE または専用エディターで作成されたプロジェクトはでマー...
ファイルおよびコードテンプレート
PyCharm は、ファイルテンプレートで説明されているファイルテンプレートを使用してファイルを作成します。このページを使用して、そのようなテンプレートを表示、編集、作成します。スキームファイルテンプレートを適用するスコープを選択します。デフォルト: IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。PyCharm は、グローバルテン...
ライブテンプレート変数
ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値、または関数を使用して計算された値である場合があります。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します（例:）。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定...
コード補完
基本コード補完は、可視性スコープ内のクラス、メソッド、キーワードの名前を補完するのに役立ちます。PyCharm はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します。候補にはライブテンプレートも含まれます。補完機能は英語以外のキーボードレイアウトでも利用できます。基本補完を呼び出すデフォルトでは、PyCharm は入力時に自動的にコード補完ポップアップを表示します。あるいは、を押すか、メインメニューからを選択することもできます。基本コード補完を 2 回呼び出すと、依存関...
インテンションアクション
エディターで作業すると、PyCharm がコードを分析し、最適化の方法を探します。インテンションのアクションは、エラーや警告から最適化の提案まで、幅広い状況をカバーします。IDE がコードを改善する方法を見つけるとすぐに、エディター内の現在の行の横に黄色のバルブアイコンが表示されます。このアイコンをクリックすると、現在のコンテキストで利用可能なインテンションアクションが表示されます。感嘆符が付いた赤いバルブは、PyCharm が問題を検出したことを示し、関連する修正（クイックフィックス）を選択す...