ライブ・テンプレート

このページ：

メイン設定
ライブテンプレートのコンテキストメニュー
テンプレート編集領域
ライブテンプレート変数で使用される事前定義済み関数

メイン設定

項目	説明
デフォルトで展開		すべてのテンプレートのデフォルトの呼び出しキーを指定します。特定のテンプレート用の個々の拡張キーは編集領域で定義されています。標準の拡張キー（`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(sCamelCaseName)`	パラメータとして渡された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()`	現在のファイルの名前を拡張子なしで返します。
`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-dashを挿入します。例： `lowercaseAndDash(MyExampleName)` は `my-example-name`を返します。
`regularExpression(String, Pattern, Replacement)`	指定されたパターンに従って文字列を置換します。
`pyClassName()`	現在のPythonクラス（テンプレートが展開されているクラス）の名前を返します。
`pyFunctionName()`	現在のPython関数の名前を返します。
`pyIterableVariable()`	反復可能変数のスコープ固有の補完を有効にします。
`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)`	パラメータとして渡された文字列の下線をcamelCase文字に置き換えます。例： `underscoresToCamelCase(foo_bar)` は `fooBar`を返します。
`underscoresToSpaces(sParameterWithUnderscores)`	アンダースコアをパラメータとして渡された文字列のスペースで置き換えます。例： `underscoresToSpaces(foo_bar)` は `foo bar`を返します。
`user()`	現在のユーザーの名前を返します。