PyCharm 2024.3 ヘルプ

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

ライブテンプレートユーザー定義変数が含まれている場合は、テンプレート変数の編集ダイアログを使用して、これらの変数を定義する式を構成できます。

コントロール

項目

説明

名前

このフィールドで、$<variable_name>$ の形式で変数名を表示または編集します。

このフィールドでは、対応するテンプレート入力フィールドの値が自動的に計算されるように式を指定します。

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

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

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

  • 可能な議論

式を手動で入力するか、リストから定義済みの関数を選択してください。リストには、選択した機能のパラメーターの数と種類(ある場合)も表示されます。使用可能な機能は、関数表にアルファベット順にリストされています。

デフォルト値

計算後に式で結果が得られない場合は、このフィールドに、展開されたテンプレートの対応する入力フィールドに入力するデフォルトの文字列を指定します。

変数のデフォルト値は、他のライブテンプレート変数を参照できる式であることに注意してください。デフォルト値をリテラルとして定義するには、引用符で囲みます。

定義済みはスキップ

現在の入力フィールドの値が定義されている場合、PyCharm に次の入力フィールドを進めるには、このチェックボックスを選択します。

上へ移動 / 下へ移動

これらのボタンを使用して、リスト内の変数の順序を変更します。テーブル内の変数の順序は、テンプレートが展開されたときに PyCharm が対応する入力フィールドを切り替える順序を決定します。

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

項目

説明

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()

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

関連ページ:

ライブテンプレート

ライブテンプレートを使用して、ループ、条件、宣言、print ステートメントなどの一般的な構造をコードに挿入します。コードスニペットを展開するには、対応するテンプレートの省略形を入力してを押します。を押し続けると、テンプレート内の 1 つの変数から次の変数に移動します。を押して、前の変数に移動します。次の例は、カスタムライブテンプレートの使用方法を示しています。ライブテンプレートの種類:次のタイプのライブテンプレートが区別されます。シンプルなテンプレートには固定プレーンテキストのみが含ま

ライブテンプレート変数

ライブテンプレートの省略形を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値、または関数を使用して計算された値である場合があります。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します(例:)。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定...

コード補完

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