ライブテンプレートの作成と適用 (コードスニペット)

このチュートリアルの内容は何ですか？

PyCharm には、たくさんのライブテンプレートが付属しています。Python には事前に定義されたライブテンプレートがいくつかあり、このチュートリアルでは、Python クラス宣言用のライブテンプレートを作成し、このライブテンプレートを使用する手順を説明します。

Python プログラミングはこのチュートリアルの範囲外です。詳細については、Python のドキュメントを参照してください。

ライブテンプレートの基本と使用方法もここでは説明しません。ライブテンプレートの型、略語、変数、ストレージに関する必要な情報は、ライブテンプレートセクションにすべて記載されています。

前提条件

PyCharm バージョン 2.7 以降を使用していることを確認してください。それでも PyCharm をお持ちでない場合は、このページからダウンロードしてください。PyCharm をインストールするには、プラットフォームに応じて、指示に従ってください。

このチュートリアルは、PyCharm Professional バージョン 2016.1 を使用して作成されています。

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

1. スタブライブテンプレートを作成する

設定ダイアログ（メインツールバーの、または Ctrl+Alt+S）を開き、エディターノードを展開して、ライブテンプレートをクリックします。
:
をクリックします。まず、テンプレートグループ ... を選択し、その名前を指定します（この場合、user です）。作成されたグループがフォーカスを取得します。
もう一度をクリックします。今回は、ライブテンプレートを選択します。新しいテンプレートは、フォーカスを保持するグループ、つまり user に表示されます。

次のようになります。

グループ user に、<abbreviation> と呼ばれているスタブライブテンプレートがあります。
次に、テンプレートの省略形、説明、本文、コンテキストを入力するフィールドが表示されます。

2. テンプレートの略語とコンテキストの定義

それでは、テンプレートの省略形を入力してみましょう。この例では、フィールド略語に class と入力し、説明を入力します（オプションですが、それでも ...）。

次に、新しいテンプレートが適用されるコンテキストを選択しましょう。ここまでで、コンテキストが定義されていないことがわかります。リンク定義をクリックし、コンテキストを選択してください（この場合は Python です）。将来、コンテキストがすでに定義されている場合、リンクは変更に変わります。

拡張キーは、デフォルトで指定されている Tab になります。

3. テンプレートテキストの定義

項目テンプレートテキストに次のコードを入力します。

class $class$($object$):
    """$cls_doc$"""

    def __init__(self,$args$):
        """Constructor for $class$"""
$END$
            

$ 記号で囲まれたテンプレートテキストの部分は、テンプレート変数です。テンプレートテキストは色で目立つため、テンプレートテキスト全体から簡単に見分けることができます。

これらのテンプレート変数はまだ無効のため、最初に定義しましょう ... 1 つを除いて（理由については少しお待ち下さい）。

4. テンプレート変数の編集

ボタン変数の編集をクリックします:

ダイアログテンプレート変数の編集に、すべての（ただし 1 つの）変数の一覧が表示されます。

変数 $object$ に対して、そのデフォルト値 object を定義し、OK をクリックしましょう。

$END$ についてのメモ

テンプレート変数 $END$ は編集が提案されていないことにすでに気づいています。これは、テンプレート変数 $END$ が事前定義されているため、編集できないためです。これは常に、テンプレートを展開し、すべての必須フィールドに入力した後のキャレットの位置を表します。この場合、キャレットは新しいクラス宣言の最後に置かれます。

5. 新しいライブテンプレートを記憶する

設定ダイアログ (Ctrl+Alt+S) で OK をクリックするだけです。スタブ Python クラスに展開される新しいライブテンプレート (またはコードスニペット) が準備できました。ちょっとテストしてみましょう ...

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

まず、Python ファイル（Alt+Insert -Python ファイル）を作成し、それを sample.py と呼びます。

新しい Python ファイルが編集用に開きます。次に、そこにクラス宣言を作成しましょう。これを行うには、テンプレート略称 class を入力します。

私たちの新しいライブテンプレートは今や候補リストに入っています。

このオプションを選択するには、Tab を押します。

予想どおり、省略形はスタブ Python クラスに展開されます。赤い線は次のエントリポイントを示します。クラス名（変数 class）を入力すると、その特定の場所に入力されます。

ちなみに、変数 class は、クラスコンストラクターのコメントで、クラス宣言で複数回使用されています。この場合、class のフィールドは自動的に入力されています。

クラス名をタイプしたら、Enter を押して、赤線（フレーム）が次のフィールドに移動することを確認します。必要なフィールドをすべて入力し、最後に Enter を押す必要があります。

PyCharm で user テンプレートを作成したら、それを再利用して、IntelliJ IDEA などの別の IDE で Python スクリプトを操作できます。必要なのは、PyCharm ライブテンプレート構成をエクスポートして、IntelliJ IDEA にインポートすることだけです。

Importing a live template in IntelliJ IDEA

最終更新日: 2024 年 5 月 26 日

関連ページ：

ライブテンプレート

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

ライブテンプレート変数

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

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

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

Emmet

Emmet ツールキットは、HTML、CSS、JSX によるコーディングを強化します。PyCharm を移動せずに Emmet コードテンプレートを使用できます。テンプレートを正しいマークアップに展開するには、その略語を入力してを押します。を別のキーに置き換えるには、「略語拡張キーを構成する」を参照してください。例: HTML ファイルでと入力し、を押して 3 × 2 テーブルのスタブを取得します。<table> <tr> <td></td>...