ライブ・テンプレート

このページを使用して、ライブテンプレートを作成、管理、および編集します。

メイン設定

項目	説明
デフォルトで展開		すべてのテンプレートのデフォルトの呼び出しキーを指定します。特定のテンプレート用の個々の拡張キーは編集領域で定義されています。標準の拡張キー（`Tab` , `Enter`または `Space`）が望ましくない場合は、このリストからカスタムオプションを選択します。カスタムを選択すると、変更リンクがドロップダウンの横に表示され、キーマップページに移動します。
ライブ・テンプレート		現在使用可能なすべてのテンプレートの省略形とその説明を表示します。略語はノードにグループ化され、各グループ内でアルファベット順にソートされています。テンプレートまたはグループ全体をアクティブにするには、テンプレートまたはグループの近くにあるチェックボックスを選択します。アクティブなテンプレートだけがエディターに表示されます。テンプレートがアクティブな場合、エディターはその略語に敏感です。それ以外の場合、省略形は一連の文字と見なされます。
	`Alt+Insert`を追加	新しいテンプレート項目を現在のテンプレートグループに追加します。下の編集領域で、テンプレートの省略形、説明、テキスト、変数、展開キー、およびコンテキストを定義できます。
	`Delete`を削除する	選択したライブテンプレートをリストから削除します。
	複製	このボタンをクリックして、選択したテンプレートに基づいて新しいテンプレートを作成します。新しいテンプレート項目が現在のノードに追加され、テンプレートテキスト領域のフィールドに選択したテンプレートの定義が表示されます。
	削除したデフォルトを復元	このボタンをクリックして、削除されたライブテンプレートを復元します。このボタンは、変更が適用されたときにのみ有効になります。

ライブテンプレートのコンテキストメニュー

項目	説明
移動	選択したテンプレートを指定したグループに移動します。
コンテキストを変更する	現在のテンプレートが有効になっているコンテキストを変更します。このコマンドを選択すると、サポートされている言語コンテキストのリストが表示されます。PyCharmがテンプレートに依存するコンテキストを考慮するようにするには、コンテキスト名の横にあるチェックボックスを選択します。利用可能なコンテキストタイプは有効なプラグインによって異なります。
コピー	システムクリップボードにシリアル化されたテンプレートXMLを作成します。
貼り付け	コピーしたテンプレートの XML表現を選択したテンプレートのグループに貼り付けます。
デフォルトを復元	このコマンドは、変更されたテンプレートのコンテキストメニューに青色で表示されている場合にのみ表示されます。このコマンドを選択して、デフォルトのテンプレート設定を復元します。

テンプレート編集エリア

次の場合には、フォーカスがこの領域に移動します。

追加またはコピーボタンをクリックしたとき。
リストからライブテンプレートを選択したとき。
エディターでコードの一部を選択してツール | ライブ・テンプレートとして保存を選択したとき。

この領域のコントロールを使用して新しいライブテンプレートを作成し、既存のテンプレートの設定を編集します。

フィールドラベルにマークされているホットキーを使用して、テンプレートテキスト領域を移動できます。

項目	説明
略語	このフィールドでは、テンプレートの略語、つまりエディターでテンプレートを識別する文字列を指定します。
説明	このフィールドには、テンプレートのオプションの説明またはその使用例を提供します。
テンプレート・テキスト	このフィールドに、プレーンテキストと変数 $<variable name>$ の形式を含むテンプレート本文を入力します。必要に応じて、変数の編集をクリックし、必要に応じて変数を構成します。テンプレートテキスト内のドル記号 `$` をエスケープするには、単に `$$`を複製します。
に適用：	この読み取り専用フィールドには、エディターがテンプレートを認識するための言語やコード部分が表示されます。そのような状況で `Ctrl+J` を押すと、PyCharmはこの状況で有効なテンプレートのリストを表示します。
変更	現在のテンプレートが有効になっているコンテキストのセットを変更するには、このリンクをクリックします。リンクをクリックすると、サポートされている言語のコンテキストのリストが表示されます。PyCharmがテンプレートに依存するコンテキストを考慮するようにするには、コンテキスト名の横にあるチェックボックスを選択します。利用可能なコンテキストタイプは有効なプラグインによって異なります。
変数の編集	このボタンをクリックしてテンプレート変数の編集ダイアログを開きます。ここで、PyCharmがテンプレート展開時にテンプレート変数を処理する方法を定義できます。テンプレート変数の編集ダイアログには、使用可能な機能の完全なリストが含まれています。このページの以下の事前定義関数のリストを参照してください。変数の編集ボタンは、テンプレート本体に少なくとも1つのユーザー定義変数、つまり $END$ または $SELECTION$ とは異なる変数が含まれている場合にのみ有効になります。
オプション	この領域では、テンプレートが展開されたときのエディターの動作を定義します。展開 - このリストから、テンプレートを呼び出すキーを選択します。スタイルに応じて再フォーマット - このチェックボックスを選択すると、PyCharmはコードスタイルページで定義されている現在のスタイル設定に従って展開されたテキストを自動的に再フォーマットします。

ライブテンプレート変数で使用される定義済み関数

項目	説明
`blockCommentEnd`	現在の言語のコンテキストでブロックコメントの終わりを示す文字を返します。
`blockCommentStart`	現在の言語コンテキストでのブロックコメントの開始を示す文字を返します。
`camelCase(String)`	文字列をcamelCaseに変換します。例： `camelCase(my-text-file)` , `camelCase(my text file)`と `camelCase(my_text_file)` はすべて `myTextFile`を返します。
`capitalize(String)`	パラメータの最初の文字を大文字にします。
`capitalizeAndUnderscore(String)`	パラメータとして渡されたCamelCase名のすべての文字を大文字にし、部分の間にアンダースコアを挿入します。例： `capitalizeAndUnderscore(FooBar)` は `FOO_BAR`を返します。
`classNameComplete()`	この式は、変数位置でのクラス名補完の代わりになります。
`clipboard()`	システムクリップボードの内容を返します。
`collectionElementName()`	`_list` と複数のエンディングを削除します。
`commentEnd()`	現在の言語のコンテキストでコメントの終わりを示す文字を返します。現在の言語で行コメントが定義されている場合、戻り値は空です。
`commentStart()`	現在の言語のコンテキストでコメントの始まりを示す文字を返します。行コメントが現在の言語で定義されている場合は、それらの開始標識が望ましいです。
`complete()`	変数の位置でコード補完を呼び出します。
`completeSmart()`	変数の位置でスマート型補完を呼び出します。
`concat(expressions...)`	パラメータとして関数に渡されたすべての文字列の連結を返します。
`date(sDate)`	現在のシステム日付を指定された形式で返します。パラメータを指定しないと、現在の日付がデフォルトのシステムフォーマットで返されます。別のフォーマットを使用するには、SimpleDateFormat仕様に従ってパラメータを指定してください。例：関数 `date("Y-MM-d, E, H:m")` は、`2019 - 07 - 5, Fri, 12:56`としてフォーマットされた日付を返します。
`decapitalize(sName)`	パラメータの最初の文字を対応する小文字に置き換えます。
`defaultReturnValues`	式がreturn文で使用されている場合は、デフォルト値を返します。式がエラー・タイプである場合は、`errorVariableName` パラメーターを使用します。
`djangoBlock`	利用可能なDjangoブロックの補完ポップアップを表示します。
`djangoFilter`	使用可能なDjangoフィルタの補完ポップアップを表示します。
`djangoTemplateTags`	利用可能なDjangoテンプレートタグのcomFpletionポップアップを表示します
`djangoVariable`	利用可能なDjango変数の補完ポップアップを表示します。
`enum(sCompletionString1,sCompletionString2,...)`	テンプレートが展開されたときに補完候補として提案されるコンマ区切りの文字列のリストを返します。
`escapeString(sEscapeString)`	パラメータとして指定された文字列をエスケープします。
`expectedType()`	テンプレートの展開先となる式の予想される型を返します。テンプレートが `return`の後など、割り当ての正しい部分に展開されていれば意味があります。
`fileName()`	現在のファイルの名前とその拡張子を返します。
`fileNameWithoutExtension()`	現在のファイルの名前を拡張子なしで返します。
`filePath()`	現在のファイルへの絶対パスを返します。
`fileRelativePath()`	現在のプロジェクトに相対的な現在のファイルパスを返します。特定のファイルの相対パスを確認するには、ファイルを右クリックして参照のコピーを選択するか、`Ctrl+Shift+Alt+C`を押します。
`firstWord(sFirstWord)`	パラメータとして渡された文字列の最初の単語を返します。
`groovyScript("groovy code", arg1)`	指定されたコードを持つGroovyスクリプトを返します。 `groovyScript()` 関数は複数の引数で使用できます。最初の引数は、実行されるスクリプトのテキスト、またはそのスクリプトを含むファイルへのパスです。次の引数は、スクリプト内で使用可能な `_1` , `_2` , `_3`、... `_n` 変数にバインドされています。また、`_editor` 変数はスクリプト内で利用可能です。この変数は現在のエディターにバインドされています。
`JsArrayVariable()`	現在のJavaScript配列の名前を返します。
`jsClassName()`	現在のJavaScriptクラスの名前を返します。
`jsComponentTypeOf()`	現在のJavaScriptコンポーネントの型を返します。
`jsDefineParameter`	モジュールの名前に基づいて、`define(["module"], function (<parameter_in_question>>) {})`からパラメータを返します。
`jsMethodName()`	現在のJavaScriptメソッドの名前を返します。
`jsQualifiedClassName()`	現在のJavaScriptクラスの完全な名前を返します。
`jsSuggestIndexName()`	最も一般的に使用されているもの（ `i` , `j` , `k`以降）から、インデックス変数の推奨名を返します。現在のスコープでまだ使用されていない名前が最初に表示されます。
`jsSuggestVariableName()`	変数の命名規則を参照するコードスタイル設定に従って、変数のタイプと初期化式に基づいて、変数の推奨名を返します。例：反復内の要素を保持する変数の場合、PyCharmは、反復されるコンテナーの名前を考慮して、最も妥当な名前を推測します。
`jsSuggestDefaultVariableKind(Boolean)`	Booleanパラメータは、現在のコンテキストで定数が許可されるかどうかを決定します。パラメータが指定されていない場合は、定数が許可されます。テンプレートが展開されると、TypeScriptおよびES6の場合は `var` , `let` , `const` オプション、それ以前のバージョンのJavaScriptの場合は `var` オプションが1つだけのリストが表示されます。
`jsSuggestImportedEntityName()`	ファイル名に基づいて、タイプ `import * as $ITEM$ from "$MODULE$"` または `import $ITEM$ from "$MODULE$"` のインポートステートメントの名前を提案します。
`lineCommentStart`	現在の言語コンテキストでの行コメントの開始を示す文字を返します。
`lineNumber()`	現在の行番号を返します。
`lowercaseAndDash(String)`	camelCase文字列を小文字に変換し、区切り記号としてnダッシュを挿入します。例： `lowercaseAndDash(MyExampleName)` は `my-example-name`を返します。
`pyClassName()`	現在のPythonクラス（テンプレートが展開されているクラス）の名前を返します。
`pyFunctionName()`	現在のPython関数の名前を返します。
`pyIterableVariable()`	反復可能変数のスコープ固有の補完を有効にします。
`regularExpression(String, Pattern, Replacement)`	`String` 内のすべての `Pattern` を見つけて、それを `Replacement`に置き換えます。パターンを正規表現として指定して、ストリング内で一致するものすべてを見つけることができます。
`showParameterInfo()`	関数またはメソッドにパラメータを追加するときにパラメータの詳細を返します。使用例
`snakeCase(String)`	文字列をsnake_caseに変換します。例： `snakeCase(fooBar)` は `foo_bar`を返します。
`spaceSeparated(String)`	文字列を小文字に変換し、区切り文字としてスペースを挿入します。例： `spaceSeparated(fooBar)` は `foo bar`を返します。
`spacesToUnderscores(sParameterWithSpaces)`	パラメータとして渡された文字列内のスペースをアンダースコアに置き換えます。例： `spacesToUnderscores(foo bar)` は `foo_bar`を返します。
`substringBefore(String,Delimiter)`	指定された区切り文字の後の拡張子を削除し、ファイル名のみを返します。これはテストファイル名に役立ちます（たとえば、`substringBefore($FileName$,".")` は component-test.jsに `component-test` を返します）。
`time(sSystemTime)`	現在のシステム時刻を指定の形式で返します。パラメータを指定しないと、現在の時刻がデフォルトのシステムフォーマットで返されます。別のフォーマットを使用するには、SimpleDateFormat仕様に従ってパラメータを指定してください。例：関数 `time("H:m z")` は `13:10 UTC`としてフォーマットされたタイムスタンプを返します。
`underscoresToCamelCase(String)`	パラメータとして渡された文字列内のアンダースコアをキャメルケース文字に置き換えます。例： `underscoresToCamelCase(foo_bar)` は `fooBar`を返します。
`underscoresToSpaces(sParameterWithUnderscores)`	パラメータとして渡された文字列内のアンダースコアをスペースに置き換えます。例： `underscoresToSpaces(foo_bar)` は `foo bar`を返します。
`user()`	現在のユーザーの名前を返します。