PyCharm 2019.1ヘルプ

ライブテンプレート変数

ライブテンプレートの省略形が展開されると、変数は既定値(既定値または関数を使用して計算された値)に置き換えられ、ユーザーが変更できる入力フィールドとして表示されます。

テンプレート内の変数は、次の形式で宣言されます。

$<variable_name>$

各変数は式で定義され、式が評価されない場合のデフォルト値を受け入れることができます。

この式には、次の基本型の構成が含まれます。

  • 二重引用符で囲まれた文字列定数。

  • ライブテンプレートで定義された別の変数の名前。

  • 可能な引数を持つ事前定義された関数。

テンプレート変数は、テンプレート変数の編集ダイアログで設定することができます。

テンプレート変数を設定する

  1. Ctrl+Alt+S を押して設定/環境設定ダイアログを開き、エディター | ライブ・テンプレートに進みます。

  2. 変数を設定するテンプレートを選択します。

  3. テンプレートテキストに変数を指定し、変数の編集をクリックします。

  4. テンプレート変数の編集ダイアログでは、各変数に対して以下の操作を実行できます。

    • 変数名を変更します。

    • 定義済みの関数を使用して式を定義します

    • 式が評価されない場合のデフォルト値を指定します。

    • 変数を式を使用して定義した場合、ユーザーに入力を促すときに変数をスキップするかどうかを指定します。

定義済みのテンプレート変数

PyCharmは、変更できない以下の定義済みライブテンプレート変数をサポートしています。

  • $END$ はコードスニペットが完了したときのカーソルの位置を示し、Tab を押して次の変数にジャンプすることはできません。

  • $SELECTION$ はサラウンドテンプレートで使用され、ラップされるコードフラグメントを示します。テンプレートが展開された後、選択されたテキストはテンプレートで指定されたとおりにラップされます。例:コード内で EXAMPLE を選択し、割り当てられた省略形を使用して "$SELECTION$" テンプレートを呼び出した場合、または Ctrl+Alt+T を押してリストから目的のテンプレートを選択した場合、PyCharmは二重引用符で囲んだ "EXAMPLE"を選択します。

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

ライブテンプレート変数を定義するには、次の関数を使用できます。

関数

説明

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)

現在のシステム日付を指定された形式で返します。

パラメータを指定しないと、現在の日付がデフォルトのシステム形式で返されます。

date_format

別のフォーマットを使用するには、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()

最も一般的に使用されるもの( ijk、および息子)の中から推奨されるインデックス変数の名前を返します。現在のスコープでまだ使用されていない名前が最初に表示されます。

jsSuggestVariableName()

変数の命名規則を参照するコードスタイル設定に従って、その変数の型と初期化子の式に基づいて、変数の推奨名を返します。
例:反復内の要素を保持する変数である場合、PyCharmは反復されるコンテナーの名前を考慮して最も合理的な名前を推測します。

jsSuggestDefaultVariableKind(Boolean)

Booleanパラメータは、現在のコンテキストで定数が許可されるかどうかを決定します。パラメータが指定されていない場合は、定数が許可されます。テンプレートが展開されると、TypeScriptおよびES6の場合は varletconst オプション、それ以前のバージョンの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()

反復可能変数のスコープ固有の補完を有効にします。

Using pyIterableVariable() in live templates
showParameterInfo()

関数またはメソッドにパラメータを追加するときにパラメータの詳細を返します: 使用例

Show parameter info
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.jscomponent-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()

現在のユーザーの名前を返します。

最終更新日: 2019年7月17日