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

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

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

最終更新日: 2019年8月21日

プロシージャー:

ライブ・テンプレート

リファレンス:

ライブ・テンプレート

PyCharm 2019.2ヘルプ

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

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

前提条件