16.1. Python プラグインを構成する

プラグインを作成するには、以下の手順に従います。

  1. アイデア :新しいQGISプラグインで何をしたいか考えます。なぜそれを行うのですか? あなたが解決したいのはどのような問題ですか? その問題に対してすでに他のプラグインはないですか?

  2. ファイルの作成 : ファイルのうちいくつかは必須です( プラグインファイル を参照してください)。

  3. コードを書く : それぞれのファイルに適切なコードを書きます。

  4. テスト :すべてがうまく行くかどうかを プラグインをリロード して確認します。

  5. 公開:出来上がったプラグインをQGISリポジトリに公開するか、ご自身のリポジトリを作って個人的な「GISウェポン」の兵器廠にしましょう。

16.1.1. プラグインを書く

QGISにPythonプラグインが導入されて以来、数多くのプラグインが登場しました。 QGISチームは Official Python plugin repository を保守しています。それらのソースを使用して、PyQGISを使ったプログラミングについてもっと学んだり、開発努力が重複していないか調べたりできます。

16.1.1.1. プラグインファイル

ここで例として見ていくプラグインのディレクトリ構造はこのようになります。

PYTHON_PLUGINS_PATH/
  MyPlugin/
    __init__.py    --> *required*
    mainPlugin.py  --> *core code*
    metadata.txt   --> *required*
    resources.qrc  --> *likely useful*
    resources.py   --> *compiled version, likely useful*
    form.ui        --> *likely useful*
    form.py        --> *compiled version, likely useful*

各ファイルの意味は以下の通りです。

  • __init__.py = プラグインの起点です。classFactory() メソッドが必須ですが、それ以外にもどんな初期化コードでも含むことができます。

  • mainPlugin.py = プラグインの中心として作動するコードです。プラグインの全ての機能に関する情報と主要コードを含みます。

  • resources.qrc = Qt Designerによって作られる .xmlドキュメントです。外観のリソースへの相対パスを含みます。

  • resources.py = 上記の .qrc ファイルをPythonへと変換したものです。

  • form.ui = Qt Designerによって作られたGUIです。

  • form.py = 上記の form.ui をPythonに変換したものです。

  • metadata.txt = プラグインのウェブサイトとインフラストラクチャで使われる、一般的な情報、バージョン、名前、その他のメタデータを含みます。

`こちら `_ に典型的なQGIS Pythonプラグインの基本的なファイル(スケルトン)を作る方法があります。

`Plugin Builder 3 `_ という名前の、QGISのプラグインテンプレートを作るQGISプラグインもあります。3.x 互換のソースを作れますので、こちらが推奨される選択肢となります。

警告

プラグインを Official Python plugin repository にアップロードする予定なら、プラグインの Validation で必要とされる幾つかの付加的なルールに、そのプラグインが従っていることを確認せねばなりません。

16.1.2. プラグインの内容

ここでは、上記のファイル構造中のそれぞれのファイルに何を書けばよいか、その情報と実例を提供します。

16.1.2.1. プラグインメタデータ

最初に、そのプラグインの名前や説明といった基本的な情報を、プラグインマネージャは検索する必要があります。metadata.txt ファイルがその情報を格納しておく場所になります。

注釈

メタデータのエンコーディングはすべてUTF-8でなければなりません。

メタデータ名

必須

name

Y

そのプラグインの名前から成る短い文字列

qgisMinimumVersion

Y

ドット記法による最小QGISバージョン

qgisMaximumVersion

N

ドット記法による最大QGISバージョン

description

Y

プラグインを説明する短いテキスト。HTMLは不可

about

Y

プラグインの詳細を説明するより長いテキスト。HTMLは不可

version

Y

バージョンをドット記法で記した短い文字列

author

Y

著者の名前

email

Y

著者のEメール。ウェブサイトでログインしたユーザのみに表示されるが、プラグインをインストールした後はプラグインマネジャで見ることができる

changelog

N

文字列。改行して複数行になってもよい。HTML不可

experimental

N

boolean flag, True or False - True if this version is experimental

deprecated

N

TrueFalse のいずれかの値。単にアップロードしたバージョンに対してではなく、そのプラグインすべてに適用される

tags

N

コンマで区切ったリスト。個々のタグの内部ではスペース可

homepage

N

プラグインのホームページを示す有効なURL

repository

Y

ソースコードのリポジトリの有効なURL

tracker

N

チケットとバグ報告のための有効なURL

icon

N

画像のファイル名もしくは(プラグインの圧縮パッケージのベースフォルダからの)相対パス。画像はウェブに適したフォーマット(PNG, JPEG)で

category

N

RasterVectorDatabaseWeb のうちのいずれか

plugin_dependencies

N

pipと同様の、インストールされるべきその他のプラグインのカンマ区切りリスト

server

N

boolean flag, True or False, determines if the plugin has a server interface

hasProcessingProvider

N

TrueFalse のいずれかの値。このプラグインがプロセッシングアルゴリズムを提供するかどうかを特定する。

デフォルトでプラグインは プラグイン メニューに置かれます(プラグインをメニューエントリに追加する方法は次のセクションで見ます)。他にも ラスター メニューや ベクター メニュー、 データベース メニュー、 Web メニューに置くこともできます。

表示するメニューを特定するために、対応する "category" メタデータエントリが存在します。これに従ってプラグインは分類することができます。このメタデータエントリは、ユーザへのヒントとして使われ、このプラグインを使うためにはどのメニューを探せばよいかを伝えます。"category" に使うことのできる値は、Vector、Raster、Database、Web です。例えば、あなたのプラグインを Raster メニューから使えるようにするには、 metadata.txt にそのように追加します。

category=Raster

注釈

qgisMaximumVersion が空欄の場合、Official Python plugin repository にアップロードする際に、自動的にメジャーバージョン+ .99 に設定されます。

metadata.txt のための例です。

; the next section is mandatory

[general]
name=HelloWorld
email=me@example.com
author=Just Me
qgisMinimumVersion=3.0
description=This is an example plugin for greeting the world.
    Multiline is allowed:
    lines starting with spaces belong to the same
    field, in this case to the "description" field.
    HTML formatting is not allowed.
about=This paragraph can contain a detailed description
    of the plugin. Multiline is allowed, HTML is not.
version=version 1.2
tracker=http://bugs.itopen.it
repository=http://www.itopen.it/repo
; end of mandatory metadata

; start of optional metadata
category=Raster
changelog=The changelog lists the plugin versions
    and their changes as in the example below:
    1.0 - First stable release
    0.9 - All features implemented
    0.8 - First testing release

; Tags are in comma separated value format, spaces are allowed within the
; tag name.
; Tags should be in English language. Please also check for existing tags and
; synonyms before creating a new one.
tags=wkt,raster,hello world

; these metadata can be empty, they will eventually become mandatory.
homepage=https://www.itopen.it
icon=icon.png

; experimental flag (applies to the single version)
experimental=True

; deprecated flag (applies to the whole plugin and not only to the uploaded version)
deprecated=False

; if empty, it will be automatically set to major version + .99
qgisMaximumVersion=3.99

; Since QGIS 3.8, a comma separated list of plugins to be installed
; (or upgraded) can be specified.
; The example below will try to install (or upgrade) "MyOtherPlugin" version 1.12
; and any version of "YetAnotherPlugin"
plugin_dependencies=MyOtherPlugin==1.12,YetAnotherPlugin

16.1.2.2. __init__.py

このファイルはPythonのインポートシステムで必要とされます。同時にQGISはこのファイルの classFactory() 関数を必要とします。この関数はプラグインがQGISに読み込まれる時に呼ばれます。この関数は QgisInterface ` のインスタンスへの参照を受け取り、 :file:`mainplugin.py ファイルのあなたのプラグインオブジェクトを返さなければなりません(ここでの事例では TestPlugin がそれに当たります。以下を見てください)。 __init__.py は次のようにならなければなりません。

def classFactory(iface):
  from .mainPlugin import TestPlugin
  return TestPlugin(iface)

# any other initialisation needed

16.1.2.3. mainPlugin.py

このファイルが魔法の起こる場所です。魔法はこんな風です(例えば mainPlugin.py の場合)。

from qgis.PyQt.QtGui import *
from qgis.PyQt.QtWidgets import *

# initialize Qt resources from file resources.py
from . import resources

class TestPlugin:

  def __init__(self, iface):
    # save reference to the QGIS interface
    self.iface = iface

  def initGui(self):
    # create action that will start plugin configuration
    self.action = QAction(QIcon(":/plugins/testplug/icon.png"),
                          "Test plugin",
                          self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    self.action.triggered.connect(self.run)

    # add toolbar button and menu item
    self.iface.addToolBarIcon(self.action)
    self.iface.addPluginToMenu("&Test plugins", self.action)

    # connect to signal renderComplete which is emitted when canvas
    # rendering is done
    self.iface.mapCanvas().renderComplete.connect(self.renderTest)

  def unload(self):
    # remove the plugin menu item and icon
    self.iface.removePluginMenu("&Test plugins", self.action)
    self.iface.removeToolBarIcon(self.action)

    # disconnect form signal of the canvas
    self.iface.mapCanvas().renderComplete.disconnect(self.renderTest)

  def run(self):
    # create and show a configuration dialog or something similar
    print("TestPlugin: run called!")

  def renderTest(self, painter):
    # use painter for drawing to map canvas
    print("TestPlugin: renderTest called!")

メインプラグインソースファイル(例えば mainPlugin.py )に必須のプラグイン関数は以下の3つだけです。

  • __init__ はQGIS interfaceへのアクセスを与えます。

  • initGui() はプラグインが読み込まれた時に呼ばれます。

  • unload() はプラグインがアンロードされた時に呼ばれます。

上記の例では、 addPluginToMenu ` が使われています。これは対応するメニューアクションを :menuselection:`プラグイン() メニューに追加します。他のメニューにアクションを追加するにはまた別のメソッドがあります。以下はそれらのメソッドのリストです。

これらはすべて :meth:`addPluginToMenu ` メソッドと同じシンタックスを持ちます。

これらのあらかじめ定義されたメソッドのうちのひとつに、あなたのプラグインメニューを追加することは、プラグインエントリがどのように組織されているかの一貫性を保つためにも推奨されます。しかし、次の例が示すように、独自のカスタムメニューグループを直接メニューバーに追加することもできます。

def initGui(self):
    self.menu = QMenu(self.iface.mainWindow())
    self.menu.setObjectName("testMenu")
    self.menu.setTitle("MyMenu")

    self.action = QAction(QIcon(":/plugins/testplug/icon.png"),
                          "Test plugin",
                          self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    self.action.triggered.connect(self.run)
    self.menu.addAction(self.action)

    menuBar = self.iface.mainWindow().menuBar()
    menuBar.insertMenu(self.iface.firstRightStandardMenu().menuAction(),
                       self.menu)

def unload(self):
    self.menu.deleteLater()

カスタマイズが可能になるように、QAction クラスと QMenu クラスの objectName にあなたのプラグインの固有名を設定するのを忘れないでください。

16.1.2.4. Resource ファイル

initGui() 関数の中にresourceファイル(この例では resources.qrc という名前です)からのアイコンが使われているのも見ることができます。

<RCC>
  <qresource prefix="/plugins/testplug" >
     <file>icon.png</file>
  </qresource>
</RCC>

他のプラグインや他のQGISのパーツと衝突しないよう接頭辞を使うのは良いことです。さもないと望んでいないリソースを読み込んでしまうかもしれません。さてあと必要なのはこのリソースを含むPythonファイルを生成することです。これは pyrcc5 コマンドを使って次のようにして行われます。

pyrcc5 -o resources.py resources.qrc

注釈

In Windows environments, attempting to run the pyrcc5 from Command Prompt or Powershell will probably result in the error "Windows cannot access the specified device, path, or file [...]". The easiest solution is probably to use the OSGeo4W Shell but if you are comfortable modifying the PATH environment variable or specifiying the path to the executable explicitly you should be able to find it at <Your QGIS Install Directory>\bin\pyrcc5.exe.

はい、これですべてです。…何も複雑なことはありませんね (^^)

すべてを正しく行っていれば、プラグインマネージャであなたのプラグインを見つけて読み込むことができるはずです。そしてツールバーのアイコンか適切なメニュー項目が選択された時には、コンソールにメッセージが表示されるはずです。

実際にプラグイン作成の作業を行うときは、別の(作業用の)ディレクトリでプラグインを書いて、UIとリソースファイルを生成するのと、プラグインを実際のインストールディレクトリにインストールするのは、makeファイルを書いてそれにさせるのが賢いやり方でしょう。

16.1.3. Documentation

The documentation for the plugin can be written as HTML help files. The qgis.utils module provides a function, showPluginHelp() which will open the help file browser, in the same way as other QGIS help.

The showPluginHelp() function looks for help files in the same directory as the calling module. It will look for, in turn, index-ll_cc.html, index-ll.html, index-en.html, index-en_us.html and index.html, displaying whichever it finds first. Here ll_cc is the QGIS locale. This allows multiple translations of the documentation to be included with the plugin.

The showPluginHelp() function can also take parameters packageName, which identifies a specific plugin for which the help will be displayed, filename, which can replace "index" in the names of files being searched, and section, which is the name of an html anchor tag in the document on which the browser will be positioned.

16.1.4. Translation

With a few steps you can set up the environment for the plugin localization so that depending on the locale settings of your computer the plugin will be loaded in different languages.

16.1.4.1. Software requirements

The easiest way to create and manage all the translation files is to install Qt Linguist. In a Debian-based GNU/Linux environment you can install it typing:

sudo apt install qttools5-dev-tools

16.1.4.2. Files and directory

When you create the plugin you will find the i18n folder within the main plugin directory.

All the translation files have to be within this directory.

16.1.4.2.1. .pro file

First you should create a .pro file, that is a project file that can be managed by Qt Linguist.

In this .pro file you have to specify all the files and forms you want to translate. This file is used to set up the localization files and variables. A possible project file, matching the structure of our example plugin:

FORMS = ../form.ui
SOURCES = ../your_plugin.py
TRANSLATIONS = your_plugin_it.ts

Your plugin might follow a more complex structure, and it might be distributed across several files. If this is the case, keep in mind that pylupdate5, the program we use to read the .pro file and update the translatable string, does not expand wild card characters, so you need to place every file explicitly in the .pro file. Your project file might then look like something like this:

FORMS = ../ui/about.ui ../ui/feedback.ui \
        ../ui/main_dialog.ui
SOURCES = ../your_plugin.py ../computation.py \
          ../utils.py

Furthermore, the your_plugin.py file is the file that calls all the menu and sub-menus of your plugin in the QGIS toolbar and you want to translate them all.

Finally with the TRANSLATIONS variable you can specify the translation languages you want.

警告

Be sure to name the ts file like your_plugin_ + language + .ts otherwise the language loading will fail! Use the 2 letter shortcut for the language (it for Italian, de for German, etc...)

16.1.4.2.2. .ts file

Once you have created the .pro you are ready to generate the .ts file(s) for the language(s) of your plugin.

Open a terminal, go to your_plugin/i18n directory and type:

pylupdate5 your_plugin.pro

you should see the your_plugin_language.ts file(s).

Open the .ts file with Qt Linguist and start to translate.

16.1.4.2.3. .qm file

When you finish to translate your plugin (if some strings are not completed the source language for those strings will be used) you have to create the .qm file (the compiled .ts file that will be used by QGIS).

Just open a terminal cd in your_plugin/i18n directory and type:

lrelease your_plugin.ts

now, in the i18n directory you will see the your_plugin.qm file(s).

16.1.4.3. Translate using Makefile

Alternatively you can use the makefile to extract messages from python code and Qt dialogs, if you created your plugin with Plugin Builder. At the beginning of the Makefile there is a LOCALES variable:

LOCALES = en

Add the abbreviation of the language to this variable, for example for Hungarian language:

LOCALES = en hu

Now you can generate or update the hu.ts file (and the en.ts too) from the sources by:

make transup

After this, you have updated .ts file for all languages set in the LOCALES variable. Use Qt Linguist to translate the program messages. Finishing the translation the .qm files can be created by the transcompile:

make transcompile

You have to distribute .ts files with your plugin.

16.1.4.4. Load the plugin

In order to see the translation of your plugin, open QGIS, change the language (Settings ‣ Options ‣ General) and restart QGIS.

You should see your plugin in the correct language.

警告

If you change something in your plugin (new UIs, new menu, etc..) you have to generate again the update version of both .ts and .qm file, so run again the command of above.

16.1.5. Tips and Tricks

16.1.5.1. Plugin Reloader

During development of your plugin you will frequently need to reload it in QGIS for testing. This is very easy using the Plugin Reloader plugin. You can find it with the Plugin Manager.

16.1.5.2. Accessing Plugins

You can access all the classes of installed plugins from within QGIS using python, which can be handy for debugging purposes.

my_plugin = qgis.utils.plugins['My Plugin']

16.1.5.3. Log Messages

Plugins have their own tab within the ログメッセージパネル.

16.1.5.4. Share your plugin

QGIS is hosting hundreds of plugins in the plugin repository. Consider sharing yours! It will extend the possibilities of QGIS and people will be able to learn from your code. All hosted plugins can be found and installed from within QGIS with the Plugin Manager.

Information and requirements are here: plugins.qgis.org.