PyCharm 2018.3ヘルプ

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

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

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

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

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

前提条件

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

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

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

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

  • 設定/環境設定ダイアログ(メインツールバーのicons general settings svg 、または Ctrl+Alt+S)を開き、エディターノードを展開して、ライブ・テンプレートをクリックします。

    py live template settings

  • icons general add svgをクリックします。まず、テンプレート・グループ...を選択し、その名前を指定します(この場合、 userです)。作成されたグループがフォーカスを取得します。

  • もう一度 icons general add svg をクリックします。今回は、ライブ・テンプレートを選択します。新しいテンプレートは、フォーカスを保持するグループ、つまり userに表示されます。

次は何が起こる?

  • 最初に、グループ userに、今は <abbreviation>と呼ばれるスタブライブテンプレートがあります。

  • 次に、テンプレートの省略形、説明、本文、およびコンテキストを入力するフィールドが表示されます。

py live template settings1

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

So, let's enter the template abbreviation. In our example, we'll type the word class in the field 略語 , and then enter description (which is optional, but nevertheless...).

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

py live template settings2

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

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

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

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

The portions of a template text enclosed in $ signs are the template variables. You can easily tell them from the entire template text, since they stand out with color:

py live template settings4

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

テンプレート変数の編集

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

py live template settings3

ダイアログボックステンプレート変数の編集に、すべての変数(ただし1つ!)のリストが表示されます。

py live template settings5

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

py live template settings6

$ END $についてのメモ

You have already noticed that the template variable $END$ was not suggested for editing. This is because the template variable $END$ is predefined, and thus NOT EDITABLE. It always stands for the position of the cursor after the template expansion and filling in all the required fields. So in our case, the cursor will rest at the end of the new class declaration.

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

設定/環境設定ダイアログ(Ctrl+Alt+S)でOKをクリックするだけです。スタブのPythonクラスに展開される新しいライブテンプレート(またはコードスニペット)が用意されています。テストに入れましょう...

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

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

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

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

py live template result

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

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

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

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

py live template result1

異なるIDE間でテンプレートを共有する例

Once created the user template in PyCharm you can reuse it for working with Python scripts in another IDE, for example, IntelliJ IDEA . All you need is to export PyCharm Live Template configuration and import it in IntelliJ IDEA.

Importing a live template in IntelliJ IDEA

最終更新日: 2018年12月14日

関連事項