PyCharm 2024.3 ヘルプ

ライブテンプレート変数

ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値、または関数を使用して計算された値である場合があります。

テンプレート内で変数を宣言するには、次の形式を使用します: $VAR$

式では、ドル文字 $ を開閉せずに変数名を使用します(例: lowercaseAndDash(ComponentName))。

式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。

この式には、次の構成が含まれる場合があります。

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

  • ライブテンプレートで定義されている他の変数の名前

  • 可能な引数を持つ定義済み関数

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

  1. 設定ダイアログ(Ctrl+Alt+S)で、エディター | ライブテンプレートに移動します。

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

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

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

    • 変数名を変更します。

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

    • 式の評価が失敗した場合のデフォルト値を指定します。デフォルト値は二重引用符で囲む必要があります。

    • 式が正常に評価された場合にユーザーに入力を求めるときに変数をスキップするかどうかを指定します。

    Live template variables

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

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

  • $END$ は、コードスニペットが完了したときのキャレットの位置を示します。Tab を押して次の変数に移動することはできなくなります。

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

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

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

機能

説明

blockCommentEnd()

現在の言語のコンテキストでブロックコメントの終わりを示す文字を返します。

blockCommentStart()

現在の言語コンテキストでのブロックコメントの開始を示す文字を返します。

camelCase(<String>)

文字列をキャメルケースに変換します。

例: camelCase("my-text-file")camelCase("my text file")camelCase("my_text_file") はすべて myTextFile を返します。

capitalize(<String>)

文字列の最初の文字を大文字にします。

例: capitalize("name")Name を返します。または、capitalize(camelCase("my awesome class")) と組み合わせて MyAwesomeClass を取得することもできます。

capitalizeAndUnderscore(<String>)

文字列のすべての文字を大文字にし、パーツ間にアンダースコアを挿入します。

例: capitalizeAndUnderscore("FooBar")capitalizeAndUnderscore("foo bar")capitalizeAndUnderscore("foo-bar") はすべて FOO_BAR を返します。

clipboard()

システムクリップボードの内容を返します。

collectionElementName()

_list と複数のエンディングを削除します。

commentEnd()

現在の言語コンテキストでコメントの終わりを示す文字を返します。行コメントのある言語の場合、戻り値は空です。

commentStart()

現在の言語コンテキストでコメントの開始を示す文字を返します。行コメントのある言語の場合、戻り値は lineCommentStart() と同じように行コメントの始まりです。

complete()

変数の位置でコード補完を呼び出します。

completeSmart()

変数の位置でスマート型補完を呼び出します。

concat(<String>, ...)

パラメーターとして関数に渡されたすべての文字列の連結を返します。

例: concat(date()," ",user()) は、スペースで区切られた現在のシステム日付とユーザー名を返します。

date([format])

現在のシステム日付を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で日付を返します。別の形式を使用するには、SimpleDateFormat(英語) 仕様に従ってパラメーターを指定します。例: date("Y-MM-d, E, H:m") は、2020-02-27, Thu, 16:11 としてフォーマットされた日付を返します。

dbColumns()

テーブルまたはビューの列のリストを返します。dbColumns() は、コンテキストライブテンプレート(たとえば、ins)で使用されます。オブジェクトを右クリックして SQL スクリプトを選択すると、コンテキストライブテンプレートにアクセスできます。

dbObjectName()

テーブルまたはビューの名前を返します。dbObjectName() は、コンテキストライブテンプレート(たとえば、top)で使用されます。オブジェクトを右クリックして SQL スクリプトを選択すると、コンテキストライブテンプレートにアクセスできます。

decapitalize(<String>)

文字列の最初の文字を対応する小文字に置き換えます。

例: decapitalize("Name")name を返します。

defaultReturnValues

式が return 文で使用されている場合は、デフォルト値を返します。式がエラー・型である場合は、errorVariableName パラメーターを使用します。

djangoBlock

利用可能な Django ブロックの補完ポップアップを表示します。

djangoFilter

使用可能な Django フィルターの補完ポップアップを表示します。

djangoTemplateTags

利用可能な Django テンプレートタグの comFpletion ポップアップを表示します

djangoVariable

利用可能な Django 変数の補完ポップアップを表示します。

enum(<String>, ...)

テンプレートが展開されたときに補完が提案される文字列のリストを返します。

例: enum("Foo","Bar","Baz") は、指定された文字列の 1 つを選択できるリストを表示します。

escapeString(<String>)

結果を Java 文字列で使用できるように、特殊文字をエスケープします。

例: タブ文字を \t で置き換え、改行文字を \n で置き換え、バックスラッシュを \\ としてエスケープし、引用符を \" としてエスケープします。

expectedType()

テンプレートが展開される式の予想される型を返します(割り当ての右側、return の後、メソッドパラメーターなど)。

Java コンテキストでのみ使用できます。

fileName()

現在のファイルの名前とその拡張子を返します。

fileNameWithoutExtension()

現在のファイルの名前を拡張子なしで返します。

filePath()

現在のファイルへの絶対パスを返します。

fileRelativePath()

現在のプロジェクトに相対的な現在のファイルパスを返します。特定のファイルの相対パスを確認するには、ファイルを右クリックして参照をコピーを選択するか、Ctrl+Alt+Shift+C を押します。

firstWord(<String>)

パラメーターとして渡された文字列の最初の単語を返します。

例: firstWord("one two three")one を返します。

groovyScript(<String>, [arg, ...])

文字列として渡された Groovy スクリプトを実行します。

最初の引数は、スクリプトのテキストまたはスクリプトを含むファイルへのパスを含む文字列です。この関数は、他のオプションの引数を _1_2_3、...、_n 変数の値としてスクリプトに渡します。また、_editor 変数を使用して、スクリプト内から現在のエディターにアクセスできます。

次の例は、指定された文字列 (別の変数 $MyVar$ の値) を大文字に変換する groovyScript() 関数を示しています。

groovyScript("_1.toUpperCase()", MyVar)

次の例は、選択したテキストを単語に分割し、番号付きリストとして表示する groovyScript() 関数を示しています。

groovyScript("def result = ''; _1.split().eachWithIndex { item, index -> result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION)

最後の例では、テキストを選択して Ctrl+Alt+T ( 囲む ) を押して適用する必要があることを意味する SELECTION 定義済み変数を使用しています。

JsArrayVariable()

現在の JavaScript 配列の名前を返します。

jsClassName()

現在の JavaScript クラスの名前を返します。

jsComponentTypeOf()

現在の JavaScript コンポーネントの型を返します。

jsDefineParameter

モジュールの名前に基づいて、define(["module"], function (<parameter_in_question>>) {}) からパラメーターを返します。

jsMethodName()

現在の JavaScript メソッドの名前を返します。

jsQualifiedClassName()

現在の JavaScript クラスの完全な名前を返します。

jsSuggestDefaultVariableKind(Boolean)

Boolean パラメーターは、現在のコンテキストで定数が許可されるかどうかを決定します。パラメーターが指定されていない場合は、定数が許可されます。テンプレートが展開されると、TypeScript および ES6 の場合は varletconst オプション、それ以前のバージョンの JavaScript の場合は var オプションが 1 つだけのリストが表示されます。

jsSuggestImportedEntityName()

ファイル名に基づいて、タイプ `import * as $ITEM$ from "$MODULE$"` または `import $ITEM$ from "$MODULE$"` のインポートステートメントの名前を提案します。

jsSuggestIndexName()

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

jsSuggestVariableName()

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

lineCommentStart()

現在の言語コンテキストでの行コメントの開始を示す文字を返します。

lineNumber()

現在の行番号を返します。

lowercaseAndDash(<String>)

文字列を小文字に変換し、セパレータとして n ダッシュを挿入します。例: lowercaseAndDash("MyExampleName")lowercaseAndDash("my example name") はどちらも my-example-name を返します。

pyClassName()

現在の Python クラス(テンプレートが展開されているクラス)の名前を返します。

pyFunctionName()

現在の Python 関数の名前を返します。

pyIterableVariable()

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

Using pyIterableVariable() in live templates

regularExpression(<String>, <Pattern>, <Replacement>)

String 内のすべての Pattern を検索し、Replacement に置き換えます。パターンを正規表現として指定して、文字列内で一致するすべてのものを検索できます。

例: regularExpression(NAME, "a", "b") 式は、$NAME$ テンプレート変数内の文字「a」を文字「b」に置き換えます。パターン部分では正規表現文字クラスを使用できます。たとえば、regularExpression(NAME, "[a-z]", "b") は変数内の任意の文字を置き換えます。\d\w などのパターンを正規表現文字クラスとしてみなしたい場合は、パターンが "\\d" のように見えるようにスラッシュをエスケープする必要があります。

showParameterInfo()

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

使用例

Show parameter info

snakeCase(<String>)

文字列を snake_case に変換します。例: snakeCase("fooBar")snakeCase("foo bar") はどちらも foo_bar を返します。

spaceSeparated(<String>)

区切り文字としてスペースを含む指定された文字列を返します。例: spaceSeparated("fooBar")foo Bar を返し、spaceSeparated("Foo_BAR")Foo BAR を返します。

spacesToUnderscores(<String>)

パラメーターとして渡された文字列内のスペースをアンダースコアに置き換えます。例: spacesToUnderscores("foo bar BAZ")foo_bar_BAZ を返します。

substringBefore(<String>, <Delimeter>)

指定された区切り文字までの部分文字列を返します。これは、テストファイル名の拡張子を削除できます。例: component-test.js という名前のファイルで使用されている場合、substringBefore(fileName(),".")component-test を返します。

time([format])

現在のシステム時刻を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で時刻を返します。別の形式を使用するには、SimpleDateFormat(英語) 仕様に従ってパラメーターを指定します。例: time("H:m z") は、13:10 UTC としてフォーマットされた時刻を返します。

typeOfVariable(<String>)

パラメーターとして渡された変数の型を返します。

Java コンテキストでのみ使用できます。

underscoresToCamelCase(<String>)

下線付きの文字列(snake_case など)を camelCase に変換します。例: underscoresToCamelCase(foo_bar_baz)underscoresToCamelCase(FOO_BaR_baZ) はどちらも fooBarBaz を返します。

underscoresToSpaces(<String>)

文字列のアンダースコアをスペースに変換します。例: underscoresToSpaces(foo_bar_baz)foo bar baz を返し、underscoresToSpaces(FOO_BaR_baZ)FOO BaR baZ を返します。

user()

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

サンプル

変数と関数を使用して簡単なライブテンプレートを作成しましょう。定義済みのクラス変数とメソッドを使用して Python クラスを作成します。テンプレートには、次の 3 つの変数が含まれます。

  • $ClassName$ : 新しいクラスの名前

  • $Food$ : 3 つの可能な値のリスト: 「肉」「草」「蜂蜜」

  • $AnimalName$ : 文中で使用できるように小文字で始まるクラス名

変数を使用してテンプレートを作成する

  1. Ctrl+Alt+S を押して設定を開き、エディター | ライブテンプレートを選択します。

  2. Python グループを選択し、the Add button をクリックして、ライブテンプレートを選択します。

  3. 略語フィールドで、テンプレートの展開に使用される文字を指定します。例: animal

  4. テンプレートテキストフィールドに、次のテンプレートを貼り付けます。

    class $ClassName$(Animal): food = "$Food$" def animal_food(self): print(f"The $AnimalName$ eats {self.food}.")
    Create a live template
  5. 適用可能なコンテキストがありません警告が表示された場合は、定義をクリックして、このライブテンプレートを使用可能にするコンテキストを選択します。例: Python :

    Select the context for the live template
  6. 変数の編集をクリックし、テンプレート変数の編集ダイアログで変数を構成します。

    • $ClassName$ は変更されていないため、ユーザーがこのテンプレートを適用するときに値を入力する必要があります。

    • $Food$ : フィールドに、enum("meat","grass","honey") と入力します。この関数を使用すると、ユーザーがこのテンプレートを適用するときに、事前定義された値の 1 つを選択できます。

    • $AnimalName$ : フィールドに、decapitalize(ClassName) と入力します。この関数は、ClassName 変数の値を受け取り、その最初の文字を小文字に変換します。ユーザーに入力を求める必要がないため、定義済みはスキップを選択します。

    Live template context

ライブテンプレートを使用する

  1. ライブテンプレートの名前の入力を開始します(この例では animal)。

  2. 変数の値(この例ではクラス名)を入力し、Tab を押して次の変数に移動します。

  3. キーボードの矢印を使用して、food 文字列の値の 1 つを選択します。

関連ページ:

テンプレート変数の編集ダイアログ

ライブテンプレートにユーザー定義変数が含まれている場合は、テンプレート変数の編集ダイアログを使用して、これらの変数を定義する式を構成できます。コントロール:名前このフィールドで、の形式で変数名を表示または編集します。式このフィールドでは、対応するテンプレート入力フィールドの値が自動的に計算されるように式を指定します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定義されている他の変数の名前、可能な引数を持つ定義済み関数、式を手動で入力するか、

コード補完

このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完:基本コード補完は、可視性スコープ内のクラス、メソッド、キーワードの名前を補完するのに役立ちます。コード補完を呼び出すと、PyCharm はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本コード補完がフィールド、パラメーター、変数宣言の一部に適用されている場合、PyCharm...

ライブテンプレートを作成する

次の手順例は、現在の日付とユーザー名でコメントのテンプレートを作成する方法を示しています。を押して設定を開き、を選択します。新しいライブテンプレートを作成するテンプレートグループ(たとえば、other)を選択します。テンプレートグループを選択しない場合、ライブテンプレートがユーザーグループに追加されます。をクリックし、ライブテンプレートを選択します。テンプレートが使用可能なコンテキストを指定します。デフォルトではコンテキストは指定されておらず、PyCharm はダイアログの下部にメッセージを表示...

ライブテンプレートを共有する

PyCharm はカスタムライブテンプレートグループの定義と事前定義済みテンプレートグループに追加されたテンプレートを自動的に生成された XML 設定ファイルに保存します。カスタムグループの場合、ファイルには、グループに含まれるすべてのテンプレートの定義が含まれます。変更済みの定義済みグループの場合、ファイルには追加(または変更)されたライブテンプレートの定義のみが含まれます。ライブテンプレートグループ設定ファイルは、IDE 構成ディレクトリの templates ディレクトリに格納されています。t...