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

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

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

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

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

前提条件

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

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

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

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

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

次は何が起こる？

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

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

それでは、テンプレートの略語を入力しましょう。この例では、フィールド略語に単語 class を入力してからdescriptionを入力します（これはオプションですが、それにもかかわらず...）。

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

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

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

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

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

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

$ 記号で囲まれたテンプレートテキストの部分はテンプレート変数です。色が際立っているので、テンプレートテキスト全体から簡単にわかります。

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

テンプレート変数の編集

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

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

変数 $object$ については、デフォルト値（object）を定義し、OKをクリックします。

$ END $についてのメモ

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